Memorystore v1 API - Class AuthTokenName (1.0.0-beta09) 

public sealed class AuthTokenName : IResourceName, IEquatable<AuthTokenName>

Reference documentation and code samples for the Memorystore v1 API class AuthTokenName.

Resource name for the AuthToken resource.

Inheritance

object > AuthTokenName

Namespace

Google.Cloud.Memorystore.V1

Assembly

Google.Cloud.Memorystore.V1.dll

Constructors

AuthTokenName(string, string, string, string, string)

public AuthTokenName(string projectId, string locationId, string instanceId, string tokenAuthUserId, string authTokenId)

Constructs a new instance of a AuthTokenName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

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

The Instance ID. Must not be null or empty.
tokenAuthUserId string

The TokenAuthUser ID. Must not be null or empty.
authTokenId string

The AuthToken ID. Must not be null or empty.

Properties

AuthTokenId

public string AuthTokenId { get; }

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

Property Value
Type Description
string

InstanceId

public string InstanceId { get; }

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

TokenAuthUserId

public string TokenAuthUserId { get; }

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

Property Value
Type Description
string

Type

public AuthTokenName.ResourceNameType Type { get; }

The AuthTokenName.ResourceNameType of the contained resource name.

Property Value
Type Description
AuthTokenNameResourceNameType

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, string, string)

public static string Format(string projectId, string locationId, string instanceId, string tokenAuthUserId, string authTokenId)

Formats the IDs into the string representation of this AuthTokenName with pattern projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} .

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

The Instance ID. Must not be null or empty.
tokenAuthUserId string

The TokenAuthUser ID. Must not be null or empty.
authTokenId string

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

The string representation of this AuthTokenName with pattern projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} .

FormatProjectLocationInstanceTokenAuthUserAuthToken(string, string, string, string, string)

public static string FormatProjectLocationInstanceTokenAuthUserAuthToken(string projectId, string locationId, string instanceId, string tokenAuthUserId, string authTokenId)

Formats the IDs into the string representation of this AuthTokenName with pattern projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} .

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

The Instance ID. Must not be null or empty.
tokenAuthUserId string

The TokenAuthUser ID. Must not be null or empty.
authTokenId string

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

The string representation of this AuthTokenName with pattern projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} .

FromProjectLocationInstanceTokenAuthUserAuthToken(string, string, string, string, string)

public static AuthTokenName FromProjectLocationInstanceTokenAuthUserAuthToken(string projectId, string locationId, string instanceId, string tokenAuthUserId, string authTokenId)

Creates a AuthTokenName with the pattern projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token} .

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

The Instance ID. Must not be null or empty.
tokenAuthUserId string

The TokenAuthUser ID. Must not be null or empty.
authTokenId string

The AuthToken ID. Must not be null or empty.
Returns
Type Description
AuthTokenName

A new instance of AuthTokenName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AuthTokenName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AuthTokenName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
authTokenName string

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

The parsed AuthTokenName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

Parse(string, bool)

public static AuthTokenName Parse(string authTokenName, bool allowUnparsed)

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

Parameters
Name Description
authTokenName 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
AuthTokenName

The parsed AuthTokenName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

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

public static bool TryParse(string authTokenName, out AuthTokenName result)

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

Parameters
Name Description
authTokenName string

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

When this method returns, the parsed AuthTokenName, 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}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

TryParse(string, bool, out AuthTokenName)

public static bool TryParse(string authTokenName, bool allowUnparsed, out AuthTokenName result)

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

Parameters
Name Description
authTokenName 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 AuthTokenName

When this method returns, the parsed AuthTokenName, 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}/instances/{instance}/tokenAuthUsers/{token_auth_user}/authTokens/{auth_token}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AuthTokenName, AuthTokenName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AuthTokenName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AuthTokenName

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

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.