Package software.amazon.awssdk.services.eventbridge.model

Class CreateEndpointRequest

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

  • Method Details

    • name

      public final String name()

      The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

      Returns:
      The name of the global endpoint. For example, "Name":"us-east-2-custom_bus_A-endpoint".

    • description

      public final String description()

      A description of the global endpoint.

      Returns:
      A description of the global endpoint.

    • routingConfig

      public final RoutingConfig routingConfig()

      Configure the routing policy, including the health check and secondary Region..

      Returns:
      Configure the routing policy, including the health check and secondary Region..

    • replicationConfig

      public final ReplicationConfig replicationConfig()

      Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

      Returns:
      Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

    • hasEventBuses

      public final boolean hasEventBuses()
      For responses, this returns true if the service returned a value for the EventBuses 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.

    • eventBuses

      public final List<EndpointEventBus> eventBuses()

      Define the event buses used.

      The names of the event buses must be identical in each Region.

      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 hasEventBuses() method.

      Returns:
      Define the event buses used.

      The names of the event buses must be identical in each Region.

    • roleArn

      public final String roleArn()

      The ARN of the role used for replication.

      Returns:
      The ARN of the role used for replication.

    • toBuilder

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

    • builder

      public static CreateEndpointRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEndpointRequest.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.