Cloud Workstations v1 API - Class WorkstationClusterName (1.2.0)

public sealed class WorkstationClusterName : IResourceName, IEquatable<WorkstationClusterName>

Reference documentation and code samples for the Cloud Workstations v1 API class WorkstationClusterName.

Resource name for the WorkstationCluster resource.

Inheritance

object > WorkstationClusterName

Namespace

Google.Cloud.Workstations.V1

Assembly

Google.Cloud.Workstations.V1.dll

Constructors

WorkstationClusterName(string, string, string)

public WorkstationClusterName(string projectId, string locationId, string workstationClusterId)

Constructs a new instance of a WorkstationClusterName class from the component parts of pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}

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.

workstationClusterId string

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

Type

public WorkstationClusterName.ResourceNameType Type { get; }

The WorkstationClusterName.ResourceNameType of the contained resource name.

Property Value
Type Description
WorkstationClusterNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

WorkstationClusterId

public string WorkstationClusterId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string workstationClusterId)

Formats the IDs into the string representation of this WorkstationClusterName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.

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.

workstationClusterId string

The WorkstationCluster ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this WorkstationClusterName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.

FormatProjectLocationWorkstationCluster(string, string, string)

public static string FormatProjectLocationWorkstationCluster(string projectId, string locationId, string workstationClusterId)

Formats the IDs into the string representation of this WorkstationClusterName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.

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.

workstationClusterId string

The WorkstationCluster ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this WorkstationClusterName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.

FromProjectLocationWorkstationCluster(string, string, string)

public static WorkstationClusterName FromProjectLocationWorkstationCluster(string projectId, string locationId, string workstationClusterId)

Creates a WorkstationClusterName with the pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}.

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.

workstationClusterId string

The WorkstationCluster ID. Must not be null or empty.

Returns
Type Description
WorkstationClusterName

A new instance of WorkstationClusterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkstationClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkstationClusterName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
WorkstationClusterName

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

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

Parameter
Name Description
workstationClusterName string

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

Returns
Type Description
WorkstationClusterName

The parsed WorkstationClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}

Parse(string, bool)

public static WorkstationClusterName Parse(string workstationClusterName, bool allowUnparsed)

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

Parameters
Name Description
workstationClusterName 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
WorkstationClusterName

The parsed WorkstationClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}
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 WorkstationClusterName)

public static bool TryParse(string workstationClusterName, out WorkstationClusterName result)

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

Parameters
Name Description
workstationClusterName string

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

result WorkstationClusterName

When this method returns, the parsed WorkstationClusterName, 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}/workstationClusters/{workstation_cluster}

TryParse(string, bool, out WorkstationClusterName)

public static bool TryParse(string workstationClusterName, bool allowUnparsed, out WorkstationClusterName result)

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

Parameters
Name Description
workstationClusterName 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 WorkstationClusterName

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

Operators

operator ==(WorkstationClusterName, WorkstationClusterName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WorkstationClusterName

The first resource name to compare, or null.

b WorkstationClusterName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WorkstationClusterName

The first resource name to compare, or null.

b WorkstationClusterName

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.