API hub v1 API - Class DefinitionName (1.0.0-beta02) 

public sealed class DefinitionName : IResourceName, IEquatable<DefinitionName>

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

Resource name for the Definition resource.

Inheritance

object > DefinitionName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

DefinitionName(string, string, string, string, string)

public DefinitionName(string projectId, string locationId, string apiId, string versionId, string definitionId)

Constructs a new instance of a DefinitionName class from the component parts of pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

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

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

DefinitionId

public string DefinitionId { get; }

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

The DefinitionName.ResourceNameType of the contained resource name.

Property Value
Type Description
DefinitionNameResourceNameType

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

Formats the IDs into the string representation of this DefinitionName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}.

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

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

The string representation of this DefinitionName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}.

FormatProjectLocationApiVersionDefinition(string, string, string, string, string)

public static string FormatProjectLocationApiVersionDefinition(string projectId, string locationId, string apiId, string versionId, string definitionId)

Formats the IDs into the string representation of this DefinitionName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}.

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

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

The string representation of this DefinitionName with pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}.

FromProjectLocationApiVersionDefinition(string, string, string, string, string)

public static DefinitionName FromProjectLocationApiVersionDefinition(string projectId, string locationId, string apiId, string versionId, string definitionId)

Creates a DefinitionName with the pattern projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}.

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

The Definition ID. Must not be null or empty.
Returns
Type Description
DefinitionName

A new instance of DefinitionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DefinitionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DefinitionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
definitionName string

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

The parsed DefinitionName 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}/definitions/{definition}

Parse(string, bool)

public static DefinitionName Parse(string definitionName, bool allowUnparsed)

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

Parameters
Name Description
definitionName 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
DefinitionName

The parsed DefinitionName 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}/definitions/{definition}
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 DefinitionName)

public static bool TryParse(string definitionName, out DefinitionName result)

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

Parameters
Name Description
definitionName string

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

When this method returns, the parsed DefinitionName, 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}/definitions/{definition}

TryParse(string, bool, out DefinitionName)

public static bool TryParse(string definitionName, bool allowUnparsed, out DefinitionName result)

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

Parameters
Name Description
definitionName 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 DefinitionName

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

Operators

operator ==(DefinitionName, DefinitionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DefinitionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DefinitionName

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

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.