Class CognitoStreams

java.lang.Object
software.amazon.awssdk.services.cognitosync.model.CognitoStreams
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CognitoStreams.Builder,CognitoStreams>
@Generated("software.amazon.awssdk:codegen") public final class CognitoStreams extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CognitoStreams.Builder,CognitoStreams>
Configuration options for configure Cognito streams.
See Also:

  • Method Details

    • streamName

      public final String 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

      public final String 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

      public final StreamingStatus 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 return StreamingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamingStatusAsString().

      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

      public final String 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 return StreamingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamingStatusAsString().

      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

      public CognitoStreams.Builder 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 interface ToCopyableBuilder<CognitoStreams.Builder,CognitoStreams>
      Returns:
      a builder for type T

    • builder

      public static CognitoStreams.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CognitoStreams.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.