Google Cloud Deploy v1 API - Class OperationName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

operationIdString

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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

OperationId

public string OperationId { get; }

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

Type

public OperationName.ResourceNameType Type { get; }

The OperationName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
OperationName.ResourceNameType

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

operationIdString

The Operation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

operationIdString

The Operation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

operationIdString

The Operation ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
OperationName

A new instance of OperationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static OperationName Parse(string operationName)

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

Parameter
NameDescription
operationNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
operationNameString

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

allowUnparsedBoolean

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
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
TypeDescription
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
NameDescription
operationNameString

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

resultOperationName

When this method returns, the parsed OperationName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
operationNameString

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

allowUnparsedBoolean

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.

resultOperationName

When this method returns, the parsed OperationName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(OperationName, OperationName)

public static bool operator ==(OperationName a, OperationName b)
Parameters
NameDescription
aOperationName
bOperationName
Returns
TypeDescription
Boolean

Inequality(OperationName, OperationName)

public static bool operator !=(OperationName a, OperationName b)
Parameters
NameDescription
aOperationName
bOperationName
Returns
TypeDescription
Boolean