Class IngestionDataSourceSettings.AwsKinesis (1.143.0)
Version latestkeyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static IngestionDataSourceSettings . AwsKinesis . Builder newBuilder ()
newBuilder(IngestionDataSourceSettings.AwsKinesis prototype)
public static IngestionDataSourceSettings . AwsKinesis . Builder newBuilder ( IngestionDataSourceSettings . AwsKinesis prototype )
public static IngestionDataSourceSettings . AwsKinesis parseDelimitedFrom ( InputStream input )
public static IngestionDataSourceSettings . AwsKinesis parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( CodedInputStream input )
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( InputStream input )
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static IngestionDataSourceSettings . AwsKinesis parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<IngestionDataSourceSettings . AwsKinesis > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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 ()
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.
getParserForType()
public Parser<IngestionDataSourceSettings . AwsKinesis > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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];
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public IngestionDataSourceSettings . AwsKinesis . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected IngestionDataSourceSettings . AwsKinesis . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public IngestionDataSourceSettings . AwsKinesis . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
