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

public sealed class AuthzPolicyName : IResourceName, IEquatable<AuthzPolicyName>

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

Resource name for the AuthzPolicy resource.

Inheritance

object > AuthzPolicyName

Namespace

Google.Cloud.NetworkSecurity.V1

Assembly

Google.Cloud.NetworkSecurity.V1.dll

Constructors

AuthzPolicyName(string, string, string)

public AuthzPolicyName(string projectId, string locationId, string authzPolicyId)

Constructs a new instance of a AuthzPolicyName class from the component parts of pattern projects/{project}/locations/{location}/authzPolicies/{authz_policy}

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

The AuthzPolicy ID. Must not be null or empty.

Properties

AuthzPolicyId

public string AuthzPolicyId { get; }

The AuthzPolicy ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public AuthzPolicyName.ResourceNameType Type { get; }

The AuthzPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
AuthzPolicyNameResourceNameType

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 projectId, string locationId, string authzPolicyId)

Formats the IDs into the string representation of this AuthzPolicyName with pattern projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

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

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

The string representation of this AuthzPolicyName with pattern projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

FormatProjectLocationAuthzPolicy(string, string, string)

public static string FormatProjectLocationAuthzPolicy(string projectId, string locationId, string authzPolicyId)

Formats the IDs into the string representation of this AuthzPolicyName with pattern projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

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

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

The string representation of this AuthzPolicyName with pattern projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

FromProjectLocationAuthzPolicy(string, string, string)

public static AuthzPolicyName FromProjectLocationAuthzPolicy(string projectId, string locationId, string authzPolicyId)

Creates a AuthzPolicyName with the pattern projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

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

The AuthzPolicy ID. Must not be null or empty.
Returns
Type Description
AuthzPolicyName

A new instance of AuthzPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuthzPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuthzPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
authzPolicyName string

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

The parsed AuthzPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/authzPolicies/{authz_policy}

Parse(string, bool)

public static AuthzPolicyName Parse(string authzPolicyName, bool allowUnparsed)

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

Parameters
Name Description
authzPolicyName 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
AuthzPolicyName

The parsed AuthzPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/authzPolicies/{authz_policy}

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

public static bool TryParse(string authzPolicyName, out AuthzPolicyName result)

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

Parameters
Name Description
authzPolicyName string

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

When this method returns, the parsed AuthzPolicyName, 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:

  • projects/{project}/locations/{location}/authzPolicies/{authz_policy}

TryParse(string, bool, out AuthzPolicyName)

public static bool TryParse(string authzPolicyName, bool allowUnparsed, out AuthzPolicyName result)

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

Parameters
Name Description
authzPolicyName 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 AuthzPolicyName

When this method returns, the parsed AuthzPolicyName, 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:

  • projects/{project}/locations/{location}/authzPolicies/{authz_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AuthzPolicyName, AuthzPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AuthzPolicyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AuthzPolicyName

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

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.