Class PrivateConnectionName (2.0.0) 

public sealed class PrivateConnectionName : IResourceName, IEquatable<PrivateConnectionName>

Resource name for the PrivateConnection resource.

Inheritance

Object > PrivateConnectionName

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

PrivateConnectionName(String, String, String)

public PrivateConnectionName(string projectId, string locationId, string privateConnectionId)

Constructs a new instance of a PrivateConnectionName class from the component parts of pattern projects/{project}/locations/{location}/privateConnections/{private_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.
privateConnectionId String

The PrivateConnection 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
Boolean

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

PrivateConnectionId

public string PrivateConnectionId { get; }

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

The PrivateConnectionName.ResourceNameType of the contained resource name.

Property Value
Type Description
PrivateConnectionName.ResourceNameType

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

Formats the IDs into the string representation of this PrivateConnectionName with pattern projects/{project}/locations/{location}/privateConnections/{private_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.
privateConnectionId String

The PrivateConnection ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this PrivateConnectionName with pattern projects/{project}/locations/{location}/privateConnections/{private_connection}.

FormatProjectLocationPrivateConnection(String, String, String)

public static string FormatProjectLocationPrivateConnection(string projectId, string locationId, string privateConnectionId)

Formats the IDs into the string representation of this PrivateConnectionName with pattern projects/{project}/locations/{location}/privateConnections/{private_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.
privateConnectionId String

The PrivateConnection ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this PrivateConnectionName with pattern projects/{project}/locations/{location}/privateConnections/{private_connection}.

FromProjectLocationPrivateConnection(String, String, String)

public static PrivateConnectionName FromProjectLocationPrivateConnection(string projectId, string locationId, string privateConnectionId)

Creates a PrivateConnectionName with the pattern projects/{project}/locations/{location}/privateConnections/{private_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.
privateConnectionId String

The PrivateConnection ID. Must not be null or empty.
Returns
Type Description
PrivateConnectionName

A new instance of PrivateConnectionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PrivateConnectionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PrivateConnectionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of PrivateConnectionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static PrivateConnectionName Parse(string privateConnectionName)

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

Parameter
Name Description
privateConnectionName String

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

The parsed PrivateConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateConnections/{private_connection}

Parse(String, Boolean)

public static PrivateConnectionName Parse(string privateConnectionName, bool allowUnparsed)

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

Parameters
Name Description
privateConnectionName String

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

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
PrivateConnectionName

The parsed PrivateConnectionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/privateConnections/{private_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 PrivateConnectionName)

public static bool TryParse(string privateConnectionName, out PrivateConnectionName result)

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

Parameters
Name Description
privateConnectionName String

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

When this method returns, the parsed PrivateConnectionName, or null if parsing failed.
Returns
Type Description
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}/privateConnections/{private_connection}

TryParse(String, Boolean, out PrivateConnectionName)

public static bool TryParse(string privateConnectionName, bool allowUnparsed, out PrivateConnectionName result)

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

Parameters
Name Description
privateConnectionName String

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

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 PrivateConnectionName

When this method returns, the parsed PrivateConnectionName, or null if parsing failed.
Returns
Type Description
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}/privateConnections/{private_connection}
Or may be in any format if allowUnparsed is true.

Operators

Equality(PrivateConnectionName, PrivateConnectionName)

public static bool operator ==(PrivateConnectionName a, PrivateConnectionName b)
Parameters
Name Description
a PrivateConnectionName
b PrivateConnectionName
Returns
Type Description
Boolean

Inequality(PrivateConnectionName, PrivateConnectionName)

public static bool operator !=(PrivateConnectionName a, PrivateConnectionName b)
Parameters
Name Description
a PrivateConnectionName
b PrivateConnectionName
Returns
Type Description
Boolean