Class IngestionDataSourceSettings.AwsMsk.Builder (1.147.0)

public static final class IngestionDataSourceSettings.AwsMsk.Builder extends GeneratedMessage.Builder<IngestionDataSourceSettings.AwsMsk.Builder> implements IngestionDataSourceSettings.AwsMskOrBuilder

Ingestion settings for Amazon MSK.

Protobuf type google.pubsub.v1.IngestionDataSourceSettings.AwsMsk

Static Methods

getDescriptor()

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

Methods

build()

public IngestionDataSourceSettings.AwsMsk build()
Returns
Type Description
IngestionDataSourceSettings.AwsMsk

buildPartial()

public IngestionDataSourceSettings.AwsMsk buildPartial()
Returns
Type Description
IngestionDataSourceSettings.AwsMsk

clear()

public IngestionDataSourceSettings.AwsMsk.Builder clear()
Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder
Overrides

clearAwsRoleArn()

public IngestionDataSourceSettings.AwsMsk.Builder clearAwsRoleArn()

Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

string aws_role_arn = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

clearClusterArn()

public IngestionDataSourceSettings.AwsMsk.Builder clearClusterArn()

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

string cluster_arn = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

clearGcpServiceAccount()

public IngestionDataSourceSettings.AwsMsk.Builder clearGcpServiceAccount()

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

string gcp_service_account = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

clearState()

public IngestionDataSourceSettings.AwsMsk.Builder clearState()

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

.google.pubsub.v1.IngestionDataSourceSettings.AwsMsk.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

clearTopic()

public IngestionDataSourceSettings.AwsMsk.Builder clearTopic()

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

string topic = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

getAwsRoleArn()

public String getAwsRoleArn()

Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

string aws_role_arn = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The awsRoleArn.

getAwsRoleArnBytes()

public ByteString getAwsRoleArnBytes()

Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

string aws_role_arn = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for awsRoleArn.

getClusterArn()

public String getClusterArn()

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

string cluster_arn = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The clusterArn.

getClusterArnBytes()

public ByteString getClusterArnBytes()

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

string cluster_arn = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for clusterArn.

getDefaultInstanceForType()

public IngestionDataSourceSettings.AwsMsk getDefaultInstanceForType()
Returns
Type Description
IngestionDataSourceSettings.AwsMsk

getDescriptorForType()

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

getGcpServiceAccount()

public String getGcpServiceAccount()

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

string gcp_service_account = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The gcpServiceAccount.

getGcpServiceAccountBytes()

public ByteString getGcpServiceAccountBytes()

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

string gcp_service_account = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for gcpServiceAccount.

getState()

public IngestionDataSourceSettings.AwsMsk.State getState()

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

.google.pubsub.v1.IngestionDataSourceSettings.AwsMsk.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.State

The state.

getStateValue()

public int getStateValue()

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

.google.pubsub.v1.IngestionDataSourceSettings.AwsMsk.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTopic()

public String getTopic()

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

string topic = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The topic.

getTopicBytes()

public ByteString getTopicBytes()

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

string topic = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for topic.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(IngestionDataSourceSettings.AwsMsk other)

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

setAwsRoleArn(String value)

public IngestionDataSourceSettings.AwsMsk.Builder setAwsRoleArn(String value)

Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

string aws_role_arn = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The awsRoleArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setAwsRoleArnBytes(ByteString value)

public IngestionDataSourceSettings.AwsMsk.Builder setAwsRoleArnBytes(ByteString value)

Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

string aws_role_arn = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for awsRoleArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setClusterArn(String value)

public IngestionDataSourceSettings.AwsMsk.Builder setClusterArn(String value)

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

string cluster_arn = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The clusterArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setClusterArnBytes(ByteString value)

public IngestionDataSourceSettings.AwsMsk.Builder setClusterArnBytes(ByteString value)

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

string cluster_arn = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for clusterArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setGcpServiceAccount(String value)

public IngestionDataSourceSettings.AwsMsk.Builder setGcpServiceAccount(String value)

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

string gcp_service_account = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The gcpServiceAccount to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setGcpServiceAccountBytes(ByteString value)

public IngestionDataSourceSettings.AwsMsk.Builder setGcpServiceAccountBytes(ByteString value)

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

string gcp_service_account = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for gcpServiceAccount to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setState(IngestionDataSourceSettings.AwsMsk.State value)

public IngestionDataSourceSettings.AwsMsk.Builder setState(IngestionDataSourceSettings.AwsMsk.State value)

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

.google.pubsub.v1.IngestionDataSourceSettings.AwsMsk.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value IngestionDataSourceSettings.AwsMsk.State

The state to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setStateValue(int value)

public IngestionDataSourceSettings.AwsMsk.Builder setStateValue(int value)

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

.google.pubsub.v1.IngestionDataSourceSettings.AwsMsk.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setTopic(String value)

public IngestionDataSourceSettings.AwsMsk.Builder setTopic(String value)

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

string topic = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The topic to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.

setTopicBytes(ByteString value)

public IngestionDataSourceSettings.AwsMsk.Builder setTopicBytes(ByteString value)

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

string topic = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for topic to set.

Returns
Type Description
IngestionDataSourceSettings.AwsMsk.Builder

This builder for chaining.