Network Services v1 API - Class AuthorizationPolicyName (1.0.0-beta01)

public sealed class AuthorizationPolicyName : IResourceName, IEquatable<AuthorizationPolicyName>

Reference documentation and code samples for the Network Services v1 API class AuthorizationPolicyName.

Resource name for the AuthorizationPolicy resource.

Inheritance

object > AuthorizationPolicyName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

AuthorizationPolicyName(string, string, string)

public AuthorizationPolicyName(string projectId, string locationId, string authorizationPolicyId)

Constructs a new instance of a AuthorizationPolicyName class from the component parts of pattern projects/{project}/locations/{location}/authorizationPolicies/{authorization_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.

authorizationPolicyId string

The AuthorizationPolicy ID. Must not be null or empty.

Properties

AuthorizationPolicyId

public string AuthorizationPolicyId { get; }

The AuthorizationPolicy 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 AuthorizationPolicyName.ResourceNameType Type { get; }

The AuthorizationPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
AuthorizationPolicyNameResourceNameType

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

Formats the IDs into the string representation of this AuthorizationPolicyName with pattern projects/{project}/locations/{location}/authorizationPolicies/{authorization_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.

authorizationPolicyId string

The AuthorizationPolicy ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AuthorizationPolicyName with pattern projects/{project}/locations/{location}/authorizationPolicies/{authorization_policy}.

FormatProjectLocationAuthorizationPolicy(string, string, string)

public static string FormatProjectLocationAuthorizationPolicy(string projectId, string locationId, string authorizationPolicyId)

Formats the IDs into the string representation of this AuthorizationPolicyName with pattern projects/{project}/locations/{location}/authorizationPolicies/{authorization_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.

authorizationPolicyId string

The AuthorizationPolicy ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AuthorizationPolicyName with pattern projects/{project}/locations/{location}/authorizationPolicies/{authorization_policy}.

FromProjectLocationAuthorizationPolicy(string, string, string)

public static AuthorizationPolicyName FromProjectLocationAuthorizationPolicy(string projectId, string locationId, string authorizationPolicyId)

Creates a AuthorizationPolicyName with the pattern projects/{project}/locations/{location}/authorizationPolicies/{authorization_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.

authorizationPolicyId string

The AuthorizationPolicy ID. Must not be null or empty.

Returns
Type Description
AuthorizationPolicyName

A new instance of AuthorizationPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuthorizationPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuthorizationPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
AuthorizationPolicyName

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

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

Parameter
Name Description
authorizationPolicyName string

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

Returns
Type Description
AuthorizationPolicyName

The parsed AuthorizationPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/authorizationPolicies/{authorization_policy}

Parse(string, bool)

public static AuthorizationPolicyName Parse(string authorizationPolicyName, bool allowUnparsed)

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

Parameters
Name Description
authorizationPolicyName 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
AuthorizationPolicyName

The parsed AuthorizationPolicyName if successful.

Remarks

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

  • projects/{project}/locations/{location}/authorizationPolicies/{authorization_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 AuthorizationPolicyName)

public static bool TryParse(string authorizationPolicyName, out AuthorizationPolicyName result)

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

Parameters
Name Description
authorizationPolicyName string

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

result AuthorizationPolicyName

When this method returns, the parsed AuthorizationPolicyName, 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}/authorizationPolicies/{authorization_policy}

TryParse(string, bool, out AuthorizationPolicyName)

public static bool TryParse(string authorizationPolicyName, bool allowUnparsed, out AuthorizationPolicyName result)

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

Parameters
Name Description
authorizationPolicyName 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 AuthorizationPolicyName

When this method returns, the parsed AuthorizationPolicyName, 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}/authorizationPolicies/{authorization_policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AuthorizationPolicyName, AuthorizationPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AuthorizationPolicyName

The first resource name to compare, or null.

b AuthorizationPolicyName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AuthorizationPolicyName

The first resource name to compare, or null.

b AuthorizationPolicyName

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.