Network Services v1 API - Class ServiceBindingName (1.0.0-beta01)

public sealed class ServiceBindingName : IResourceName, IEquatable<ServiceBindingName>

Reference documentation and code samples for the Network Services v1 API class ServiceBindingName.

Resource name for the ServiceBinding resource.

Inheritance

object > ServiceBindingName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

ServiceBindingName(string, string, string)

public ServiceBindingName(string projectId, string locationId, string serviceBindingId)

Constructs a new instance of a ServiceBindingName class from the component parts of pattern projects/{project}/locations/{location}/serviceBindings/{service_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.

serviceBindingId string

The ServiceBinding ID. Must not be null or empty.

Properties

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

ServiceBindingId

public string ServiceBindingId { get; }

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

Property Value
Type Description
string

Type

public ServiceBindingName.ResourceNameType Type { get; }

The ServiceBindingName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServiceBindingNameResourceNameType

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

Formats the IDs into the string representation of this ServiceBindingName with pattern projects/{project}/locations/{location}/serviceBindings/{service_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.

serviceBindingId string

The ServiceBinding ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServiceBindingName with pattern projects/{project}/locations/{location}/serviceBindings/{service_binding}.

FormatProjectLocationServiceBinding(string, string, string)

public static string FormatProjectLocationServiceBinding(string projectId, string locationId, string serviceBindingId)

Formats the IDs into the string representation of this ServiceBindingName with pattern projects/{project}/locations/{location}/serviceBindings/{service_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.

serviceBindingId string

The ServiceBinding ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServiceBindingName with pattern projects/{project}/locations/{location}/serviceBindings/{service_binding}.

FromProjectLocationServiceBinding(string, string, string)

public static ServiceBindingName FromProjectLocationServiceBinding(string projectId, string locationId, string serviceBindingId)

Creates a ServiceBindingName with the pattern projects/{project}/locations/{location}/serviceBindings/{service_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.

serviceBindingId string

The ServiceBinding ID. Must not be null or empty.

Returns
Type Description
ServiceBindingName

A new instance of ServiceBindingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceBindingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceBindingName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ServiceBindingName

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

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

Parameter
Name Description
serviceBindingName string

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

Returns
Type Description
ServiceBindingName

The parsed ServiceBindingName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serviceBindings/{service_binding}

Parse(string, bool)

public static ServiceBindingName Parse(string serviceBindingName, bool allowUnparsed)

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

Parameters
Name Description
serviceBindingName 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
ServiceBindingName

The parsed ServiceBindingName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serviceBindings/{service_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

TryParse(string, out ServiceBindingName)

public static bool TryParse(string serviceBindingName, out ServiceBindingName result)

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

Parameters
Name Description
serviceBindingName string

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

result ServiceBindingName

When this method returns, the parsed ServiceBindingName, 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}/serviceBindings/{service_binding}

TryParse(string, bool, out ServiceBindingName)

public static bool TryParse(string serviceBindingName, bool allowUnparsed, out ServiceBindingName result)

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

Parameters
Name Description
serviceBindingName 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 ServiceBindingName

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

Operators

operator ==(ServiceBindingName, ServiceBindingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServiceBindingName

The first resource name to compare, or null.

b ServiceBindingName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServiceBindingName

The first resource name to compare, or null.

b ServiceBindingName

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.