Cloud Workstations v1 API - Class WorkstationName (1.4.0) 

public sealed class WorkstationName : IResourceName, IEquatable<WorkstationName>

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

Resource name for the Workstation resource.

Inheritance

object > WorkstationName

Namespace

Google.Cloud.Workstations.V1

Assembly

Google.Cloud.Workstations.V1.dll

Constructors

WorkstationName(string, string, string, string, string)

public WorkstationName(string projectId, string locationId, string workstationClusterId, string workstationConfigId, string workstationId)

Constructs a new instance of a WorkstationName class from the component parts of pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation}

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

The WorkstationConfig ID. Must not be null or empty.
workstationId string

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

The WorkstationName.ResourceNameType of the contained resource name.

Property Value
Type Description
WorkstationNameResourceNameType

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

WorkstationConfigId

public string WorkstationConfigId { get; }

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

Property Value
Type Description
string

WorkstationId

public string WorkstationId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string, string)

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

Formats the IDs into the string representation of this WorkstationName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation} .

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

The WorkstationConfig ID. Must not be null or empty.
workstationId string

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

The string representation of this WorkstationName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation} .

FormatProjectLocationWorkstationClusterWorkstationConfigWorkstation(string, string, string, string, string)

public static string FormatProjectLocationWorkstationClusterWorkstationConfigWorkstation(string projectId, string locationId, string workstationClusterId, string workstationConfigId, string workstationId)

Formats the IDs into the string representation of this WorkstationName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation} .

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

The WorkstationConfig ID. Must not be null or empty.
workstationId string

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

The string representation of this WorkstationName with pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation} .

FromProjectLocationWorkstationClusterWorkstationConfigWorkstation(string, string, string, string, string)

public static WorkstationName FromProjectLocationWorkstationClusterWorkstationConfigWorkstation(string projectId, string locationId, string workstationClusterId, string workstationConfigId, string workstationId)

Creates a WorkstationName with the pattern projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation} .

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

The WorkstationConfig ID. Must not be null or empty.
workstationId string

The Workstation ID. Must not be null or empty.
Returns
Type Description
WorkstationName

A new instance of WorkstationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkstationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkstationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
workstationName string

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

The parsed WorkstationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation}

Parse(string, bool)

public static WorkstationName Parse(string workstationName, bool allowUnparsed)

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

Parameters
Name Description
workstationName 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
WorkstationName

The parsed WorkstationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/workstationClusters/{workstation_cluster}/workstationConfigs/{workstation_config}/workstations/{workstation}
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 WorkstationName)

public static bool TryParse(string workstationName, out WorkstationName result)

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

Parameters
Name Description
workstationName string

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

When this method returns, the parsed WorkstationName, 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}/workstationConfigs/{workstation_config}/workstations/{workstation}

TryParse(string, bool, out WorkstationName)

public static bool TryParse(string workstationName, bool allowUnparsed, out WorkstationName result)

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

Parameters
Name Description
workstationName 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 WorkstationName

When this method returns, the parsed WorkstationName, 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}/workstationConfigs/{workstation_config}/workstations/{workstation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkstationName, WorkstationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WorkstationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WorkstationName

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

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.