software.amazon.awssdk.services.vpclattice.model

Class CreateListenerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.vpclattice.model.VpcLatticeRequest

software.amazon.awssdk.services.vpclattice.model.CreateListenerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateListenerRequest
extends VpcLatticeRequest
implements ToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateListenerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateListenerRequest.Builder	builder()
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
RuleAction	defaultAction() The action for the default rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the listener.
Integer	port() The listener port.
ListenerProtocol	protocol() The listener protocol HTTP or HTTPS.
String	protocolAsString() The listener protocol HTTP or HTTPS.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateListenerRequest.Builder>	serializableBuilderClass()
String	serviceIdentifier() The ID or Amazon Resource Name (ARN) of the service.
Map<String,String>	tags() The tags for the listener.
CreateListenerRequest.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

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

defaultAction

public final RuleAction defaultAction()

The action for the default rule. Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that's used if no other rules match. Each rule must include exactly one of the following types of actions: forward or fixed-response, and it must be the last action to be performed.

Returns:

The action for the default rule. Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that's used if no other rules match. Each rule must include exactly one of the following types of actions: forward or fixed-response, and it must be the last action to be performed.

name

public final String name()

The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

Returns:

The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

port

public final Integer port()

The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

Returns:

The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

protocol

public final ListenerProtocol protocol()

The listener protocol HTTP or HTTPS.

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

Returns:

The listener protocol HTTP or HTTPS.

See Also:

ListenerProtocol

protocolAsString

public final String protocolAsString()

The listener protocol HTTP or HTTPS.

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

Returns:

The listener protocol HTTP or HTTPS.

See Also:

ListenerProtocol

serviceIdentifier

public final String serviceIdentifier()

The ID or Amazon Resource Name (ARN) of the service.

Returns:

The ID or Amazon Resource Name (ARN) of the service.

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

The tags for the listener.

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 tags for the listener.

toBuilder

public CreateListenerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateListenerRequest.Builder,CreateListenerRequest>

Specified by:

toBuilder in class VpcLatticeRequest

builder

public static CreateListenerRequest.Builder builder()

serializableBuilderClass

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