Class Acl.Builder (0.20.0)

public static final class Acl.Builder extends GeneratedMessageV3.Builder<Acl.Builder> implements AclOrBuilder

Represents the set of ACLs for a given Kafka Resource Pattern, which consists of resource_type, resource_name and pattern_type.

Protobuf type google.cloud.managedkafka.v1.Acl

Implements

AclOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAclEntries(AclEntry value)

public Acl.Builder addAclEntries(AclEntry value)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value AclEntry
Returns
Type Description
Acl.Builder

addAclEntries(AclEntry.Builder builderForValue)

public Acl.Builder addAclEntries(AclEntry.Builder builderForValue)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue AclEntry.Builder
Returns
Type Description
Acl.Builder

addAclEntries(int index, AclEntry value)

public Acl.Builder addAclEntries(int index, AclEntry value)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value AclEntry
Returns
Type Description
Acl.Builder

addAclEntries(int index, AclEntry.Builder builderForValue)

public Acl.Builder addAclEntries(int index, AclEntry.Builder builderForValue)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue AclEntry.Builder
Returns
Type Description
Acl.Builder

addAclEntriesBuilder()

public AclEntry.Builder addAclEntriesBuilder()

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AclEntry.Builder

addAclEntriesBuilder(int index)

public AclEntry.Builder addAclEntriesBuilder(int index)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AclEntry.Builder

addAllAclEntries(Iterable<? extends AclEntry> values)

public Acl.Builder addAllAclEntries(Iterable<? extends AclEntry> values)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.managedkafka.v1.AclEntry>
Returns
Type Description
Acl.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Acl.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Acl.Builder
Overrides

build()

public Acl build()
Returns
Type Description
Acl

buildPartial()

public Acl buildPartial()
Returns
Type Description
Acl

clear()

public Acl.Builder clear()
Returns
Type Description
Acl.Builder
Overrides

clearAclEntries()

public Acl.Builder clearAclEntries()

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Acl.Builder

clearEtag()

public Acl.Builder clearEtag()

Optional. etag is used for concurrency control. An etag is returned in the response to GetAcl and CreateAcl. Callers are required to put that etag in the request to UpdateAcl to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.

A terminal 'T' character in the etag indicates that the AclEntries were truncated; more entries for the Acl exist on the Kafka Cluster, but can't be returned in the Acl due to repeated field limits.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Acl.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Acl.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Acl.Builder
Overrides

clearName()

public Acl.Builder clearName()

Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}

The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following:

For acls on the cluster: cluster

For acls on a single resource within the cluster: topic/{resource_name} consumerGroup/{resource_name} transactionalId/{resource_name}

For acls on all resources that match a prefix: topicPrefixed/{resource_name} consumerGroupPrefixed/{resource_name} transactionalIdPrefixed/{resource_name}

For acls on all resources of a given type (i.e. the wildcard literal "*"): allTopics (represents topic/*) allConsumerGroups (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Acl.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Acl.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Acl.Builder
Overrides

clearPatternType()

public Acl.Builder clearPatternType()

Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.

string pattern_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Acl.Builder

This builder for chaining.

clearResourceName()

public Acl.Builder clearResourceName()

Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".

string resource_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Acl.Builder

This builder for chaining.

clearResourceType()

public Acl.Builder clearResourceType()

Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.

string resource_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Acl.Builder

This builder for chaining.

clone()

public Acl.Builder clone()
Returns
Type Description
Acl.Builder
Overrides

getAclEntries(int index)

public AclEntry getAclEntries(int index)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AclEntry

getAclEntriesBuilder(int index)

public AclEntry.Builder getAclEntriesBuilder(int index)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AclEntry.Builder

getAclEntriesBuilderList()

public List<AclEntry.Builder> getAclEntriesBuilderList()

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getAclEntriesCount()

public int getAclEntriesCount()

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getAclEntriesList()

public List<AclEntry> getAclEntriesList()

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<AclEntry>

getAclEntriesOrBuilder(int index)

public AclEntryOrBuilder getAclEntriesOrBuilder(int index)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
AclEntryOrBuilder

getAclEntriesOrBuilderList()

public List<? extends AclEntryOrBuilder> getAclEntriesOrBuilderList()

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.managedkafka.v1.AclEntryOrBuilder>

getDefaultInstanceForType()

public Acl getDefaultInstanceForType()
Returns
Type Description
Acl

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEtag()

public String getEtag()

Optional. etag is used for concurrency control. An etag is returned in the response to GetAcl and CreateAcl. Callers are required to put that etag in the request to UpdateAcl to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.

A terminal 'T' character in the etag indicates that the AclEntries were truncated; more entries for the Acl exist on the Kafka Cluster, but can't be returned in the Acl due to repeated field limits.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. etag is used for concurrency control. An etag is returned in the response to GetAcl and CreateAcl. Callers are required to put that etag in the request to UpdateAcl to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.

A terminal 'T' character in the etag indicates that the AclEntries were truncated; more entries for the Acl exist on the Kafka Cluster, but can't be returned in the Acl due to repeated field limits.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}

The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following:

For acls on the cluster: cluster

For acls on a single resource within the cluster: topic/{resource_name} consumerGroup/{resource_name} transactionalId/{resource_name}

For acls on all resources that match a prefix: topicPrefixed/{resource_name} consumerGroupPrefixed/{resource_name} transactionalIdPrefixed/{resource_name}

For acls on all resources of a given type (i.e. the wildcard literal "*"): allTopics (represents topic/*) allConsumerGroups (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}

The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following:

For acls on the cluster: cluster

For acls on a single resource within the cluster: topic/{resource_name} consumerGroup/{resource_name} transactionalId/{resource_name}

For acls on all resources that match a prefix: topicPrefixed/{resource_name} consumerGroupPrefixed/{resource_name} transactionalIdPrefixed/{resource_name}

For acls on all resources of a given type (i.e. the wildcard literal "*"): allTopics (represents topic/*) allConsumerGroups (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPatternType()

public String getPatternType()

Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.

string pattern_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The patternType.

getPatternTypeBytes()

public ByteString getPatternTypeBytes()

Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.

string pattern_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for patternType.

getResourceName()

public String getResourceName()

Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".

string resource_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The resourceName.

getResourceNameBytes()

public ByteString getResourceNameBytes()

Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".

string resource_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for resourceName.

getResourceType()

public String getResourceType()

Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.

string resource_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The resourceType.

getResourceTypeBytes()

public ByteString getResourceTypeBytes()

Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.

string resource_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for resourceType.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Acl other)

public Acl.Builder mergeFrom(Acl other)
Parameter
Name Description
other Acl
Returns
Type Description
Acl.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Acl.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Acl.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Acl.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Acl.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Acl.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Acl.Builder
Overrides

removeAclEntries(int index)

public Acl.Builder removeAclEntries(int index)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Acl.Builder

setAclEntries(int index, AclEntry value)

public Acl.Builder setAclEntries(int index, AclEntry value)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value AclEntry
Returns
Type Description
Acl.Builder

setAclEntries(int index, AclEntry.Builder builderForValue)

public Acl.Builder setAclEntries(int index, AclEntry.Builder builderForValue)

Required. The ACL entries that apply to the resource pattern. The maximum number of allowed entries 100.

repeated .google.cloud.managedkafka.v1.AclEntry acl_entries = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue AclEntry.Builder
Returns
Type Description
Acl.Builder

setEtag(String value)

public Acl.Builder setEtag(String value)

Optional. etag is used for concurrency control. An etag is returned in the response to GetAcl and CreateAcl. Callers are required to put that etag in the request to UpdateAcl to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.

A terminal 'T' character in the etag indicates that the AclEntries were truncated; more entries for the Acl exist on the Kafka Cluster, but can't be returned in the Acl due to repeated field limits.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Acl.Builder setEtagBytes(ByteString value)

Optional. etag is used for concurrency control. An etag is returned in the response to GetAcl and CreateAcl. Callers are required to put that etag in the request to UpdateAcl to ensure that their change will be applied to the same version of the acl that exists in the Kafka Cluster.

A terminal 'T' character in the etag indicates that the AclEntries were truncated; more entries for the Acl exist on the Kafka Cluster, but can't be returned in the Acl due to repeated field limits.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Acl.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Acl.Builder
Overrides

setName(String value)

public Acl.Builder setName(String value)

Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}

The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following:

For acls on the cluster: cluster

For acls on a single resource within the cluster: topic/{resource_name} consumerGroup/{resource_name} transactionalId/{resource_name}

For acls on all resources that match a prefix: topicPrefixed/{resource_name} consumerGroupPrefixed/{resource_name} transactionalIdPrefixed/{resource_name}

For acls on all resources of a given type (i.e. the wildcard literal "*"): allTopics (represents topic/*) allConsumerGroups (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Acl.Builder setNameBytes(ByteString value)

Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}

The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following:

For acls on the cluster: cluster

For acls on a single resource within the cluster: topic/{resource_name} consumerGroup/{resource_name} transactionalId/{resource_name}

For acls on all resources that match a prefix: topicPrefixed/{resource_name} consumerGroupPrefixed/{resource_name} transactionalIdPrefixed/{resource_name}

For acls on all resources of a given type (i.e. the wildcard literal "*"): allTopics (represents topic/*) allConsumerGroups (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setPatternType(String value)

public Acl.Builder setPatternType(String value)

Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.

string pattern_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The patternType to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setPatternTypeBytes(ByteString value)

public Acl.Builder setPatternTypeBytes(ByteString value)

Output only. The ACL pattern type derived from the name. One of: LITERAL, PREFIXED.

string pattern_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for patternType to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Acl.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Acl.Builder
Overrides

setResourceName(String value)

public Acl.Builder setResourceName(String value)

Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".

string resource_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The resourceName to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setResourceNameBytes(ByteString value)

public Acl.Builder setResourceNameBytes(ByteString value)

Output only. The ACL resource name derived from the name. For cluster resource_type, this is always "kafka-cluster". Can be the wildcard literal "*".

string resource_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for resourceName to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setResourceType(String value)

public Acl.Builder setResourceType(String value)

Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.

string resource_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The resourceType to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setResourceTypeBytes(ByteString value)

public Acl.Builder setResourceTypeBytes(ByteString value)

Output only. The ACL resource type derived from the name. One of: CLUSTER, TOPIC, GROUP, TRANSACTIONAL_ID.

string resource_type = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for resourceType to set.

Returns
Type Description
Acl.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Acl.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Acl.Builder
Overrides