AlloyDB v1 API - Class ConnectionInfoName (1.4.0)

public sealed class ConnectionInfoName : IResourceName, IEquatable<ConnectionInfoName>

Reference documentation and code samples for the AlloyDB v1 API class ConnectionInfoName.

Resource name for the ConnectionInfo resource.

Inheritance

object > ConnectionInfoName

Implements

IResourceName, IEquatable ConnectionInfoName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

ConnectionInfoName(string, string, string, string)

public ConnectionInfoName(string projectId, string locationId, string clusterId, string instanceId)

Constructs a new instance of a ConnectionInfoName class from the component parts of pattern projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.

Properties

ClusterId

public string ClusterId { get; }

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

Property Value
Type	Description
`string`

InstanceId

public string InstanceId { get; }

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

The ConnectionInfoName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ConnectionInfoNameResourceNameType`

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, string)

public static string Format(string projectId, string locationId, string clusterId, string instanceId)

Formats the IDs into the string representation of this ConnectionInfoName with pattern projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo.

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ConnectionInfoName with pattern `projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo`.

FormatProjectLocationClusterInstance(string, string, string, string)

public static string FormatProjectLocationClusterInstance(string projectId, string locationId, string clusterId, string instanceId)

Formats the IDs into the string representation of this ConnectionInfoName with pattern projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo.

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ConnectionInfoName with pattern `projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo`.

FromProjectLocationClusterInstance(string, string, string, string)

public static ConnectionInfoName FromProjectLocationClusterInstance(string projectId, string locationId, string clusterId, string instanceId)

Creates a ConnectionInfoName with the pattern projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo.

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ConnectionInfoName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectionInfoName containing an unparsed resource name.

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

Returns
Type	Description
`ConnectionInfoName`	A new instance of ConnectionInfoName 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 ConnectionInfoName Parse(string connectionInfoName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo

Parse(string, bool)

public static ConnectionInfoName Parse(string connectionInfoName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}/connectionInfo

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

public static bool TryParse(string connectionInfoName, out ConnectionInfoName result)

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

Parameters
Name	Description
`connectionInfoName`	`string` The resource name in string form. Must not be `null`.
`result`	`ConnectionInfoName` When this method returns, the parsed ConnectionInfoName, 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}/clusters/{cluster}/instances/{instance}/connectionInfo

TryParse(string, bool, out ConnectionInfoName)

public static bool TryParse(string connectionInfoName, bool allowUnparsed, out ConnectionInfoName result)

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

Parameters
Name	Description
`connectionInfoName`	`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`	`ConnectionInfoName` When this method returns, the parsed ConnectionInfoName, 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}/clusters/{cluster}/instances/{instance}/connectionInfo

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConnectionInfoName, ConnectionInfoName)

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

Parameters
Name	Description
`a`	`ConnectionInfoName`
`b`	`ConnectionInfoName`

Returns
Type	Description
`bool`

operator !=(ConnectionInfoName, ConnectionInfoName)

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

Parameters
Name	Description
`a`	`ConnectionInfoName`
`b`	`ConnectionInfoName`

Returns
Type	Description
`bool`