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

public sealed class AttributeName : IResourceName, IEquatable<AttributeName>

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

Resource name for the Attribute resource.

Inheritance

object > AttributeName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

AttributeName(string, string, string)

public AttributeName(string projectId, string locationId, string attributeId)

Constructs a new instance of a AttributeName class from the component parts of pattern projects/{project}/locations/{location}/attributes/{attribute}

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

The Attribute ID. Must not be null or empty.

Properties

AttributeId

public string AttributeId { get; }

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

The AttributeName.ResourceNameType of the contained resource name.

Property Value
Type Description
AttributeNameResourceNameType

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

Formats the IDs into the string representation of this AttributeName with pattern projects/{project}/locations/{location}/attributes/{attribute}.

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

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

The string representation of this AttributeName with pattern projects/{project}/locations/{location}/attributes/{attribute}.

FormatProjectLocationAttribute(string, string, string)

public static string FormatProjectLocationAttribute(string projectId, string locationId, string attributeId)

Formats the IDs into the string representation of this AttributeName with pattern projects/{project}/locations/{location}/attributes/{attribute}.

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

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

The string representation of this AttributeName with pattern projects/{project}/locations/{location}/attributes/{attribute}.

FromProjectLocationAttribute(string, string, string)

public static AttributeName FromProjectLocationAttribute(string projectId, string locationId, string attributeId)

Creates a AttributeName with the pattern projects/{project}/locations/{location}/attributes/{attribute}.

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

The Attribute ID. Must not be null or empty.
Returns
Type Description
AttributeName

A new instance of AttributeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AttributeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AttributeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
attributeName string

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

The parsed AttributeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/attributes/{attribute}

Parse(string, bool)

public static AttributeName Parse(string attributeName, bool allowUnparsed)

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

Parameters
Name Description
attributeName 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
AttributeName

The parsed AttributeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/attributes/{attribute}
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 AttributeName)

public static bool TryParse(string attributeName, out AttributeName result)

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

Parameters
Name Description
attributeName string

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

When this method returns, the parsed AttributeName, 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}/attributes/{attribute}

TryParse(string, bool, out AttributeName)

public static bool TryParse(string attributeName, bool allowUnparsed, out AttributeName result)

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

Parameters
Name Description
attributeName 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 AttributeName

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

Operators

operator ==(AttributeName, AttributeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AttributeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AttributeName

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

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.