Google Cloud Tasks v2 API - Class TaskName (3.5.0)

public sealed class TaskName : IResourceName, IEquatable<TaskName>

Reference documentation and code samples for the Google Cloud Tasks v2 API class TaskName.

Resource name for the Task resource.

Inheritance

object > TaskName

Implements

IResourceName, IEquatable TaskName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Tasks.V2

Assembly

Google.Cloud.Tasks.V2.dll

Constructors

TaskName(string, string, string, string)

public TaskName(string projectId, string locationId, string queueId, string taskId)

Constructs a new instance of a TaskName class from the component parts of pattern projects/{project}/locations/{location}/queues/{queue}/tasks/{task}

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.
`queueId`	`string` The `Queue` ID. Must not be `null` or empty.
`taskId`	`string` The `Task` 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`

QueueId

public string QueueId { get; }

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

Property Value
Type	Description
`string`

TaskId

public string TaskId { get; }

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

Property Value
Type	Description
`string`

Type

public TaskName.ResourceNameType Type { get; }

The TaskName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TaskNameResourceNameType`

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

public static string Format(string projectId, string locationId, string queueId, string taskId)

Formats the IDs into the string representation of this TaskName with pattern projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.

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.
`queueId`	`string` The `Queue` ID. Must not be `null` or empty.
`taskId`	`string` The `Task` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TaskName with pattern `projects/{project}/locations/{location}/queues/{queue}/tasks/{task}`.

FormatProjectLocationQueueTask(string, string, string, string)

public static string FormatProjectLocationQueueTask(string projectId, string locationId, string queueId, string taskId)

Formats the IDs into the string representation of this TaskName with pattern projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.

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.
`queueId`	`string` The `Queue` ID. Must not be `null` or empty.
`taskId`	`string` The `Task` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TaskName with pattern `projects/{project}/locations/{location}/queues/{queue}/tasks/{task}`.

FromProjectLocationQueueTask(string, string, string, string)

public static TaskName FromProjectLocationQueueTask(string projectId, string locationId, string queueId, string taskId)

Creates a TaskName with the pattern projects/{project}/locations/{location}/queues/{queue}/tasks/{task}.

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.
`queueId`	`string` The `Queue` ID. Must not be `null` or empty.
`taskId`	`string` The `Task` ID. Must not be `null` or empty.

Returns
Type	Description
`TaskName`	A new instance of TaskName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TaskName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TaskName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`TaskName`	A new instance of TaskName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static TaskName Parse(string taskName)

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

Parameter
Name	Description
`taskName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`TaskName`	The parsed TaskName if successful.

Remarks

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

projects/{project}/locations/{location}/queues/{queue}/tasks/{task}

Parse(string, bool)

public static TaskName Parse(string taskName, bool allowUnparsed)

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

Parameters
Name	Description
`taskName`	`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
`TaskName`	The parsed TaskName if successful.

Remarks

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

projects/{project}/locations/{location}/queues/{queue}/tasks/{task}

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 TaskName)

public static bool TryParse(string taskName, out TaskName result)

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

Parameters
Name	Description
`taskName`	`string` The resource name in string form. Must not be `null`.
`result`	`TaskName` When this method returns, the parsed TaskName, 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}/queues/{queue}/tasks/{task}

TryParse(string, bool, out TaskName)

public static bool TryParse(string taskName, bool allowUnparsed, out TaskName result)

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

Parameters
Name	Description
`taskName`	`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`	`TaskName` When this method returns, the parsed TaskName, 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}/queues/{queue}/tasks/{task}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TaskName, TaskName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`TaskName` The first resource name to compare, or null.
`b`	`TaskName` 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 !=(TaskName, TaskName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TaskName` The first resource name to compare, or null.
`b`	`TaskName` 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.