Batch v1 API - Class TaskGroupName (2.5.0)

public sealed class TaskGroupName : IResourceName, IEquatable<TaskGroupName>

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

Resource name for the TaskGroup resource.

Inheritance

object > TaskGroupName

Namespace

Google.Cloud.Batch.V1

Assembly

Google.Cloud.Batch.V1.dll

Constructors

TaskGroupName(string, string, string, string)

public TaskGroupName(string projectId, string locationId, string jobId, string taskGroupId)

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

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.

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

Type

public TaskGroupName.ResourceNameType Type { get; }

The TaskGroupName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TaskGroupNameResourceNameType

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)

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

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

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.

Returns
TypeDescription
string

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

FormatProjectLocationJobTaskGroup(string, string, string, string)

public static string FormatProjectLocationJobTaskGroup(string projectId, string locationId, string jobId, string taskGroupId)

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

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.

Returns
TypeDescription
string

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

FromProjectLocationJobTaskGroup(string, string, string, string)

public static TaskGroupName FromProjectLocationJobTaskGroup(string projectId, string locationId, string jobId, string taskGroupId)

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

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.

Returns
TypeDescription
TaskGroupName

A new instance of TaskGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TaskGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TaskGroupName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TaskGroupName

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

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

Parameter
NameDescription
taskGroupNamestring

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

Returns
TypeDescription
TaskGroupName

The parsed TaskGroupName 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}

Parse(string, bool)

public static TaskGroupName Parse(string taskGroupName, bool allowUnparsed)

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

Parameters
NameDescription
taskGroupNamestring

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
TaskGroupName

The parsed TaskGroupName 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}
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 TaskGroupName)

public static bool TryParse(string taskGroupName, out TaskGroupName result)

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

Parameters
NameDescription
taskGroupNamestring

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

resultTaskGroupName

When this method returns, the parsed TaskGroupName, 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}

TryParse(string, bool, out TaskGroupName)

public static bool TryParse(string taskGroupName, bool allowUnparsed, out TaskGroupName result)

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

Parameters
NameDescription
taskGroupNamestring

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.

resultTaskGroupName

When this method returns, the parsed TaskGroupName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TaskGroupName, TaskGroupName)

public static bool operator ==(TaskGroupName a, TaskGroupName b)
Parameters
NameDescription
aTaskGroupName
bTaskGroupName
Returns
TypeDescription
bool

operator !=(TaskGroupName, TaskGroupName)

public static bool operator !=(TaskGroupName a, TaskGroupName b)
Parameters
NameDescription
aTaskGroupName
bTaskGroupName
Returns
TypeDescription
bool