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

public sealed class SecurityProfileGroupName : IResourceName, IEquatable<SecurityProfileGroupName>

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

Resource name for the SecurityProfileGroup resource.

Inheritance

object > SecurityProfileGroupName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

SecurityProfileGroupName(string, string, string)

public SecurityProfileGroupName(string organizationId, string locationId, string securityProfileGroupId)

Constructs a new instance of a SecurityProfileGroupName class from the component parts of pattern organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}

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.
securityProfileGroupId string

The SecurityProfileGroup 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

SecurityProfileGroupId

public string SecurityProfileGroupId { get; }

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

Property Value
Type Description
string

Type

public SecurityProfileGroupName.ResourceNameType Type { get; }

The SecurityProfileGroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
SecurityProfileGroupNameResourceNameType

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 securityProfileGroupId)

Formats the IDs into the string representation of this SecurityProfileGroupName with pattern organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}.

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.
securityProfileGroupId string

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

The string representation of this SecurityProfileGroupName with pattern organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}.

FormatOrganizationLocationSecurityProfileGroup(string, string, string)

public static string FormatOrganizationLocationSecurityProfileGroup(string organizationId, string locationId, string securityProfileGroupId)

Formats the IDs into the string representation of this SecurityProfileGroupName with pattern organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}.

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.
securityProfileGroupId string

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

The string representation of this SecurityProfileGroupName with pattern organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}.

FormatProjectLocationSecurityProfileGroup(string, string, string)

public static string FormatProjectLocationSecurityProfileGroup(string projectId, string locationId, string securityProfileGroupId)

Formats the IDs into the string representation of this SecurityProfileGroupName with pattern projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}.

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.
securityProfileGroupId string

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

The string representation of this SecurityProfileGroupName with pattern projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}.

FromOrganizationLocationSecurityProfileGroup(string, string, string)

public static SecurityProfileGroupName FromOrganizationLocationSecurityProfileGroup(string organizationId, string locationId, string securityProfileGroupId)

Creates a SecurityProfileGroupName with the pattern organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}.

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.
securityProfileGroupId string

The SecurityProfileGroup ID. Must not be null or empty.
Returns
Type Description
SecurityProfileGroupName

A new instance of SecurityProfileGroupName constructed from the provided ids.

FromProjectLocationSecurityProfileGroup(string, string, string)

public static SecurityProfileGroupName FromProjectLocationSecurityProfileGroup(string projectId, string locationId, string securityProfileGroupId)

Creates a SecurityProfileGroupName with the pattern projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}.

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.
securityProfileGroupId string

The SecurityProfileGroup ID. Must not be null or empty.
Returns
Type Description
SecurityProfileGroupName

A new instance of SecurityProfileGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SecurityProfileGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecurityProfileGroupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of SecurityProfileGroupName 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 SecurityProfileGroupName Parse(string securityProfileGroupName)

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

Parameter
Name Description
securityProfileGroupName string

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

The parsed SecurityProfileGroupName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}
  • projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}

Parse(string, bool)

public static SecurityProfileGroupName Parse(string securityProfileGroupName, bool allowUnparsed)

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

Parameters
Name Description
securityProfileGroupName 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
SecurityProfileGroupName

The parsed SecurityProfileGroupName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}
  • projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}

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 SecurityProfileGroupName)

public static bool TryParse(string securityProfileGroupName, out SecurityProfileGroupName result)

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

Parameters
Name Description
securityProfileGroupName string

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

When this method returns, the parsed SecurityProfileGroupName, 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}/securityProfileGroups/{security_profile_group}
  • projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}

TryParse(string, bool, out SecurityProfileGroupName)

public static bool TryParse(string securityProfileGroupName, bool allowUnparsed, out SecurityProfileGroupName result)

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

Parameters
Name Description
securityProfileGroupName 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 SecurityProfileGroupName

When this method returns, the parsed SecurityProfileGroupName, 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}/securityProfileGroups/{security_profile_group}
  • projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecurityProfileGroupName, SecurityProfileGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SecurityProfileGroupName

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

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 !=(SecurityProfileGroupName, SecurityProfileGroupName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SecurityProfileGroupName

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

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.