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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateEndpointRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateEndpointRequest.Builder	builder()
String	description()	A description of the global endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<EndpointEventBus>	eventBuses()	Define the event buses used.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventBuses()	For responses, this returns true if the service returned a value for the EventBuses property.
int	hashCode()
String	name()	The name of the global endpoint.
ReplicationConfig	replicationConfig()	Enable or disable event replication.
String	roleArn()	The ARN of the role used for replication.
RoutingConfig	routingConfig()	Configure the routing policy, including the health check and secondary Region..
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEndpointRequest.Builder>	serializableBuilderClass()
CreateEndpointRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateEndpointRequest.Builder,CreateEndpointRequest>

Specified by:

toBuilder in class EventBridgeRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo