Google Cloud Tasks v2beta3 API - Class TaskName (3.0.0-beta02)

Version 3.0.0-beta02

• 3.0.0-beta07 (latest)
• 3.0.0-beta06
• 2.0.0-beta08

public sealed class TaskName : IResourceName, IEquatable<TaskName>

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

Resource name for the Task resource.

Inheritance

Object > TaskName

Implements

IResourceName, IEquatable<TaskName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Tasks.V2Beta3

Assembly

Google.Cloud.Tasks.V2Beta3.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
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

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
TaskName.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, 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
Int32

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

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	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
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
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}/queues/{queue}/tasks/{task}

TryParse(String, Boolean, 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	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	TaskName When this method returns, the parsed TaskName, 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}/queues/{queue}/tasks/{task}

Or may be in any format if allowUnparsed is true.

Operators

Equality(TaskName, TaskName)

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

Parameters
Name	Description
a	TaskName
b	TaskName

Returns
Type	Description
Boolean

Inequality(TaskName, TaskName)

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

Parameters
Name	Description
a	TaskName
b	TaskName

Returns
Type	Description
Boolean