API hub v1 API - Class ExtensionName (1.0.0-beta01) 

public sealed class ExtensionName : IResourceName, IEquatable<ExtensionName>

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

Resource name for the Extension resource.

Inheritance

object > ExtensionName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ExtensionName(string, string, string)

public ExtensionName(string projectId, string locationId, string extensionId)

Constructs a new instance of a ExtensionName class from the component parts of pattern projects/{project}/locations/{location}/extensions/{extension}

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

The Extension ID. Must not be null or empty.

Properties

ExtensionId

public string ExtensionId { get; }

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

The ExtensionName.ResourceNameType of the contained resource name.

Property Value
Type Description
ExtensionNameResourceNameType

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

Formats the IDs into the string representation of this ExtensionName with pattern projects/{project}/locations/{location}/extensions/{extension}.

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

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

The string representation of this ExtensionName with pattern projects/{project}/locations/{location}/extensions/{extension}.

FormatProjectLocationExtension(string, string, string)

public static string FormatProjectLocationExtension(string projectId, string locationId, string extensionId)

Formats the IDs into the string representation of this ExtensionName with pattern projects/{project}/locations/{location}/extensions/{extension}.

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

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

The string representation of this ExtensionName with pattern projects/{project}/locations/{location}/extensions/{extension}.

FromProjectLocationExtension(string, string, string)

public static ExtensionName FromProjectLocationExtension(string projectId, string locationId, string extensionId)

Creates a ExtensionName with the pattern projects/{project}/locations/{location}/extensions/{extension}.

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

The Extension ID. Must not be null or empty.
Returns
Type Description
ExtensionName

A new instance of ExtensionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ExtensionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExtensionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
extensionName string

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

The parsed ExtensionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/extensions/{extension}

Parse(string, bool)

public static ExtensionName Parse(string extensionName, bool allowUnparsed)

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

Parameters
Name Description
extensionName 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
ExtensionName

The parsed ExtensionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/extensions/{extension}
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 ExtensionName)

public static bool TryParse(string extensionName, out ExtensionName result)

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

Parameters
Name Description
extensionName string

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

When this method returns, the parsed ExtensionName, 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}/extensions/{extension}

TryParse(string, bool, out ExtensionName)

public static bool TryParse(string extensionName, bool allowUnparsed, out ExtensionName result)

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

Parameters
Name Description
extensionName 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 ExtensionName

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

Operators

operator ==(ExtensionName, ExtensionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ExtensionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ExtensionName

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

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.