Class CreateSubscriberRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.eventbridgev2.model.EventBridgeV2Request
software.amazon.awssdk.services.eventbridgev2.model.CreateSubscriberRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateSubscriberRequest.Builder,CreateSubscriberRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSubscriberRequest extends EventBridgeV2Request implements ToCopyableBuilder<CreateSubscriberRequest.Builder,CreateSubscriberRequest>

  • Method Details

    • name

      public final String name()
      Returns the value of the Name property for this object.
      Returns:
      The value of the Name property for this object.

    • eventBusArn

      public final String eventBusArn()
      Returns the value of the EventBusArn property for this object.
      Returns:
      The value of the EventBusArn property for this object.

    • invokeConfiguration

      public final InvokeConfiguration invokeConfiguration()
      Returns the value of the InvokeConfiguration property for this object.
      Returns:
      The value of the InvokeConfiguration property for this object.

    • description

      public final String description()
      Returns the value of the Description property for this object.
      Returns:
      The value of the Description property for this object.

    • filterConfiguration

      public final FilterConfiguration filterConfiguration()
      Returns the value of the FilterConfiguration property for this object.
      Returns:
      The value of the FilterConfiguration property for this object.

    • type

      public final OrderingType type()
      Returns the value of the Type property for this object.

      If the service returns an enum value that is not available in the current SDK version, type will return OrderingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The value of the Type property for this object.
      See Also:

    • typeAsString

      public final String typeAsString()
      Returns the value of the Type property for this object.

      If the service returns an enum value that is not available in the current SDK version, type will return OrderingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The value of the Type property for this object.
      See Also:

    • startingPosition

      public final StartingPosition startingPosition()
      Returns the value of the StartingPosition property for this object.

      If the service returns an enum value that is not available in the current SDK version, startingPosition will return StartingPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

      Returns:
      The value of the StartingPosition property for this object.
      See Also:

    • startingPositionAsString

      public final String startingPositionAsString()
      Returns the value of the StartingPosition property for this object.

      If the service returns an enum value that is not available in the current SDK version, startingPosition will return StartingPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

      Returns:
      The value of the StartingPosition property for this object.
      See Also:

    • pointInTimeConfiguration

      public final PointInTimeConfiguration pointInTimeConfiguration()
      Returns the value of the PointInTimeConfiguration property for this object.
      Returns:
      The value of the PointInTimeConfiguration property for this object.

    • batchConfiguration

      public final BatchConfiguration batchConfiguration()
      Returns the value of the BatchConfiguration property for this object.
      Returns:
      The value of the BatchConfiguration property for this object.

    • transformer

      public final Transformer transformer()

      Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.

      Returns:
      Not applicable to universal (aws-sdk) targets, whose input transformation is UniversalTargetParameters.Input; a Transformer on such a target is rejected.

    • retryPolicy

      public final RetryPolicy retryPolicy()
      Returns the value of the RetryPolicy property for this object.
      Returns:
      The value of the RetryPolicy property for this object.

    • onFailureConfiguration

      public final OnFailureConfiguration onFailureConfiguration()
      Returns the value of the OnFailureConfiguration property for this object.
      Returns:
      The value of the OnFailureConfiguration property for this object.

    • logConfiguration

      public final LogConfiguration logConfiguration()
      Returns the value of the LogConfiguration property for this object.
      Returns:
      The value of the LogConfiguration property for this object.

    • state

      public final SubscriberState state()
      Returns the value of the State property for this object.

      If the service returns an enum value that is not available in the current SDK version, state will return SubscriberState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The value of the State property for this object.
      See Also:

    • stateAsString

      public final String stateAsString()
      Returns the value of the State property for this object.

      If the service returns an enum value that is not available in the current SDK version, state will return SubscriberState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The value of the State property for this object.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()
      Returns the value of the Tags property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The value of the Tags property for this object.

    • clientToken

      public final String clientToken()
      Returns the value of the ClientToken property for this object.
      Returns:
      The value of the ClientToken property for this object.

    • toBuilder

      public CreateSubscriberRequest.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<CreateSubscriberRequest.Builder,CreateSubscriberRequest>
      Specified by:
      toBuilder in class EventBridgeV2Request
      Returns:
      a builder for type T

    • builder

      public static CreateSubscriberRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.