Class CognitoStreams
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CognitoStreams.Builder,
CognitoStreams>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CognitoStreams.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
roleArn()
The ARN of the role Amazon Cognito can assume in order to publish to the stream.static Class
<? extends CognitoStreams.Builder> final StreamingStatus
Status of the Cognito streams.final String
Status of the Cognito streams.final String
The name of the Cognito stream to receive updates.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
streamName
The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.- Returns:
- The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.
-
roleArn
The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.- Returns:
- The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.
-
streamingStatus
Status of the Cognito streams. Valid values are:ENABLED - Streaming of updates to identity pool is enabled.
DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
If the service returns an enum value that is not available in the current SDK version,
streamingStatus
will returnStreamingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamingStatusAsString()
.- Returns:
- Status of the Cognito streams. Valid values are:
ENABLED - Streaming of updates to identity pool is enabled.
DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
- See Also:
-
streamingStatusAsString
Status of the Cognito streams. Valid values are:ENABLED - Streaming of updates to identity pool is enabled.
DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
If the service returns an enum value that is not available in the current SDK version,
streamingStatus
will returnStreamingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamingStatusAsString()
.- Returns:
- Status of the Cognito streams. Valid values are:
ENABLED - Streaming of updates to identity pool is enabled.
DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CognitoStreams.Builder,
CognitoStreams> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-