Class ApiName

public sealed class ApiName : IResourceName, IEquatable<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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringapiId

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

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

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

The ApiName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ApiName.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)

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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringapiId

The Api ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringapiId

The Api ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringapiId

The Api ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ApiName

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

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

Parameter
TypeNameDescription
StringapiName

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

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

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
TypeNameDescription
StringapiName

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

BooleanallowUnparsed

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
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
TypeDescription
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
TypeNameDescription
StringapiName

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

ApiNameresult

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

TryParse(String, Boolean, 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
TypeNameDescription
StringapiName

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

BooleanallowUnparsed

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.

ApiNameresult

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

Operators

Equality(ApiName, ApiName)

public static bool operator ==(ApiName a, ApiName b)
Parameters
TypeNameDescription
ApiNamea
ApiNameb
Returns
TypeDescription
Boolean

Inequality(ApiName, ApiName)

public static bool operator !=(ApiName a, ApiName b)
Parameters
TypeNameDescription
ApiNamea
ApiNameb
Returns
TypeDescription
Boolean

Implements