Batch v1alpha API - Class JobName (1.0.0-alpha16)

Version 1.0.0-alpha16

• 1.0.0-alpha31 (latest)
• 1.0.0-alpha30

public sealed class JobName : IResourceName, IEquatable<JobName>

Reference documentation and code samples for the Batch v1alpha API class JobName.

Resource name for the Job resource.

Inheritance

object > JobName

Implements

IResourceName, IEquatableJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Batch.V1Alpha

Assembly

Google.Cloud.Batch.V1Alpha.dll

Constructors

JobName(string, string, string)

public JobName(string projectId, string locationId, string jobId)

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

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.
jobId	string The Job 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

JobId

public string JobId { get; }

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

Property Value
Type	Description
string

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

Type

public JobName.ResourceNameType Type { get; }

The JobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
JobNameResourceNameType

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)

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

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

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.
jobId	string The Job ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this JobName with pattern projects/{project}/locations/{location}/jobs/{job}.

FormatProjectLocationJob(string, string, string)

public static string FormatProjectLocationJob(string projectId, string locationId, string jobId)

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

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.
jobId	string The Job ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this JobName with pattern projects/{project}/locations/{location}/jobs/{job}.

FromProjectLocationJob(string, string, string)

public static JobName FromProjectLocationJob(string projectId, string locationId, string jobId)

Creates a JobName with the pattern projects/{project}/locations/{location}/jobs/{job}.

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.
jobId	string The Job ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static JobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a JobName containing an unparsed resource name.

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

Returns
Type	Description
JobName	A new instance of JobName 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 JobName Parse(string jobName)

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

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

Returns
Type	Description
JobName	The parsed JobName if successful.

Remarks

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

• projects/{project}/locations/{location}/jobs/{job}

Parse(string, bool)

public static JobName Parse(string jobName, bool allowUnparsed)

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

Parameters
Name	Description
jobName	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
JobName	The parsed JobName if successful.

Remarks

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

• projects/{project}/locations/{location}/jobs/{job}

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

public static bool TryParse(string jobName, out JobName result)

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

Parameters
Name	Description
jobName	string The resource name in string form. Must not be null.
result	JobName When this method returns, the parsed JobName, 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}/jobs/{job}

TryParse(string, bool, out JobName)

public static bool TryParse(string jobName, bool allowUnparsed, out JobName result)

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

Parameters
Name	Description
jobName	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	JobName When this method returns, the parsed JobName, 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}/jobs/{job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(JobName, JobName)

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

Parameters
Name	Description
a	JobName
b	JobName

Returns
Type	Description
bool

operator !=(JobName, JobName)

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

Parameters
Name	Description
a	JobName
b	JobName

Returns
Type	Description
bool