SaaS Runtime v1beta1 API - Class UnitKindName (1.0.0-beta01) 

public sealed class UnitKindName : IResourceName, IEquatable<UnitKindName>

Reference documentation and code samples for the SaaS Runtime v1beta1 API class UnitKindName.

Resource name for the UnitKind resource.

Inheritance

object > UnitKindName

Namespace

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1

Assembly

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll

Constructors

UnitKindName(string, string, string)

public UnitKindName(string projectId, string locationId, string unitKindId)

Constructs a new instance of a UnitKindName class from the component parts of pattern projects/{project}/locations/{location}/unitKinds/{unitKind}

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.
unitKindId string

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

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 UnitKindName.ResourceNameType Type { get; }

The UnitKindName.ResourceNameType of the contained resource name.

Property Value
Type Description
UnitKindNameResourceNameType

UnitKindId

public string UnitKindId { get; }

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

Property Value
Type Description
string

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

Formats the IDs into the string representation of this UnitKindName with pattern projects/{project}/locations/{location}/unitKinds/{unitKind}.

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.
unitKindId string

The UnitKind ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this UnitKindName with pattern projects/{project}/locations/{location}/unitKinds/{unitKind}.

FormatProjectLocationUnitKind(string, string, string)

public static string FormatProjectLocationUnitKind(string projectId, string locationId, string unitKindId)

Formats the IDs into the string representation of this UnitKindName with pattern projects/{project}/locations/{location}/unitKinds/{unitKind}.

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.
unitKindId string

The UnitKind ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this UnitKindName with pattern projects/{project}/locations/{location}/unitKinds/{unitKind}.

FromProjectLocationUnitKind(string, string, string)

public static UnitKindName FromProjectLocationUnitKind(string projectId, string locationId, string unitKindId)

Creates a UnitKindName with the pattern projects/{project}/locations/{location}/unitKinds/{unitKind}.

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.
unitKindId string

The UnitKind ID. Must not be null or empty.
Returns
Type Description
UnitKindName

A new instance of UnitKindName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UnitKindName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UnitKindName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
UnitKindName

A new instance of UnitKindName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static UnitKindName Parse(string unitKindName)

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

Parameter
Name Description
unitKindName string

The resource name in string form. Must not be null.
Returns
Type Description
UnitKindName

The parsed UnitKindName if successful.
Remarks

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

  • projects/{project}/locations/{location}/unitKinds/{unitKind}

Parse(string, bool)

public static UnitKindName Parse(string unitKindName, bool allowUnparsed)

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

Parameters
Name Description
unitKindName 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
UnitKindName

The parsed UnitKindName if successful.
Remarks

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

  • projects/{project}/locations/{location}/unitKinds/{unitKind}
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

TryParse(string, out UnitKindName)

public static bool TryParse(string unitKindName, out UnitKindName result)

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

Parameters
Name Description
unitKindName string

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

When this method returns, the parsed UnitKindName, 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}/unitKinds/{unitKind}

TryParse(string, bool, out UnitKindName)

public static bool TryParse(string unitKindName, bool allowUnparsed, out UnitKindName result)

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

Parameters
Name Description
unitKindName 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 UnitKindName

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

Operators

operator ==(UnitKindName, UnitKindName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a UnitKindName

The first resource name to compare, or null.
b UnitKindName

The second resource name to compare, or null.
Returns
Type Description
bool

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

operator !=(UnitKindName, UnitKindName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a UnitKindName

The first resource name to compare, or null.
b UnitKindName

The second resource name to compare, or null.
Returns
Type Description
bool

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