Class IngestionDataSourceSettings.AwsKinesis.Builder (1.129.1)

public static final class IngestionDataSourceSettings.AwsKinesis.Builder extends GeneratedMessageV3.Builder<IngestionDataSourceSettings.AwsKinesis.Builder> implements IngestionDataSourceSettings.AwsKinesisOrBuilder

Ingestion settings for Amazon Kinesis Data Streams.

Protobuf type google.pubsub.v1.IngestionDataSourceSettings.AwsKinesis

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearAwsRoleArn()

public IngestionDataSourceSettings.AwsKinesis.Builder clearAwsRoleArn()

Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. 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.AwsKinesis.Builder

This builder for chaining.

clearConsumerArn()

public IngestionDataSourceSettings.AwsKinesis.Builder clearConsumerArn()

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

string consumer_arn = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearGcpServiceAccount()

public IngestionDataSourceSettings.AwsKinesis.Builder clearGcpServiceAccount()

Required. The GCP service account to be used for Federated Identity authentication with Kinesis (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.AwsKinesis.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearState()

public IngestionDataSourceSettings.AwsKinesis.Builder clearState()

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

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

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

clearStreamArn()

public IngestionDataSourceSettings.AwsKinesis.Builder clearStreamArn()

Required. The Kinesis stream ARN to ingest data from.

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

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

clone()

public IngestionDataSourceSettings.AwsKinesis.Builder clone()
Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder
Overrides

getAwsRoleArn()

public String getAwsRoleArn()

Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. 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 Kinesis. 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.

getConsumerArn()

public String getConsumerArn()

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

string consumer_arn = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The consumerArn.

getConsumerArnBytes()

public ByteString getConsumerArnBytes()

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

string consumer_arn = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for consumerArn.

getDefaultInstanceForType()

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

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 Kinesis (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 Kinesis (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.AwsKinesis.State getState()

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

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

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.State

The state.

getStateValue()

public int getStateValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getStreamArn()

public String getStreamArn()

Required. The Kinesis stream ARN to ingest data from.

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

Returns
Type Description
String

The streamArn.

getStreamArnBytes()

public ByteString getStreamArnBytes()

Required. The Kinesis stream ARN to ingest data from.

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

Returns
Type Description
ByteString

The bytes for streamArn.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(IngestionDataSourceSettings.AwsKinesis other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAwsRoleArn(String value)

public IngestionDataSourceSettings.AwsKinesis.Builder setAwsRoleArn(String value)

Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. 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.AwsKinesis.Builder

This builder for chaining.

setAwsRoleArnBytes(ByteString value)

public IngestionDataSourceSettings.AwsKinesis.Builder setAwsRoleArnBytes(ByteString value)

Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. 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.AwsKinesis.Builder

This builder for chaining.

setConsumerArn(String value)

public IngestionDataSourceSettings.AwsKinesis.Builder setConsumerArn(String value)

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

string consumer_arn = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The consumerArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

setConsumerArnBytes(ByteString value)

public IngestionDataSourceSettings.AwsKinesis.Builder setConsumerArnBytes(ByteString value)

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

string consumer_arn = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for consumerArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setGcpServiceAccount(String value)

public IngestionDataSourceSettings.AwsKinesis.Builder setGcpServiceAccount(String value)

Required. The GCP service account to be used for Federated Identity authentication with Kinesis (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.AwsKinesis.Builder

This builder for chaining.

setGcpServiceAccountBytes(ByteString value)

public IngestionDataSourceSettings.AwsKinesis.Builder setGcpServiceAccountBytes(ByteString value)

Required. The GCP service account to be used for Federated Identity authentication with Kinesis (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.AwsKinesis.Builder

This builder for chaining.

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

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

setState(IngestionDataSourceSettings.AwsKinesis.State value)

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

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

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

Parameter
Name Description
value IngestionDataSourceSettings.AwsKinesis.State

The state to set.

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

setStateValue(int value)

public IngestionDataSourceSettings.AwsKinesis.Builder setStateValue(int value)

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

.google.pubsub.v1.IngestionDataSourceSettings.AwsKinesis.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.AwsKinesis.Builder

This builder for chaining.

setStreamArn(String value)

public IngestionDataSourceSettings.AwsKinesis.Builder setStreamArn(String value)

Required. The Kinesis stream ARN to ingest data from.

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

Parameter
Name Description
value String

The streamArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

setStreamArnBytes(ByteString value)

public IngestionDataSourceSettings.AwsKinesis.Builder setStreamArnBytes(ByteString value)

Required. The Kinesis stream ARN to ingest data from.

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

Parameter
Name Description
value ByteString

The bytes for streamArn to set.

Returns
Type Description
IngestionDataSourceSettings.AwsKinesis.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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