API hub v1 API - Class ApiHubInstanceName (1.1.0) 

public sealed class ApiHubInstanceName : IResourceName, IEquatable<ApiHubInstanceName>

Reference documentation and code samples for the API hub v1 API class ApiHubInstanceName.

Resource name for the ApiHubInstance resource.

Inheritance

object > ApiHubInstanceName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ApiHubInstanceName(string, string, string)

public ApiHubInstanceName(string projectId, string locationId, string apiHubInstanceId)

Constructs a new instance of a ApiHubInstanceName class from the component parts of pattern projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}

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

The ApiHubInstance ID. Must not be null or empty.

Properties

ApiHubInstanceId

public string ApiHubInstanceId { get; }

The ApiHubInstance 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 ApiHubInstanceName.ResourceNameType Type { get; }

The ApiHubInstanceName.ResourceNameType of the contained resource name.

Property Value
Type Description
ApiHubInstanceNameResourceNameType

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 apiHubInstanceId)

Formats the IDs into the string representation of this ApiHubInstanceName with pattern projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}.

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

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

The string representation of this ApiHubInstanceName with pattern projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}.

FormatProjectLocationApiHubInstance(string, string, string)

public static string FormatProjectLocationApiHubInstance(string projectId, string locationId, string apiHubInstanceId)

Formats the IDs into the string representation of this ApiHubInstanceName with pattern projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}.

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

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

The string representation of this ApiHubInstanceName with pattern projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}.

FromProjectLocationApiHubInstance(string, string, string)

public static ApiHubInstanceName FromProjectLocationApiHubInstance(string projectId, string locationId, string apiHubInstanceId)

Creates a ApiHubInstanceName with the pattern projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}.

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

The ApiHubInstance ID. Must not be null or empty.
Returns
Type Description
ApiHubInstanceName

A new instance of ApiHubInstanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ApiHubInstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ApiHubInstanceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
apiHubInstanceName string

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

The parsed ApiHubInstanceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}

Parse(string, bool)

public static ApiHubInstanceName Parse(string apiHubInstanceName, bool allowUnparsed)

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

Parameters
Name Description
apiHubInstanceName 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
ApiHubInstanceName

The parsed ApiHubInstanceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apiHubInstances/{api_hub_instance}
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 ApiHubInstanceName)

public static bool TryParse(string apiHubInstanceName, out ApiHubInstanceName result)

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

Parameters
Name Description
apiHubInstanceName string

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

When this method returns, the parsed ApiHubInstanceName, 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}/apiHubInstances/{api_hub_instance}

TryParse(string, bool, out ApiHubInstanceName)

public static bool TryParse(string apiHubInstanceName, bool allowUnparsed, out ApiHubInstanceName result)

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

Parameters
Name Description
apiHubInstanceName 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 ApiHubInstanceName

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

Operators

operator ==(ApiHubInstanceName, ApiHubInstanceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ApiHubInstanceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ApiHubInstanceName

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

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.