Cloud Run Admin v2 API - Class BuildWorkerPoolName (2.16.0) 

public sealed class BuildWorkerPoolName : IResourceName, IEquatable<BuildWorkerPoolName>

Reference documentation and code samples for the Cloud Run Admin v2 API class BuildWorkerPoolName.

Resource name for the BuildWorkerPool resource.

Inheritance

object > BuildWorkerPoolName

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Constructors

BuildWorkerPoolName(string, string, string)

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

Constructs a new instance of a BuildWorkerPoolName 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 BuildWorkerPoolName.ResourceNameType Type { get; }

The BuildWorkerPoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
BuildWorkerPoolNameResourceNameType

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 BuildWorkerPoolName 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 BuildWorkerPoolName 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 BuildWorkerPoolName 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 BuildWorkerPoolName with pattern projects/{project}/locations/{location}/workerPools/{worker_pool}.

FromProjectLocationWorkerPool(string, string, string)

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

Creates a BuildWorkerPoolName 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
BuildWorkerPoolName

A new instance of BuildWorkerPoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BuildWorkerPoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BuildWorkerPoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
buildWorkerPoolName string

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

The parsed BuildWorkerPoolName 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 BuildWorkerPoolName Parse(string buildWorkerPoolName, bool allowUnparsed)

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

Parameters
Name Description
buildWorkerPoolName 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
BuildWorkerPoolName

The parsed BuildWorkerPoolName 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 BuildWorkerPoolName)

public static bool TryParse(string buildWorkerPoolName, out BuildWorkerPoolName result)

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

Parameters
Name Description
buildWorkerPoolName string

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

When this method returns, the parsed BuildWorkerPoolName, 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 BuildWorkerPoolName)

public static bool TryParse(string buildWorkerPoolName, bool allowUnparsed, out BuildWorkerPoolName result)

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

Parameters
Name Description
buildWorkerPoolName 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 BuildWorkerPoolName

When this method returns, the parsed BuildWorkerPoolName, 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 ==(BuildWorkerPoolName, BuildWorkerPoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BuildWorkerPoolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BuildWorkerPoolName

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

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.