API hub v1 API - Class ApiOperationName (1.2.0) 

public sealed class ApiOperationName : IResourceName, IEquatable<ApiOperationName>

Reference documentation and code samples for the API hub v1 API class ApiOperationName.

Resource name for the ApiOperation resource.

Inheritance

object > ApiOperationName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ApiOperationName(string, string, string, string, string)

public ApiOperationName(string projectId, string locationId, string apiId, string versionId, string operationId)

Constructs a new instance of a ApiOperationName class from the component parts of pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/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.
apiId string

The Api ID. Must not be null or empty.
versionId string

The Version ID. Must not be null or empty.
operationId string

The Operation ID. Must not be null or empty.

Properties

ApiId

public string ApiId { get; }

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

Property Value
Type Description
string

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

The ApiOperationName.ResourceNameType of the contained resource name.

Property Value
Type Description
ApiOperationNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

VersionId

public string VersionId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string apiId, string versionId, string operationId)

Formats the IDs into the string representation of this ApiOperationName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/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.
apiId string

The Api ID. Must not be null or empty.
versionId string

The Version 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 ApiOperationName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}.

FormatProjectLocationApiVersionOperation(string, string, string, string, string)

public static string FormatProjectLocationApiVersionOperation(string projectId, string locationId, string apiId, string versionId, string operationId)

Formats the IDs into the string representation of this ApiOperationName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/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.
apiId string

The Api ID. Must not be null or empty.
versionId string

The Version 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 ApiOperationName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}.

FromProjectLocationApiVersionOperation(string, string, string, string, string)

public static ApiOperationName FromProjectLocationApiVersionOperation(string projectId, string locationId, string apiId, string versionId, string operationId)

Creates a ApiOperationName with the pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/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.
apiId string

The Api ID. Must not be null or empty.
versionId string

The Version ID. Must not be null or empty.
operationId string

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

A new instance of ApiOperationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApiOperationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApiOperationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
apiOperationName string

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

The parsed ApiOperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

Parse(string, bool)

public static ApiOperationName Parse(string apiOperationName, bool allowUnparsed)

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

Parameters
Name Description
apiOperationName 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
ApiOperationName

The parsed ApiOperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apis/{api}/versions/{version}/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 ApiOperationName)

public static bool TryParse(string apiOperationName, out ApiOperationName result)

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

Parameters
Name Description
apiOperationName string

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

When this method returns, the parsed ApiOperationName, 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}/apis/{api}/versions/{version}/operations/{operation}

TryParse(string, bool, out ApiOperationName)

public static bool TryParse(string apiOperationName, bool allowUnparsed, out ApiOperationName result)

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

Parameters
Name Description
apiOperationName 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 ApiOperationName

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

Operators

operator ==(ApiOperationName, ApiOperationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ApiOperationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ApiOperationName

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

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.