Cloud API Registry v1 API - Class ApiNamespaceName (1.0.0-beta01) 

public sealed class ApiNamespaceName : IResourceName, IEquatable<ApiNamespaceName>

Reference documentation and code samples for the Cloud API Registry v1 API class ApiNamespaceName.

Resource name for the ApiNamespace resource.

Inheritance

object > ApiNamespaceName

Namespace

Google.Cloud.ApiRegistry.V1

Assembly

Google.Cloud.ApiRegistry.V1.dll

Constructors

ApiNamespaceName(string, string, string)

public ApiNamespaceName(string projectId, string locationId, string apiNamespaceId)

Constructs a new instance of a ApiNamespaceName class from the component parts of pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}

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.
apiNamespaceId string

The ApiNamespace ID. Must not be null or empty.

Properties

ApiNamespaceId

public string ApiNamespaceId { get; }

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

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

The ApiNamespaceName.ResourceNameType of the contained resource name.

Property Value
Type Description
ApiNamespaceNameResourceNameType

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 locationId, string apiNamespaceId)

Formats the IDs into the string representation of this ApiNamespaceName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}.

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.
apiNamespaceId string

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

The string representation of this ApiNamespaceName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}.

FormatProjectLocationApiNamespace(string, string, string)

public static string FormatProjectLocationApiNamespace(string projectId, string locationId, string apiNamespaceId)

Formats the IDs into the string representation of this ApiNamespaceName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}.

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.
apiNamespaceId string

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

The string representation of this ApiNamespaceName with pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}.

FromProjectLocationApiNamespace(string, string, string)

public static ApiNamespaceName FromProjectLocationApiNamespace(string projectId, string locationId, string apiNamespaceId)

Creates a ApiNamespaceName with the pattern projects/{project}/locations/{location}/apiNamespaces/{api_namespace}.

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.
apiNamespaceId string

The ApiNamespace ID. Must not be null or empty.
Returns
Type Description
ApiNamespaceName

A new instance of ApiNamespaceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApiNamespaceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApiNamespaceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
apiNamespaceName string

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

The parsed ApiNamespaceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apiNamespaces/{api_namespace}

Parse(string, bool)

public static ApiNamespaceName Parse(string apiNamespaceName, bool allowUnparsed)

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

Parameters
Name Description
apiNamespaceName 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
ApiNamespaceName

The parsed ApiNamespaceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apiNamespaces/{api_namespace}
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 ApiNamespaceName)

public static bool TryParse(string apiNamespaceName, out ApiNamespaceName result)

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

Parameters
Name Description
apiNamespaceName string

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

When this method returns, the parsed ApiNamespaceName, 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}/apiNamespaces/{api_namespace}

TryParse(string, bool, out ApiNamespaceName)

public static bool TryParse(string apiNamespaceName, bool allowUnparsed, out ApiNamespaceName result)

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

Parameters
Name Description
apiNamespaceName 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 ApiNamespaceName

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

Operators

operator ==(ApiNamespaceName, ApiNamespaceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ApiNamespaceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ApiNamespaceName

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

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.