Agent Registry v1 API - Class BindingName (1.0.0-beta01)

public sealed class BindingName : IResourceName, IEquatable<BindingName>

Reference documentation and code samples for the Agent Registry v1 API class BindingName.

Resource name for the Binding resource.

Inheritance

object > BindingName

Implements

IResourceName, IEquatableBindingName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AgentRegistry.V1

Assembly

Google.Cloud.AgentRegistry.V1.dll

Constructors

BindingName(string, string, string)

public BindingName(string projectId, string locationId, string bindingId)

Constructs a new instance of a BindingName class from the component parts of pattern projects/{project}/locations/{location}/bindings/{binding}

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.
bindingId	string The Binding ID. Must not be null or empty.

Properties

BindingId

public string BindingId { get; }

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

The BindingName.ResourceNameType of the contained resource name.

Property Value
Type	Description
BindingNameResourceNameType

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

Formats the IDs into the string representation of this BindingName with pattern projects/{project}/locations/{location}/bindings/{binding}.

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.
bindingId	string The Binding ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this BindingName with pattern projects/{project}/locations/{location}/bindings/{binding}.

FormatProjectLocationBinding(string, string, string)

public static string FormatProjectLocationBinding(string projectId, string locationId, string bindingId)

Formats the IDs into the string representation of this BindingName with pattern projects/{project}/locations/{location}/bindings/{binding}.

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.
bindingId	string The Binding ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this BindingName with pattern projects/{project}/locations/{location}/bindings/{binding}.

FromProjectLocationBinding(string, string, string)

public static BindingName FromProjectLocationBinding(string projectId, string locationId, string bindingId)

Creates a BindingName with the pattern projects/{project}/locations/{location}/bindings/{binding}.

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.
bindingId	string The Binding ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static BindingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BindingName containing an unparsed resource name.

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

Returns
Type	Description
BindingName	A new instance of BindingName 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 BindingName Parse(string bindingName)

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

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

Returns
Type	Description
BindingName	The parsed BindingName if successful.

Remarks

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

• projects/{project}/locations/{location}/bindings/{binding}

Parse(string, bool)

public static BindingName Parse(string bindingName, bool allowUnparsed)

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

Parameters
Name	Description
bindingName	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
BindingName	The parsed BindingName if successful.

Remarks

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

• projects/{project}/locations/{location}/bindings/{binding}

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

public static bool TryParse(string bindingName, out BindingName result)

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

Parameters
Name	Description
bindingName	string The resource name in string form. Must not be null.
result	BindingName When this method returns, the parsed BindingName, 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}/bindings/{binding}

TryParse(string, bool, out BindingName)

public static bool TryParse(string bindingName, bool allowUnparsed, out BindingName result)

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

Parameters
Name	Description
bindingName	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	BindingName When this method returns, the parsed BindingName, 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}/bindings/{binding}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BindingName, BindingName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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