Class ConnectionProfileName (2.0.0) 

public sealed class ConnectionProfileName : IResourceName, IEquatable<ConnectionProfileName>

Resource name for the ConnectionProfile resource.

Inheritance

Object > ConnectionProfileName

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

ConnectionProfileName(String, String, String)

public ConnectionProfileName(string projectId, string locationId, string connectionProfileId)

Constructs a new instance of a ConnectionProfileName class from the component parts of pattern projects/{project}/locations/{location}/connectionProfiles/{connection_profile}

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.
connectionProfileId String

The ConnectionProfile ID. Must not be null or empty.

Properties

ConnectionProfileId

public string ConnectionProfileId { get; }

The ConnectionProfile 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
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

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 ConnectionProfileName.ResourceNameType Type { get; }

The ConnectionProfileName.ResourceNameType of the contained resource name.

Property Value
Type Description
ConnectionProfileName.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 connectionProfileId)

Formats the IDs into the string representation of this ConnectionProfileName with pattern projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.

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.
connectionProfileId String

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

The string representation of this ConnectionProfileName with pattern projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.

FormatProjectLocationConnectionProfile(String, String, String)

public static string FormatProjectLocationConnectionProfile(string projectId, string locationId, string connectionProfileId)

Formats the IDs into the string representation of this ConnectionProfileName with pattern projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.

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.
connectionProfileId String

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

The string representation of this ConnectionProfileName with pattern projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.

FromProjectLocationConnectionProfile(String, String, String)

public static ConnectionProfileName FromProjectLocationConnectionProfile(string projectId, string locationId, string connectionProfileId)

Creates a ConnectionProfileName with the pattern projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.

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.
connectionProfileId String

The ConnectionProfile ID. Must not be null or empty.
Returns
Type Description
ConnectionProfileName

A new instance of ConnectionProfileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConnectionProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectionProfileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
connectionProfileName String

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

The parsed ConnectionProfileName if successful.
Remarks

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

  • projects/{project}/locations/{location}/connectionProfiles/{connection_profile}

Parse(String, Boolean)

public static ConnectionProfileName Parse(string connectionProfileName, bool allowUnparsed)

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

Parameters
Name Description
connectionProfileName 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
ConnectionProfileName

The parsed ConnectionProfileName if successful.
Remarks

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

  • projects/{project}/locations/{location}/connectionProfiles/{connection_profile}
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 ConnectionProfileName)

public static bool TryParse(string connectionProfileName, out ConnectionProfileName result)

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

Parameters
Name Description
connectionProfileName String

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

When this method returns, the parsed ConnectionProfileName, 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}/connectionProfiles/{connection_profile}

TryParse(String, Boolean, out ConnectionProfileName)

public static bool TryParse(string connectionProfileName, bool allowUnparsed, out ConnectionProfileName result)

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

Parameters
Name Description
connectionProfileName 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 ConnectionProfileName

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

Operators

Equality(ConnectionProfileName, ConnectionProfileName)

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

Inequality(ConnectionProfileName, ConnectionProfileName)

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