API Gateway v1 API - Class ApiName (2.4.0) 

public sealed class ApiName : IResourceName, IEquatable<ApiName>

Reference documentation and code samples for the API Gateway v1 API class ApiName.

Resource name for the Api resource.

Inheritance

object > ApiName

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

ApiName(string, string)

public ApiName(string projectId, string apiId)

Constructs a new instance of a ApiName class from the component parts of pattern projects/{project}/locations/global/apis/{api}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
apiId string

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

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

The ApiName.ResourceNameType of the contained resource name.

Property Value
Type Description
ApiNameResourceNameType

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)

public static string Format(string projectId, string apiId)

Formats the IDs into the string representation of this ApiName with pattern projects/{project}/locations/global/apis/{api}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
apiId string

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

The string representation of this ApiName with pattern projects/{project}/locations/global/apis/{api}.

FormatProjectApi(string, string)

public static string FormatProjectApi(string projectId, string apiId)

Formats the IDs into the string representation of this ApiName with pattern projects/{project}/locations/global/apis/{api}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
apiId string

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

The string representation of this ApiName with pattern projects/{project}/locations/global/apis/{api}.

FromProjectApi(string, string)

public static ApiName FromProjectApi(string projectId, string apiId)

Creates a ApiName with the pattern projects/{project}/locations/global/apis/{api}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
apiId string

The Api ID. Must not be null or empty.
Returns
Type Description
ApiName

A new instance of ApiName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApiName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApiName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
apiName string

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

The parsed ApiName if successful.
Remarks

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

  • projects/{project}/locations/global/apis/{api}

Parse(string, bool)

public static ApiName Parse(string apiName, bool allowUnparsed)

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

Parameters
Name Description
apiName 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
ApiName

The parsed ApiName if successful.
Remarks

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

  • projects/{project}/locations/global/apis/{api}
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 ApiName)

public static bool TryParse(string apiName, out ApiName result)

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

Parameters
Name Description
apiName string

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

When this method returns, the parsed ApiName, 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/global/apis/{api}

TryParse(string, bool, out ApiName)

public static bool TryParse(string apiName, bool allowUnparsed, out ApiName result)

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

Parameters
Name Description
apiName 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 ApiName

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

Operators

operator ==(ApiName, ApiName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ApiName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ApiName

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

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.