Google Cloud Deploy v1 API - Class WorkerPoolName (3.6.0) 

public sealed class WorkerPoolName : IResourceName, IEquatable<WorkerPoolName>

Reference documentation and code samples for the Google Cloud Deploy v1 API class WorkerPoolName.

Resource name for the WorkerPool resource.

Inheritance

object > WorkerPoolName

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

WorkerPoolName(string, string, string)

public WorkerPoolName(string projectId, string locationId, string workerPoolId)

Constructs a new instance of a WorkerPoolName class from the component parts of pattern projects/{project}/locations/{location}/workerPools/{worker_pool}

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

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

The WorkerPoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
WorkerPoolNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

WorkerPoolId

public string WorkerPoolId { get; }

The WorkerPool 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 workerPoolId)

Formats the IDs into the string representation of this WorkerPoolName with pattern projects/{project}/locations/{location}/workerPools/{worker_pool}.

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

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

The string representation of this WorkerPoolName with pattern projects/{project}/locations/{location}/workerPools/{worker_pool}.

FormatProjectLocationWorkerPool(string, string, string)

public static string FormatProjectLocationWorkerPool(string projectId, string locationId, string workerPoolId)

Formats the IDs into the string representation of this WorkerPoolName with pattern projects/{project}/locations/{location}/workerPools/{worker_pool}.

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

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

The string representation of this WorkerPoolName with pattern projects/{project}/locations/{location}/workerPools/{worker_pool}.

FromProjectLocationWorkerPool(string, string, string)

public static WorkerPoolName FromProjectLocationWorkerPool(string projectId, string locationId, string workerPoolId)

Creates a WorkerPoolName with the pattern projects/{project}/locations/{location}/workerPools/{worker_pool}.

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

The WorkerPool ID. Must not be null or empty.
Returns
Type Description
WorkerPoolName

A new instance of WorkerPoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkerPoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkerPoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
workerPoolName string

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

The parsed WorkerPoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/workerPools/{worker_pool}

Parse(string, bool)

public static WorkerPoolName Parse(string workerPoolName, bool allowUnparsed)

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

Parameters
Name Description
workerPoolName 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
WorkerPoolName

The parsed WorkerPoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/workerPools/{worker_pool}
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 WorkerPoolName)

public static bool TryParse(string workerPoolName, out WorkerPoolName result)

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

Parameters
Name Description
workerPoolName string

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

When this method returns, the parsed WorkerPoolName, 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}/workerPools/{worker_pool}

TryParse(string, bool, out WorkerPoolName)

public static bool TryParse(string workerPoolName, bool allowUnparsed, out WorkerPoolName result)

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

Parameters
Name Description
workerPoolName 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 WorkerPoolName

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

Operators

operator ==(WorkerPoolName, WorkerPoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WorkerPoolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WorkerPoolName

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

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.