Network Services v1 API - Class AuthzExtensionName (1.3.0)

public sealed class AuthzExtensionName : IResourceName, IEquatable<AuthzExtensionName>

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

Resource name for the AuthzExtension resource.

Inheritance

object > AuthzExtensionName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

AuthzExtensionName(string, string, string)

public AuthzExtensionName(string projectId, string locationId, string authzExtensionId)

Constructs a new instance of a AuthzExtensionName class from the component parts of pattern projects/{project}/locations/{location}/authzExtensions/{authz_extension}

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.

authzExtensionId string

The AuthzExtension ID. Must not be null or empty.

Properties

AuthzExtensionId

public string AuthzExtensionId { get; }

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

The AuthzExtensionName.ResourceNameType of the contained resource name.

Property Value
Type Description
AuthzExtensionNameResourceNameType

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

Formats the IDs into the string representation of this AuthzExtensionName with pattern projects/{project}/locations/{location}/authzExtensions/{authz_extension}.

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.

authzExtensionId string

The AuthzExtension ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AuthzExtensionName with pattern projects/{project}/locations/{location}/authzExtensions/{authz_extension}.

FormatProjectLocationAuthzExtension(string, string, string)

public static string FormatProjectLocationAuthzExtension(string projectId, string locationId, string authzExtensionId)

Formats the IDs into the string representation of this AuthzExtensionName with pattern projects/{project}/locations/{location}/authzExtensions/{authz_extension}.

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.

authzExtensionId string

The AuthzExtension ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AuthzExtensionName with pattern projects/{project}/locations/{location}/authzExtensions/{authz_extension}.

FromProjectLocationAuthzExtension(string, string, string)

public static AuthzExtensionName FromProjectLocationAuthzExtension(string projectId, string locationId, string authzExtensionId)

Creates a AuthzExtensionName with the pattern projects/{project}/locations/{location}/authzExtensions/{authz_extension}.

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.

authzExtensionId string

The AuthzExtension ID. Must not be null or empty.

Returns
Type Description
AuthzExtensionName

A new instance of AuthzExtensionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuthzExtensionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuthzExtensionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
AuthzExtensionName

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

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

Parameter
Name Description
authzExtensionName string

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

Returns
Type Description
AuthzExtensionName

The parsed AuthzExtensionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/authzExtensions/{authz_extension}

Parse(string, bool)

public static AuthzExtensionName Parse(string authzExtensionName, bool allowUnparsed)

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

Parameters
Name Description
authzExtensionName 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
AuthzExtensionName

The parsed AuthzExtensionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/authzExtensions/{authz_extension}
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 AuthzExtensionName)

public static bool TryParse(string authzExtensionName, out AuthzExtensionName result)

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

Parameters
Name Description
authzExtensionName string

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

result AuthzExtensionName

When this method returns, the parsed AuthzExtensionName, 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}/authzExtensions/{authz_extension}

TryParse(string, bool, out AuthzExtensionName)

public static bool TryParse(string authzExtensionName, bool allowUnparsed, out AuthzExtensionName result)

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

Parameters
Name Description
authzExtensionName 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 AuthzExtensionName

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

Operators

operator ==(AuthzExtensionName, AuthzExtensionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AuthzExtensionName

The first resource name to compare, or null.

b AuthzExtensionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AuthzExtensionName

The first resource name to compare, or null.

b AuthzExtensionName

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.