Google Cloud Dataproc v1 API - Class BatchName (5.5.0)

Version 5.5.0

• 5.16.0 (latest)
• 5.15.0
• 5.14.0
• 5.13.0
• 5.12.0
• 5.11.0
• 5.10.0
• 5.9.0
• 5.8.0
• 5.7.0
• 5.6.0
• 5.5.0
• 5.4.0
• 5.3.0
• 5.2.0
• 5.1.0
• 5.0.0
• 4.0.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0

public sealed class BatchName : IResourceName, IEquatable<BatchName>

Reference documentation and code samples for the Google Cloud Dataproc v1 API class BatchName.

Resource name for the Batch resource.

Inheritance

object > BatchName

Implements

IResourceName, IEquatableBatchName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.DataprocV1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

BatchName(string, string, string)

public BatchName(string projectId, string locationId, string batchId)

Constructs a new instance of a BatchName class from the component parts of pattern projects/{project}/locations/{location}/batches/{batch}

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

Properties

BatchId

public string BatchId { get; }

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

Property Value
Type	Description
string

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

Type

public BatchName.ResourceNameType Type { get; }

The BatchName.ResourceNameType of the contained resource name.

Property Value
Type	Description
BatchNameResourceNameType

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

Formats the IDs into the string representation of this BatchName with pattern projects/{project}/locations/{location}/batches/{batch}.

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

Returns
Type	Description
string	The string representation of this BatchName with pattern projects/{project}/locations/{location}/batches/{batch}.

FormatProjectLocationBatch(string, string, string)

public static string FormatProjectLocationBatch(string projectId, string locationId, string batchId)

Formats the IDs into the string representation of this BatchName with pattern projects/{project}/locations/{location}/batches/{batch}.

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

Returns
Type	Description
string	The string representation of this BatchName with pattern projects/{project}/locations/{location}/batches/{batch}.

FromProjectLocationBatch(string, string, string)

public static BatchName FromProjectLocationBatch(string projectId, string locationId, string batchId)

Creates a BatchName with the pattern projects/{project}/locations/{location}/batches/{batch}.

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

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

FromUnparsed(UnparsedResourceName)

public static BatchName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BatchName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
BatchName	The parsed BatchName if successful.

Remarks

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

• projects/{project}/locations/{location}/batches/{batch}

Parse(string, bool)

public static BatchName Parse(string batchName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/batches/{batch}

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

public static bool TryParse(string batchName, out BatchName result)

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

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

TryParse(string, bool, out BatchName)

public static bool TryParse(string batchName, bool allowUnparsed, out BatchName result)

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

Parameters
Name	Description
batchName	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	BatchName When this method returns, the parsed BatchName, 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}/batches/{batch}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BatchName, BatchName)

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

Parameters
Name	Description
a	BatchName
b	BatchName

Returns
Type	Description
bool

operator !=(BatchName, BatchName)

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

Parameters
Name	Description
a	BatchName
b	BatchName

Returns
Type	Description
bool