Class ApiConfigName (2.0.0) 

public sealed class ApiConfigName : IResourceName, IEquatable<ApiConfigName>

Resource name for the ApiConfig resource.

Inheritance

Object > ApiConfigName

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
Boolean

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
ApiConfigName.ResourceNameType

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
Int32
Overrides

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

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 Boolean

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

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
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}/configs/{api_config}

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

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
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}/configs/{api_config}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ApiConfigName, ApiConfigName)

public static bool operator ==(ApiConfigName a, ApiConfigName b)
Parameters
Name Description
a ApiConfigName
b ApiConfigName
Returns
Type Description
Boolean

Inequality(ApiConfigName, ApiConfigName)

public static bool operator !=(ApiConfigName a, ApiConfigName b)
Parameters
Name Description
a ApiConfigName
b ApiConfigName
Returns
Type Description
Boolean