Network Security v1 API - Class SecurityProfileName (1.0.0-beta01) 

public sealed class SecurityProfileName : IResourceName, IEquatable<SecurityProfileName>

Reference documentation and code samples for the Network Security v1 API class SecurityProfileName.

Resource name for the SecurityProfile resource.

Inheritance

object > SecurityProfileName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

SecurityProfileName(string, string, string)

public SecurityProfileName(string organizationId, string locationId, string securityProfileId)

Constructs a new instance of a SecurityProfileName class from the component parts of pattern organizations/{organization}/locations/{location}/securityProfiles/{security_profile}

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
securityProfileId string

The SecurityProfile ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

SecurityProfileId

public string SecurityProfileId { get; }

The SecurityProfile ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public SecurityProfileName.ResourceNameType Type { get; }

The SecurityProfileName.ResourceNameType of the contained resource name.

Property Value
Type Description
SecurityProfileNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string organizationId, string locationId, string securityProfileId)

Formats the IDs into the string representation of this SecurityProfileName with pattern organizations/{organization}/locations/{location}/securityProfiles/{security_profile}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
securityProfileId string

The SecurityProfile ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SecurityProfileName with pattern organizations/{organization}/locations/{location}/securityProfiles/{security_profile}.

FormatOrganizationLocationSecurityProfile(string, string, string)

public static string FormatOrganizationLocationSecurityProfile(string organizationId, string locationId, string securityProfileId)

Formats the IDs into the string representation of this SecurityProfileName with pattern organizations/{organization}/locations/{location}/securityProfiles/{security_profile}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
securityProfileId string

The SecurityProfile ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SecurityProfileName with pattern organizations/{organization}/locations/{location}/securityProfiles/{security_profile}.

FormatProjectLocationSecurityProfile(string, string, string)

public static string FormatProjectLocationSecurityProfile(string projectId, string locationId, string securityProfileId)

Formats the IDs into the string representation of this SecurityProfileName with pattern projects/{project}/locations/{location}/securityProfiles/{security_profile}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
securityProfileId string

The SecurityProfile ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SecurityProfileName with pattern projects/{project}/locations/{location}/securityProfiles/{security_profile}.

FromOrganizationLocationSecurityProfile(string, string, string)

public static SecurityProfileName FromOrganizationLocationSecurityProfile(string organizationId, string locationId, string securityProfileId)

Creates a SecurityProfileName with the pattern organizations/{organization}/locations/{location}/securityProfiles/{security_profile}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
securityProfileId string

The SecurityProfile ID. Must not be null or empty.
Returns
Type Description
SecurityProfileName

A new instance of SecurityProfileName constructed from the provided ids.

FromProjectLocationSecurityProfile(string, string, string)

public static SecurityProfileName FromProjectLocationSecurityProfile(string projectId, string locationId, string securityProfileId)

Creates a SecurityProfileName with the pattern projects/{project}/locations/{location}/securityProfiles/{security_profile}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
securityProfileId string

The SecurityProfile ID. Must not be null or empty.
Returns
Type Description
SecurityProfileName

A new instance of SecurityProfileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SecurityProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecurityProfileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
SecurityProfileName

A new instance of SecurityProfileName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static SecurityProfileName Parse(string securityProfileName)

Parses the given resource name string into a new SecurityProfileName instance.

Parameter
Name Description
securityProfileName string

The resource name in string form. Must not be null.
Returns
Type Description
SecurityProfileName

The parsed SecurityProfileName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • organizations/{organization}/locations/{location}/securityProfiles/{security_profile}
  • projects/{project}/locations/{location}/securityProfiles/{security_profile}

Parse(string, bool)

public static SecurityProfileName Parse(string securityProfileName, bool allowUnparsed)

Parses the given resource name string into a new SecurityProfileName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
securityProfileName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
Returns
Type Description
SecurityProfileName

The parsed SecurityProfileName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • organizations/{organization}/locations/{location}/securityProfiles/{security_profile}
  • projects/{project}/locations/{location}/securityProfiles/{security_profile}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out SecurityProfileName)

public static bool TryParse(string securityProfileName, out SecurityProfileName result)

Tries to parse the given resource name string into a new SecurityProfileName instance.

Parameters
Name Description
securityProfileName string

The resource name in string form. Must not be null.
result SecurityProfileName

When this method returns, the parsed SecurityProfileName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • organizations/{organization}/locations/{location}/securityProfiles/{security_profile}
  • projects/{project}/locations/{location}/securityProfiles/{security_profile}

TryParse(string, bool, out SecurityProfileName)

public static bool TryParse(string securityProfileName, bool allowUnparsed, out SecurityProfileName result)

Tries to parse the given resource name string into a new SecurityProfileName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
securityProfileName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result SecurityProfileName

When this method returns, the parsed SecurityProfileName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • organizations/{organization}/locations/{location}/securityProfiles/{security_profile}
  • projects/{project}/locations/{location}/securityProfiles/{security_profile}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecurityProfileName, SecurityProfileName)

public static bool operator ==(SecurityProfileName a, SecurityProfileName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SecurityProfileName

The first resource name to compare, or null.
b SecurityProfileName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(SecurityProfileName, SecurityProfileName)

public static bool operator !=(SecurityProfileName a, SecurityProfileName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a SecurityProfileName

The first resource name to compare, or null.
b SecurityProfileName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.