DataStream v1 API - Class ConnectionProfileName (2.3.0)

public sealed class ConnectionProfileName : IResourceName, IEquatable<ConnectionProfileName>

Reference documentation and code samples for the DataStream v1 API class ConnectionProfileName.

Resource name for the ConnectionProfile resource.

Inheritance

object > ConnectionProfileName

Implements

IResourceName, IEquatable ConnectionProfileName

Inherited Members

object.GetType()

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

The ConnectionProfileName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ConnectionProfileNameResourceNameType`

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
`int`

Overrides

object.GetHashCode()

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

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`	`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
`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

object.ToString()

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
`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}/connectionProfiles/{connection_profile}

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConnectionProfileName, ConnectionProfileName)

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

Parameters
Name	Description
`a`	`ConnectionProfileName`
`b`	`ConnectionProfileName`

Returns
Type	Description
`bool`

operator !=(ConnectionProfileName, ConnectionProfileName)

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

Parameters
Name	Description
`a`	`ConnectionProfileName`
`b`	`ConnectionProfileName`

Returns
Type	Description
`bool`