Network Connectivity v1 API - Class ServiceConnectionTokenName (2.13.0) 

public sealed class ServiceConnectionTokenName : IResourceName, IEquatable<ServiceConnectionTokenName>

Reference documentation and code samples for the Network Connectivity v1 API class ServiceConnectionTokenName.

Resource name for the ServiceConnectionToken resource.

Inheritance

object > ServiceConnectionTokenName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

ServiceConnectionTokenName(string, string, string)

public ServiceConnectionTokenName(string projectId, string locationId, string serviceConnectionTokenId)

Constructs a new instance of a ServiceConnectionTokenName class from the component parts of pattern projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_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.
serviceConnectionTokenId string

The ServiceConnectionToken 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. 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

ServiceConnectionTokenId

public string ServiceConnectionTokenId { get; }

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

Property Value
Type Description
string

Type

public ServiceConnectionTokenName.ResourceNameType Type { get; }

The ServiceConnectionTokenName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServiceConnectionTokenNameResourceNameType

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

Formats the IDs into the string representation of this ServiceConnectionTokenName with pattern projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_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.
serviceConnectionTokenId string

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

The string representation of this ServiceConnectionTokenName with pattern projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_token}.

FormatProjectLocationServiceConnectionToken(string, string, string)

public static string FormatProjectLocationServiceConnectionToken(string projectId, string locationId, string serviceConnectionTokenId)

Formats the IDs into the string representation of this ServiceConnectionTokenName with pattern projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_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.
serviceConnectionTokenId string

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

The string representation of this ServiceConnectionTokenName with pattern projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_token}.

FromProjectLocationServiceConnectionToken(string, string, string)

public static ServiceConnectionTokenName FromProjectLocationServiceConnectionToken(string projectId, string locationId, string serviceConnectionTokenId)

Creates a ServiceConnectionTokenName with the pattern projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_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.
serviceConnectionTokenId string

The ServiceConnectionToken ID. Must not be null or empty.
Returns
Type Description
ServiceConnectionTokenName

A new instance of ServiceConnectionTokenName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceConnectionTokenName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceConnectionTokenName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
serviceConnectionTokenName string

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

The parsed ServiceConnectionTokenName if successful.
Remarks

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

  • projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_token}

Parse(string, bool)

public static ServiceConnectionTokenName Parse(string serviceConnectionTokenName, bool allowUnparsed)

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

Parameters
Name Description
serviceConnectionTokenName 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
ServiceConnectionTokenName

The parsed ServiceConnectionTokenName if successful.
Remarks

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

  • projects/{project}/locations/{location}/serviceConnectionTokens/{service_connection_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 ServiceConnectionTokenName)

public static bool TryParse(string serviceConnectionTokenName, out ServiceConnectionTokenName result)

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

Parameters
Name Description
serviceConnectionTokenName string

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

When this method returns, the parsed ServiceConnectionTokenName, 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}/serviceConnectionTokens/{service_connection_token}

TryParse(string, bool, out ServiceConnectionTokenName)

public static bool TryParse(string serviceConnectionTokenName, bool allowUnparsed, out ServiceConnectionTokenName result)

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

Parameters
Name Description
serviceConnectionTokenName 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 ServiceConnectionTokenName

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

Operators

operator ==(ServiceConnectionTokenName, ServiceConnectionTokenName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServiceConnectionTokenName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServiceConnectionTokenName

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

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.