Managed Service for Apache Kafka API v1 API - Class ConnectClusterName (1.0.0-beta05) 

public sealed class ConnectClusterName : IResourceName, IEquatable<ConnectClusterName>

Reference documentation and code samples for the Managed Service for Apache Kafka API v1 API class ConnectClusterName.

Resource name for the ConnectCluster resource.

Inheritance

object > ConnectClusterName

Namespace

Google.Cloud.ManagedKafka.V1

Assembly

Google.Cloud.ManagedKafka.V1.dll

Constructors

ConnectClusterName(string, string, string)

public ConnectClusterName(string projectId, string locationId, string connectClusterId)

Constructs a new instance of a ConnectClusterName class from the component parts of pattern projects/{project}/locations/{location}/connectClusters/{connect_cluster}

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

The ConnectCluster ID. Must not be null or empty.

Properties

ConnectClusterId

public string ConnectClusterId { get; }

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

The ConnectClusterName.ResourceNameType of the contained resource name.

Property Value
Type Description
ConnectClusterNameResourceNameType

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

Formats the IDs into the string representation of this ConnectClusterName with pattern projects/{project}/locations/{location}/connectClusters/{connect_cluster}.

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

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

The string representation of this ConnectClusterName with pattern projects/{project}/locations/{location}/connectClusters/{connect_cluster}.

FormatProjectLocationConnectCluster(string, string, string)

public static string FormatProjectLocationConnectCluster(string projectId, string locationId, string connectClusterId)

Formats the IDs into the string representation of this ConnectClusterName with pattern projects/{project}/locations/{location}/connectClusters/{connect_cluster}.

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

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

The string representation of this ConnectClusterName with pattern projects/{project}/locations/{location}/connectClusters/{connect_cluster}.

FromProjectLocationConnectCluster(string, string, string)

public static ConnectClusterName FromProjectLocationConnectCluster(string projectId, string locationId, string connectClusterId)

Creates a ConnectClusterName with the pattern projects/{project}/locations/{location}/connectClusters/{connect_cluster}.

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

The ConnectCluster ID. Must not be null or empty.
Returns
Type Description
ConnectClusterName

A new instance of ConnectClusterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConnectClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConnectClusterName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
connectClusterName string

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

The parsed ConnectClusterName if successful.
Remarks

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

  • projects/{project}/locations/{location}/connectClusters/{connect_cluster}

Parse(string, bool)

public static ConnectClusterName Parse(string connectClusterName, bool allowUnparsed)

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

Parameters
Name Description
connectClusterName 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
ConnectClusterName

The parsed ConnectClusterName if successful.
Remarks

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

  • projects/{project}/locations/{location}/connectClusters/{connect_cluster}
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 ConnectClusterName)

public static bool TryParse(string connectClusterName, out ConnectClusterName result)

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

Parameters
Name Description
connectClusterName string

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

When this method returns, the parsed ConnectClusterName, 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}/connectClusters/{connect_cluster}

TryParse(string, bool, out ConnectClusterName)

public static bool TryParse(string connectClusterName, bool allowUnparsed, out ConnectClusterName result)

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

Parameters
Name Description
connectClusterName 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 ConnectClusterName

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

Operators

operator ==(ConnectClusterName, ConnectClusterName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ConnectClusterName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ConnectClusterName

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

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.