Batch v1alpha API - Class ResourceAllowanceName (1.0.0-alpha26)

public sealed class ResourceAllowanceName : IResourceName, IEquatable<ResourceAllowanceName>

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

Resource name for the ResourceAllowance resource.

Inheritance

object > ResourceAllowanceName

Namespace

Google.Cloud.Batch.V1Alpha

Assembly

Google.Cloud.Batch.V1Alpha.dll

Constructors

ResourceAllowanceName(string, string, string)

public ResourceAllowanceName(string projectId, string locationId, string resourceAllowanceId)

Constructs a new instance of a ResourceAllowanceName class from the component parts of pattern projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

resourceAllowanceIdstring

The ResourceAllowance 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

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

ResourceAllowanceId

public string ResourceAllowanceId { get; }

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

Property Value
TypeDescription
string

Type

public ResourceAllowanceName.ResourceNameType Type { get; }

The ResourceAllowanceName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ResourceAllowanceNameResourceNameType

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)

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

Formats the IDs into the string representation of this ResourceAllowanceName with pattern projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

resourceAllowanceIdstring

The ResourceAllowance ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ResourceAllowanceName with pattern projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}.

FormatProjectLocationResourceAllowance(string, string, string)

public static string FormatProjectLocationResourceAllowance(string projectId, string locationId, string resourceAllowanceId)

Formats the IDs into the string representation of this ResourceAllowanceName with pattern projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

resourceAllowanceIdstring

The ResourceAllowance ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ResourceAllowanceName with pattern projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}.

FromProjectLocationResourceAllowance(string, string, string)

public static ResourceAllowanceName FromProjectLocationResourceAllowance(string projectId, string locationId, string resourceAllowanceId)

Creates a ResourceAllowanceName with the pattern projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

resourceAllowanceIdstring

The ResourceAllowance ID. Must not be null or empty.

Returns
TypeDescription
ResourceAllowanceName

A new instance of ResourceAllowanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourceAllowanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceAllowanceName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ResourceAllowanceName

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

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

Parameter
NameDescription
resourceAllowanceNamestring

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

Returns
TypeDescription
ResourceAllowanceName

The parsed ResourceAllowanceName if successful.

Remarks

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

  • projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}

Parse(string, bool)

public static ResourceAllowanceName Parse(string resourceAllowanceName, bool allowUnparsed)

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

Parameters
NameDescription
resourceAllowanceNamestring

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
ResourceAllowanceName

The parsed ResourceAllowanceName if successful.

Remarks

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

  • projects/{project}/locations/{location}/resourceAllowances/{resource_allowance}
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 ResourceAllowanceName)

public static bool TryParse(string resourceAllowanceName, out ResourceAllowanceName result)

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

Parameters
NameDescription
resourceAllowanceNamestring

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

resultResourceAllowanceName

When this method returns, the parsed ResourceAllowanceName, 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}/resourceAllowances/{resource_allowance}

TryParse(string, bool, out ResourceAllowanceName)

public static bool TryParse(string resourceAllowanceName, bool allowUnparsed, out ResourceAllowanceName result)

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

Parameters
NameDescription
resourceAllowanceNamestring

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.

resultResourceAllowanceName

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

Operators

operator ==(ResourceAllowanceName, ResourceAllowanceName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aResourceAllowanceName

The first resource name to compare, or null.

bResourceAllowanceName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ResourceAllowanceName, ResourceAllowanceName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aResourceAllowanceName

The first resource name to compare, or null.

bResourceAllowanceName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.