Class ConnectionName

public sealed class ConnectionName : IResourceName, IEquatable<ConnectionName>

Resource name for the Connection resource.

Inheritance

Object > ConnectionName

Namespace

Google.Cloud.BigQuery.Connection.V1

Assembly

Google.Cloud.BigQuery.Connection.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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringconnectionId

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public ConnectionName.ResourceNameType Type { get; }

The ConnectionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ConnectionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringconnectionId

The Connection ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringconnectionId

The Connection ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringconnectionId

The Connection ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ConnectionName

A new instance of ConnectionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ConnectionName Parse(string connectionName)

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

Parameter
TypeNameDescription
StringconnectionName

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

Returns
TypeDescription
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, Boolean)

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
TypeNameDescription
StringconnectionName

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

BooleanallowUnparsed

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
TypeDescription
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
TypeDescription
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
TypeNameDescription
StringconnectionName

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

ConnectionNameresult

When this method returns, the parsed ConnectionName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
TypeNameDescription
StringconnectionName

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

BooleanallowUnparsed

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.

ConnectionNameresult

When this method returns, the parsed ConnectionName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(ConnectionName, ConnectionName)

public static bool operator ==(ConnectionName a, ConnectionName b)
Parameters
TypeNameDescription
ConnectionNamea
ConnectionNameb
Returns
TypeDescription
Boolean

Inequality(ConnectionName, ConnectionName)

public static bool operator !=(ConnectionName a, ConnectionName b)
Parameters
TypeNameDescription
ConnectionNamea
ConnectionNameb
Returns
TypeDescription
Boolean

Implements