Class IngestionDataSourceSettings.AwsKinesis (1.129.1)

public static final class IngestionDataSourceSettings.AwsKinesis extends GeneratedMessageV3 implements IngestionDataSourceSettings.AwsKinesisOrBuilder

Ingestion settings for Amazon Kinesis Data Streams.

Protobuf type google.pubsub.v1.IngestionDataSourceSettings.AwsKinesis

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > IngestionDataSourceSettings.AwsKinesis

Implements

IngestionDataSourceSettings.AwsKinesisOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AWS_ROLE_ARN_FIELD_NUMBER

public static final int AWS_ROLE_ARN_FIELD_NUMBER

Field Value
Type	Description
`int`

CONSUMER_ARN_FIELD_NUMBER

public static final int CONSUMER_ARN_FIELD_NUMBER

Field Value
Type	Description
`int`

GCP_SERVICE_ACCOUNT_FIELD_NUMBER

public static final int GCP_SERVICE_ACCOUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

STREAM_ARN_FIELD_NUMBER

public static final int STREAM_ARN_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static IngestionDataSourceSettings.AwsKinesis getDefaultInstance()

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static IngestionDataSourceSettings.AwsKinesis.Builder newBuilder()

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis.Builder`

newBuilder(IngestionDataSourceSettings.AwsKinesis prototype)

public static IngestionDataSourceSettings.AwsKinesis.Builder newBuilder(IngestionDataSourceSettings.AwsKinesis prototype)

Parameter
Name	Description
`prototype`	`IngestionDataSourceSettings.AwsKinesis`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis.Builder`

parseDelimitedFrom(InputStream input)

public static IngestionDataSourceSettings.AwsKinesis parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestionDataSourceSettings.AwsKinesis parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IngestionDataSourceSettings.AwsKinesis parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<IngestionDataSourceSettings.AwsKinesis> parser()

Returns
Type	Description
`Parser<AwsKinesis>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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`

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

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

Returns
Type	Description
`ByteString`	The bytes for gcpServiceAccount.

getParserForType()

public Parser<IngestionDataSourceSettings.AwsKinesis> getParserForType()

Returns
Type	Description
`Parser<AwsKinesis>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public IngestionDataSourceSettings.AwsKinesis.Builder newBuilderForType()

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IngestionDataSourceSettings.AwsKinesis.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public IngestionDataSourceSettings.AwsKinesis.Builder toBuilder()

Returns
Type	Description
`IngestionDataSourceSettings.AwsKinesis.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`