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

public sealed class UnitOperationName : IResourceName, IEquatable<UnitOperationName>

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

Resource name for the UnitOperation resource.

Inheritance

object > UnitOperationName

Namespace

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1

Assembly

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll

Constructors

UnitOperationName(string, string, string)

public UnitOperationName(string projectId, string locationId, string unitOperationId)

Constructs a new instance of a UnitOperationName class from the component parts of pattern projects/{project}/locations/{location}/unitOperations/{unitOperation}

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

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

The UnitOperationName.ResourceNameType of the contained resource name.

Property Value
Type Description
UnitOperationNameResourceNameType

UnitOperationId

public string UnitOperationId { get; }

The UnitOperation 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 unitOperationId)

Formats the IDs into the string representation of this UnitOperationName with pattern projects/{project}/locations/{location}/unitOperations/{unitOperation}.

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

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

The string representation of this UnitOperationName with pattern projects/{project}/locations/{location}/unitOperations/{unitOperation}.

FormatProjectLocationUnitOperation(string, string, string)

public static string FormatProjectLocationUnitOperation(string projectId, string locationId, string unitOperationId)

Formats the IDs into the string representation of this UnitOperationName with pattern projects/{project}/locations/{location}/unitOperations/{unitOperation}.

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

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

The string representation of this UnitOperationName with pattern projects/{project}/locations/{location}/unitOperations/{unitOperation}.

FromProjectLocationUnitOperation(string, string, string)

public static UnitOperationName FromProjectLocationUnitOperation(string projectId, string locationId, string unitOperationId)

Creates a UnitOperationName with the pattern projects/{project}/locations/{location}/unitOperations/{unitOperation}.

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

The UnitOperation ID. Must not be null or empty.
Returns
Type Description
UnitOperationName

A new instance of UnitOperationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UnitOperationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UnitOperationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
unitOperationName string

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

The parsed UnitOperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/unitOperations/{unitOperation}

Parse(string, bool)

public static UnitOperationName Parse(string unitOperationName, bool allowUnparsed)

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

Parameters
Name Description
unitOperationName 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
UnitOperationName

The parsed UnitOperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/unitOperations/{unitOperation}
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 UnitOperationName)

public static bool TryParse(string unitOperationName, out UnitOperationName result)

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

Parameters
Name Description
unitOperationName string

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

When this method returns, the parsed UnitOperationName, 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}/unitOperations/{unitOperation}

TryParse(string, bool, out UnitOperationName)

public static bool TryParse(string unitOperationName, bool allowUnparsed, out UnitOperationName result)

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

Parameters
Name Description
unitOperationName 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 UnitOperationName

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

Operators

operator ==(UnitOperationName, UnitOperationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a UnitOperationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a UnitOperationName

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

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.