Google Cloud Deploy v1 API - Class OperationName (3.1.0) 

public sealed class OperationName : IResourceName, IEquatable<OperationName>

Reference documentation and code samples for the Google Cloud Deploy v1 API class OperationName.

Resource name for the Operation resource.

Inheritance

object > OperationName

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

OperationName(string, string, string)

public OperationName(string projectId, string locationId, string operationId)

Constructs a new instance of a OperationName class from the component parts of pattern projects/{project}/locations/{location}/operations/{operation}

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

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

OperationId

public string OperationId { get; }

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

The OperationName.ResourceNameType of the contained resource name.

Property Value
Type Description
OperationNameResourceNameType

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

Formats the IDs into the string representation of this OperationName with pattern projects/{project}/locations/{location}/operations/{operation}.

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

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

The string representation of this OperationName with pattern projects/{project}/locations/{location}/operations/{operation}.

FormatProjectLocationOperation(string, string, string)

public static string FormatProjectLocationOperation(string projectId, string locationId, string operationId)

Formats the IDs into the string representation of this OperationName with pattern projects/{project}/locations/{location}/operations/{operation}.

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

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

The string representation of this OperationName with pattern projects/{project}/locations/{location}/operations/{operation}.

FromProjectLocationOperation(string, string, string)

public static OperationName FromProjectLocationOperation(string projectId, string locationId, string operationId)

Creates a OperationName with the pattern projects/{project}/locations/{location}/operations/{operation}.

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

The Operation ID. Must not be null or empty.
Returns
Type Description
OperationName

A new instance of OperationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OperationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OperationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
operationName string

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

The parsed OperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/operations/{operation}

Parse(string, bool)

public static OperationName Parse(string operationName, bool allowUnparsed)

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

Parameters
Name Description
operationName 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
OperationName

The parsed OperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/operations/{operation}
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 OperationName)

public static bool TryParse(string operationName, out OperationName result)

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

Parameters
Name Description
operationName string

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

When this method returns, the parsed OperationName, 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}/operations/{operation}

TryParse(string, bool, out OperationName)

public static bool TryParse(string operationName, bool allowUnparsed, out OperationName result)

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

Parameters
Name Description
operationName 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 OperationName

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

Operators

operator ==(OperationName, OperationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OperationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OperationName

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

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.