API hub v1 API - Class ExternalApiName (1.2.0) 

public sealed class ExternalApiName : IResourceName, IEquatable<ExternalApiName>

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

Resource name for the ExternalApi resource.

Inheritance

object > ExternalApiName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ExternalApiName(string, string, string)

public ExternalApiName(string projectId, string locationId, string externalApiId)

Constructs a new instance of a ExternalApiName class from the component parts of pattern projects/{project}/locations/{location}/externalApis/{external_api}

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

The ExternalApi ID. Must not be null or empty.

Properties

ExternalApiId

public string ExternalApiId { get; }

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

The ExternalApiName.ResourceNameType of the contained resource name.

Property Value
Type Description
ExternalApiNameResourceNameType

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

Formats the IDs into the string representation of this ExternalApiName with pattern projects/{project}/locations/{location}/externalApis/{external_api}.

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

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

The string representation of this ExternalApiName with pattern projects/{project}/locations/{location}/externalApis/{external_api}.

FormatProjectLocationExternalApi(string, string, string)

public static string FormatProjectLocationExternalApi(string projectId, string locationId, string externalApiId)

Formats the IDs into the string representation of this ExternalApiName with pattern projects/{project}/locations/{location}/externalApis/{external_api}.

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

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

The string representation of this ExternalApiName with pattern projects/{project}/locations/{location}/externalApis/{external_api}.

FromProjectLocationExternalApi(string, string, string)

public static ExternalApiName FromProjectLocationExternalApi(string projectId, string locationId, string externalApiId)

Creates a ExternalApiName with the pattern projects/{project}/locations/{location}/externalApis/{external_api}.

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

The ExternalApi ID. Must not be null or empty.
Returns
Type Description
ExternalApiName

A new instance of ExternalApiName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ExternalApiName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExternalApiName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
externalApiName string

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

The parsed ExternalApiName if successful.
Remarks

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

  • projects/{project}/locations/{location}/externalApis/{external_api}

Parse(string, bool)

public static ExternalApiName Parse(string externalApiName, bool allowUnparsed)

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

Parameters
Name Description
externalApiName 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
ExternalApiName

The parsed ExternalApiName if successful.
Remarks

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

  • projects/{project}/locations/{location}/externalApis/{external_api}
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 ExternalApiName)

public static bool TryParse(string externalApiName, out ExternalApiName result)

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

Parameters
Name Description
externalApiName string

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

When this method returns, the parsed ExternalApiName, 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}/externalApis/{external_api}

TryParse(string, bool, out ExternalApiName)

public static bool TryParse(string externalApiName, bool allowUnparsed, out ExternalApiName result)

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

Parameters
Name Description
externalApiName 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 ExternalApiName

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

Operators

operator ==(ExternalApiName, ExternalApiName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ExternalApiName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ExternalApiName

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

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.