API Gateway v1 API - Class ApiConfigName (2.3.0)

public sealed class ApiConfigName : IResourceName, IEquatable<ApiConfigName>

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

Resource name for the ApiConfig resource.

Inheritance

object > ApiConfigName

Implements

IResourceName, IEquatable ApiConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

ApiConfigName(string, string, string)

public ApiConfigName(string projectId, string apiId, string apiConfigId)

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

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.
`apiConfigId`	`string` The `ApiConfig` ID. Must not be `null` or empty.

Properties

ApiConfigId

public string ApiConfigId { get; }

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

Property Value
Type	Description
`string`

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

The ApiConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ApiConfigNameResourceNameType`

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 apiId, string apiConfigId)

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

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.
`apiConfigId`	`string` The `ApiConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ApiConfigName with pattern `projects/{project}/locations/global/apis/{api}/configs/{api_config}`.

FormatProjectApiApiConfig(string, string, string)

public static string FormatProjectApiApiConfig(string projectId, string apiId, string apiConfigId)

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

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.
`apiConfigId`	`string` The `ApiConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ApiConfigName with pattern `projects/{project}/locations/global/apis/{api}/configs/{api_config}`.

FromProjectApiApiConfig(string, string, string)

public static ApiConfigName FromProjectApiApiConfig(string projectId, string apiId, string apiConfigId)

Creates a ApiConfigName with the pattern projects/{project}/locations/global/apis/{api}/configs/{api_config}.

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.
`apiConfigId`	`string` The `ApiConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`ApiConfigName`	A new instance of ApiConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApiConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApiConfigName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ApiConfigName`	A new instance of ApiConfigName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static ApiConfigName Parse(string apiConfigName)

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

Parameter
Name	Description
`apiConfigName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`ApiConfigName`	The parsed ApiConfigName if successful.

Remarks

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

projects/{project}/locations/global/apis/{api}/configs/{api_config}

Parse(string, bool)

public static ApiConfigName Parse(string apiConfigName, bool allowUnparsed)

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

Parameters
Name	Description
`apiConfigName`	`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
`ApiConfigName`	The parsed ApiConfigName if successful.

Remarks

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

projects/{project}/locations/global/apis/{api}/configs/{api_config}

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

object.ToString()

TryParse(string, out ApiConfigName)

public static bool TryParse(string apiConfigName, out ApiConfigName result)

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

Parameters
Name	Description
`apiConfigName`	`string` The resource name in string form. Must not be `null`.
`result`	`ApiConfigName` When this method returns, the parsed ApiConfigName, 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}/configs/{api_config}

TryParse(string, bool, out ApiConfigName)

public static bool TryParse(string apiConfigName, bool allowUnparsed, out ApiConfigName result)

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

Parameters
Name	Description
`apiConfigName`	`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`	`ApiConfigName` When this method returns, the parsed ApiConfigName, 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}/configs/{api_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ApiConfigName, ApiConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ApiConfigName` The first resource name to compare, or null.
`b`	`ApiConfigName` 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 !=(ApiConfigName, ApiConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ApiConfigName` The first resource name to compare, or null.
`b`	`ApiConfigName` 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.