Google Cloud Deploy v1 API - Class WorkerPoolName (2.1.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

Implements

IResourceName, IEquatable<WorkerPoolName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`WorkerPoolName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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

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`	`Boolean` 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

Object.ToString()

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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(WorkerPoolName, WorkerPoolName)

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

Parameters
Name	Description
`a`	`WorkerPoolName`
`b`	`WorkerPoolName`

Returns
Type	Description
`Boolean`

Inequality(WorkerPoolName, WorkerPoolName)

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

Parameters
Name	Description
`a`	`WorkerPoolName`
`b`	`WorkerPoolName`

Returns
Type	Description
`Boolean`