Storage Transfer v1 API - Class agentPoolsName (2.2.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

Implements

IResourceName, IEquatable<agentPoolsName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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

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
`agentPoolsName.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`

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

Overrides

Object.GetHashCode()

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

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

Object.ToString()

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
`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_id}/agentPools/{agent_pool_id}

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

Or may be in any format if allowUnparsed is true.

Operators

Equality(agentPoolsName, agentPoolsName)

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

Parameters
Name	Description
`a`	`agentPoolsName`
`b`	`agentPoolsName`

Returns
Type	Description
`Boolean`

Inequality(agentPoolsName, agentPoolsName)

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

Parameters
Name	Description
`a`	`agentPoolsName`
`b`	`agentPoolsName`

Returns
Type	Description
`Boolean`