API hub v1 API - Class SpecName (1.0.0)

public sealed class SpecName : IResourceName, IEquatable<SpecName>

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

Resource name for the Spec resource.

Inheritance

object > SpecName

Implements

IResourceName, IEquatable SpecName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

SpecName(string, string, string, string, string)

public SpecName(string projectId, string locationId, string apiId, string versionId, string specId)

Constructs a new instance of a SpecName class from the component parts of pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

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.
`apiId`	`string` The `Api` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.
`specId`	`string` The `Spec` ID. Must not be `null` or empty.

Properties

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
`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`

SpecId

public string SpecId { get; }

The Spec ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public SpecName.ResourceNameType Type { get; }

The SpecName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SpecNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

VersionId

public string VersionId { get; }

The Version ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string locationId, string apiId, string versionId, string specId)

Formats the IDs into the string representation of this SpecName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}.

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.
`apiId`	`string` The `Api` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.
`specId`	`string` The `Spec` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SpecName with pattern `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`.

FormatProjectLocationApiVersionSpec(string, string, string, string, string)

public static string FormatProjectLocationApiVersionSpec(string projectId, string locationId, string apiId, string versionId, string specId)

Formats the IDs into the string representation of this SpecName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}.

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.
`apiId`	`string` The `Api` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.
`specId`	`string` The `Spec` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SpecName with pattern `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`.

FromProjectLocationApiVersionSpec(string, string, string, string, string)

public static SpecName FromProjectLocationApiVersionSpec(string projectId, string locationId, string apiId, string versionId, string specId)

Creates a SpecName with the pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}.

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.
`apiId`	`string` The `Api` ID. Must not be `null` or empty.
`versionId`	`string` The `Version` ID. Must not be `null` or empty.
`specId`	`string` The `Spec` ID. Must not be `null` or empty.

Returns
Type	Description
`SpecName`	A new instance of SpecName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SpecName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SpecName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`SpecName`	A new instance of SpecName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static SpecName Parse(string specName)

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

Parameter
Name	Description
`specName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`SpecName`	The parsed SpecName if successful.

Remarks

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

projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

Parse(string, bool)

public static SpecName Parse(string specName, bool allowUnparsed)

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

Parameters
Name	Description
`specName`	`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
`SpecName`	The parsed SpecName if successful.

Remarks

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

projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

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

object.ToString()

TryParse(string, out SpecName)

public static bool TryParse(string specName, out SpecName result)

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

Parameters
Name	Description
`specName`	`string` The resource name in string form. Must not be `null`.
`result`	`SpecName` When this method returns, the parsed SpecName, 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}/apis/{api}/versions/{version}/specs/{spec}

TryParse(string, bool, out SpecName)

public static bool TryParse(string specName, bool allowUnparsed, out SpecName result)

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

Parameters
Name	Description
`specName`	`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`	`SpecName` When this method returns, the parsed SpecName, 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}/apis/{api}/versions/{version}/specs/{spec}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SpecName, SpecName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`SpecName` The first resource name to compare, or null.
`b`	`SpecName` 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 !=(SpecName, SpecName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`SpecName` The first resource name to compare, or null.
`b`	`SpecName` 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.