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

public sealed class UnitName : IResourceName, IEquatable<UnitName>

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

Resource name for the Unit resource.

Inheritance

object > UnitName

Namespace

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1

Assembly

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll

Constructors

UnitName(string, string, string)

public UnitName(string projectId, string locationId, string unitId)

Constructs a new instance of a UnitName class from the component parts of pattern projects/{project}/locations/{location}/units/{unit}

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

The Unit 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 UnitName.ResourceNameType Type { get; }

The UnitName.ResourceNameType of the contained resource name.

Property Value
Type Description
UnitNameResourceNameType

UnitId

public string UnitId { get; }

The Unit 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 unitId)

Formats the IDs into the string representation of this UnitName with pattern projects/{project}/locations/{location}/units/{unit}.

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

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

The string representation of this UnitName with pattern projects/{project}/locations/{location}/units/{unit}.

FormatProjectLocationUnit(string, string, string)

public static string FormatProjectLocationUnit(string projectId, string locationId, string unitId)

Formats the IDs into the string representation of this UnitName with pattern projects/{project}/locations/{location}/units/{unit}.

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

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

The string representation of this UnitName with pattern projects/{project}/locations/{location}/units/{unit}.

FromProjectLocationUnit(string, string, string)

public static UnitName FromProjectLocationUnit(string projectId, string locationId, string unitId)

Creates a UnitName with the pattern projects/{project}/locations/{location}/units/{unit} .

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

The Unit ID. Must not be null or empty.
Returns
Type Description
UnitName

A new instance of UnitName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UnitName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UnitName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
unitName string

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

The parsed UnitName if successful.
Remarks

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

  • projects/{project}/locations/{location}/units/{unit}

Parse(string, bool)

public static UnitName Parse(string unitName, bool allowUnparsed)

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

Parameters
Name Description
unitName 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
UnitName

The parsed UnitName if successful.
Remarks

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

  • projects/{project}/locations/{location}/units/{unit}
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 UnitName)

public static bool TryParse(string unitName, out UnitName result)

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

Parameters
Name Description
unitName string

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

When this method returns, the parsed UnitName, 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}/units/{unit}

TryParse(string, bool, out UnitName)

public static bool TryParse(string unitName, bool allowUnparsed, out UnitName result)

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

Parameters
Name Description
unitName 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 UnitName

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

Operators

operator ==(UnitName, UnitName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a UnitName

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

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 !=(UnitName, UnitName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a UnitName

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

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.