Managed Service for Apache Kafka API v1 API - Class ConsumerGroupName (1.0.0-beta01)

public sealed class ConsumerGroupName : IResourceName, IEquatable<ConsumerGroupName>

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

Resource name for the ConsumerGroup resource.

Inheritance

object > ConsumerGroupName

Implements

IResourceName, IEquatable ConsumerGroupName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ManagedKafka.V1

Assembly

Google.Cloud.ManagedKafka.V1.dll

Constructors

ConsumerGroupName(string, string, string, string)

public ConsumerGroupName(string projectId, string locationId, string clusterId, string consumerGroupId)

Constructs a new instance of a ConsumerGroupName class from the component parts of pattern projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`consumerGroupId`	`string` The `ConsumerGroup` ID. Must not be `null` or empty.

Properties

ClusterId

public string ClusterId { get; }

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

Property Value
Type	Description
`string`

ConsumerGroupId

public string ConsumerGroupId { get; }

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

The ConsumerGroupName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ConsumerGroupNameResourceNameType`

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

public static string Format(string projectId, string locationId, string clusterId, string consumerGroupId)

Formats the IDs into the string representation of this ConsumerGroupName with pattern projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}.

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`consumerGroupId`	`string` The `ConsumerGroup` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ConsumerGroupName with pattern `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}`.

FormatProjectLocationClusterConsumerGroup(string, string, string, string)

public static string FormatProjectLocationClusterConsumerGroup(string projectId, string locationId, string clusterId, string consumerGroupId)

Formats the IDs into the string representation of this ConsumerGroupName with pattern projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}.

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`consumerGroupId`	`string` The `ConsumerGroup` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ConsumerGroupName with pattern `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}`.

FromProjectLocationClusterConsumerGroup(string, string, string, string)

public static ConsumerGroupName FromProjectLocationClusterConsumerGroup(string projectId, string locationId, string clusterId, string consumerGroupId)

Creates a ConsumerGroupName with the pattern projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}.

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.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`consumerGroupId`	`string` The `ConsumerGroup` ID. Must not be `null` or empty.

Returns
Type	Description
`ConsumerGroupName`	A new instance of ConsumerGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConsumerGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConsumerGroupName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ConsumerGroupName`	A new instance of ConsumerGroupName 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 ConsumerGroupName Parse(string consumerGroupName)

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

Parameter
Name	Description
`consumerGroupName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`ConsumerGroupName`	The parsed ConsumerGroupName if successful.

Remarks

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

projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}

Parse(string, bool)

public static ConsumerGroupName Parse(string consumerGroupName, bool allowUnparsed)

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

Parameters
Name	Description
`consumerGroupName`	`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
`ConsumerGroupName`	The parsed ConsumerGroupName if successful.

Remarks

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

projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}

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

public static bool TryParse(string consumerGroupName, out ConsumerGroupName result)

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

Parameters
Name	Description
`consumerGroupName`	`string` The resource name in string form. Must not be `null`.
`result`	`ConsumerGroupName` When this method returns, the parsed ConsumerGroupName, 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}/clusters/{cluster}/consumerGroups/{consumer_group}

TryParse(string, bool, out ConsumerGroupName)

public static bool TryParse(string consumerGroupName, bool allowUnparsed, out ConsumerGroupName result)

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

Parameters
Name	Description
`consumerGroupName`	`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`	`ConsumerGroupName` When this method returns, the parsed ConsumerGroupName, 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}/clusters/{cluster}/consumerGroups/{consumer_group}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ConsumerGroupName, ConsumerGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ConsumerGroupName` The first resource name to compare, or null.
`b`	`ConsumerGroupName` 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 !=(ConsumerGroupName, ConsumerGroupName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ConsumerGroupName` The first resource name to compare, or null.
`b`	`ConsumerGroupName` 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.