Integration Connectors v1 API - Class ConnectionName (1.2.0) 

public sealed class ConnectionName : IResourceName, IEquatable<ConnectionName>

Reference documentation and code samples for the Integration Connectors v1 API class ConnectionName.

Resource name for the Connection resource.

Inheritance

object > ConnectionName

Namespace

Google.Cloud.Connectors.V1

Assembly

Google.Cloud.Connectors.V1.dll

Constructors

ConnectionName(string, string, string)

public ConnectionName(string projectId, string locationId, string connectionId)

Constructs a new instance of a ConnectionName class from the component parts of pattern projects/{project}/locations/{location}/connections/{connection}

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

The Connection ID. Must not be null or empty.

Properties

ConnectionId

public string ConnectionId { get; }

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

The ConnectionName.ResourceNameType of the contained resource name.

Property Value
Type Description
ConnectionNameResourceNameType

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

Formats the IDs into the string representation of this ConnectionName with pattern projects/{project}/locations/{location}/connections/{connection}.

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

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

The string representation of this ConnectionName with pattern projects/{project}/locations/{location}/connections/{connection}.

FormatProjectLocationConnection(string, string, string)

public static string FormatProjectLocationConnection(string projectId, string locationId, string connectionId)

Formats the IDs into the string representation of this ConnectionName with pattern projects/{project}/locations/{location}/connections/{connection}.

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

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

The string representation of this ConnectionName with pattern projects/{project}/locations/{location}/connections/{connection}.

FromProjectLocationConnection(string, string, string)

public static ConnectionName FromProjectLocationConnection(string projectId, string locationId, string connectionId)

Creates a ConnectionName with the pattern projects/{project}/locations/{location}/connections/{connection}.

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

The Connection ID. Must not be null or empty.
Returns
Type Description
ConnectionName

A new instance of ConnectionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConnectionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
connectionName string

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

The parsed ConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/connections/{connection}

Parse(string, bool)

public static ConnectionName Parse(string connectionName, bool allowUnparsed)

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

Parameters
Name Description
connectionName 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
ConnectionName

The parsed ConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/connections/{connection}
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 ConnectionName)

public static bool TryParse(string connectionName, out ConnectionName result)

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

Parameters
Name Description
connectionName string

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

When this method returns, the parsed ConnectionName, 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}/connections/{connection}

TryParse(string, bool, out ConnectionName)

public static bool TryParse(string connectionName, bool allowUnparsed, out ConnectionName result)

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

Parameters
Name Description
connectionName 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 ConnectionName

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

Operators

operator ==(ConnectionName, ConnectionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ConnectionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ConnectionName

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

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.