target.apidocs.com.google.api.services.pubsub.model.AwsKinesis.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-pubsub Show documentation

There is a newer version: v1-rev20240730-2.0.0

Show newest version







AwsKinesis (Cloud Pub/Sub API v1-rev20240918-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.pubsub.model
Class AwsKinesis



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.pubsub.model.AwsKinesis













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class AwsKinesis
extends com.google.api.client.json.GenericJson
Ingestion settings for Amazon Kinesis Data Streams.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


AwsKinesis() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AwsKinesis
clone() 


String
getAwsRoleArn()
Required.



String
getConsumerArn()
Required.



String
getGcpServiceAccount()
Required.



String
getState()
Output only.



String
getStreamArn()
Required.



AwsKinesis
set(String fieldName,
   Object value) 


AwsKinesis
setAwsRoleArn(String awsRoleArn)
Required.



AwsKinesis
setConsumerArn(String consumerArn)
Required.



AwsKinesis
setGcpServiceAccount(String gcpServiceAccount)
Required.



AwsKinesis
setState(String state)
Output only.



AwsKinesis
setStreamArn(String streamArn)
Required.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





AwsKinesis
public AwsKinesis()









Method Detail





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.

Returns:
value or null for none








setAwsRoleArn
public AwsKinesis setAwsRoleArn(String awsRoleArn)
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.

Parameters:
awsRoleArn - awsRoleArn or null for none








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.

Returns:
value or null for none








setConsumerArn
public AwsKinesis setConsumerArn(String consumerArn)
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.

Parameters:
consumerArn - consumerArn or null for none








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.

Returns:
value or null for none








setGcpServiceAccount
public AwsKinesis setGcpServiceAccount(String gcpServiceAccount)
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.

Parameters:
gcpServiceAccount - gcpServiceAccount or null for none








getState
public String getState()
Output only. An output-only field that indicates the state of the Kinesis ingestion source.

Returns:
value or null for none








setState
public AwsKinesis setState(String state)
Output only. An output-only field that indicates the state of the Kinesis ingestion source.

Parameters:
state - state or null for none








getStreamArn
public String getStreamArn()
Required. The Kinesis stream ARN to ingest data from.

Returns:
value or null for none








setStreamArn
public AwsKinesis setStreamArn(String streamArn)
Required. The Kinesis stream ARN to ingest data from.

Parameters:
streamArn - streamArn or null for none








set
public AwsKinesis set(String fieldName,
                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public AwsKinesis clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`AwsKinesis`	`clone()`
`String`	`getAwsRoleArn()` Required.
`String`	`getConsumerArn()` Required.
`String`	`getGcpServiceAccount()` Required.
`String`	`getState()` Output only.
`String`	`getStreamArn()` Required.
`AwsKinesis`	`set(String fieldName, Object value)`
`AwsKinesis`	`setAwsRoleArn(String awsRoleArn)` Required.
`AwsKinesis`	`setConsumerArn(String consumerArn)` Required.
`AwsKinesis`	`setGcpServiceAccount(String gcpServiceAccount)` Required.
`AwsKinesis`	`setState(String state)` Output only.
`AwsKinesis`	`setStreamArn(String streamArn)` Required.