Storage Transfer v1 API - Class agentPoolsName (2.5.0)

public sealed class agentPoolsName : IResourceName, IEquatable<agentPoolsName>

Reference documentation and code samples for the Storage Transfer v1 API class agentPoolsName.

Resource name for the agentPools resource.

Inheritance

object > agentPoolsName

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Constructors

agentPoolsName(string, string)

public agentPoolsName(string projectId, string agentPoolId)

Constructs a new instance of a agentPoolsName class from the component parts of pattern projects/{project_id}/agentPools/{agent_pool_id}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
agentPoolId string

The AgentPool ID. Must not be null or empty.

Properties

AgentPoolId

public string AgentPoolId { get; }

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

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

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 agentPoolsName.ResourceNameType Type { get; }

The agentPoolsName.ResourceNameType of the contained resource name.

Property Value
Type Description
agentPoolsNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string)

public static string Format(string projectId, string agentPoolId)

Formats the IDs into the string representation of this agentPoolsName with pattern projects/{project_id}/agentPools/{agent_pool_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
agentPoolId string

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

The string representation of this agentPoolsName with pattern projects/{project_id}/agentPools/{agent_pool_id}.

FormatProjectAgentPool(string, string)

public static string FormatProjectAgentPool(string projectId, string agentPoolId)

Formats the IDs into the string representation of this agentPoolsName with pattern projects/{project_id}/agentPools/{agent_pool_id}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
agentPoolId string

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

The string representation of this agentPoolsName with pattern projects/{project_id}/agentPools/{agent_pool_id}.

FromProjectAgentPool(string, string)

public static agentPoolsName FromProjectAgentPool(string projectId, string agentPoolId)

Creates a agentPoolsName with the pattern projects/{project_id}/agentPools/{agent_pool_id} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
agentPoolId string

The AgentPool ID. Must not be null or empty.
Returns
Type Description
agentPoolsName

A new instance of agentPoolsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static agentPoolsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a agentPoolsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
agentPoolsName string

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

The parsed agentPoolsName if successful.
Remarks

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

  • projects/{project_id}/agentPools/{agent_pool_id}

Parse(string, bool)

public static agentPoolsName Parse(string agentPoolsName, bool allowUnparsed)

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

Parameters
Name Description
agentPoolsName 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
agentPoolsName

The parsed agentPoolsName if successful.
Remarks

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

  • projects/{project_id}/agentPools/{agent_pool_id}
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 agentPoolsName)

public static bool TryParse(string agentPoolsName, out agentPoolsName result)

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

Parameters
Name Description
agentPoolsName string

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

When this method returns, the parsed agentPoolsName, 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_id}/agentPools/{agent_pool_id}

TryParse(string, bool, out agentPoolsName)

public static bool TryParse(string agentPoolsName, bool allowUnparsed, out agentPoolsName result)

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

Parameters
Name Description
agentPoolsName 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 agentPoolsName

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

Operators

operator ==(agentPoolsName, agentPoolsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a agentPoolsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a agentPoolsName

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

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.