Batch v1 API - Class TaskName (2.3.0)

public sealed class TaskName : IResourceName, IEquatable<TaskName>

Reference documentation and code samples for the Batch v1 API class TaskName.

Resource name for the Task resource.

Inheritance

object > TaskName

Namespace

Google.Cloud.Batch.V1

Assembly

Google.Cloud.Batch.V1.dll

Constructors

TaskName(string, string, string, string, string)

public TaskName(string projectId, string locationId, string jobId, string taskGroupId, string taskId)

Constructs a new instance of a TaskName class from the component parts of pattern projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

jobIdstring

The Job ID. Must not be null or empty.

taskGroupIdstring

The TaskGroup ID. Must not be null or empty.

taskIdstring

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
TypeDescription
bool

JobId

public string JobId { get; }

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

Property Value
TypeDescription
string

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

TaskGroupId

public string TaskGroupId { get; }

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

Property Value
TypeDescription
string

TaskId

public string TaskId { get; }

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

Property Value
TypeDescription
string

Type

public TaskName.ResourceNameType Type { get; }

The TaskName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TaskNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string jobId, string taskGroupId, string taskId)

Formats the IDs into the string representation of this TaskName with pattern projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

jobIdstring

The Job ID. Must not be null or empty.

taskGroupIdstring

The TaskGroup ID. Must not be null or empty.

taskIdstring

The Task ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TaskName with pattern projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}.

FormatProjectLocationJobTaskGroupTask(string, string, string, string, string)

public static string FormatProjectLocationJobTaskGroupTask(string projectId, string locationId, string jobId, string taskGroupId, string taskId)

Formats the IDs into the string representation of this TaskName with pattern projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

jobIdstring

The Job ID. Must not be null or empty.

taskGroupIdstring

The TaskGroup ID. Must not be null or empty.

taskIdstring

The Task ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TaskName with pattern projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}.

FromProjectLocationJobTaskGroupTask(string, string, string, string, string)

public static TaskName FromProjectLocationJobTaskGroupTask(string projectId, string locationId, string jobId, string taskGroupId, string taskId)

Creates a TaskName with the pattern projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}/tasks/{task}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

jobIdstring

The Job ID. Must not be null or empty.

taskGroupIdstring

The TaskGroup ID. Must not be null or empty.

taskIdstring

The Task ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TaskName

A new instance of TaskName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TaskName Parse(string taskName)

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

Parameter
NameDescription
taskNamestring

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

Returns
TypeDescription
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}/jobs/{job}/taskGroups/{task_group}/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
NameDescription
taskNamestring

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

allowUnparsedbool

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
TypeDescription
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}/jobs/{job}/taskGroups/{task_group}/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
TypeDescription
string

The string representation of the resource name.

Overrides

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
NameDescription
taskNamestring

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

resultTaskName

When this method returns, the parsed TaskName, or null if parsing failed.

Returns
TypeDescription
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}/jobs/{job}/taskGroups/{task_group}/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
NameDescription
taskNamestring

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

allowUnparsedbool

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.

resultTaskName

When this method returns, the parsed TaskName, or null if parsing failed.

Returns
TypeDescription
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}/jobs/{job}/taskGroups/{task_group}/tasks/{task}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TaskName, TaskName)

public static bool operator ==(TaskName a, TaskName b)
Parameters
NameDescription
aTaskName
bTaskName
Returns
TypeDescription
bool

operator !=(TaskName, TaskName)

public static bool operator !=(TaskName a, TaskName b)
Parameters
NameDescription
aTaskName
bTaskName
Returns
TypeDescription
bool