Package software.amazon.awssdk.services.vpclattice.model

Class CreateServiceRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateServiceRequest.Builder

Method Summary

Modifier and Type	Method	Description
AuthType	authType()	The type of IAM policy.
String	authTypeAsString()	The type of IAM policy.
static CreateServiceRequest.Builder	builder()
String	certificateArn()	The Amazon Resource Name (ARN) of the certificate.
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	customDomainName()	The custom domain name of the service.
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 service.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateServiceRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags for the service.
CreateServiceRequest.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

authType

public final AuthType authType()

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.

• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

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

Returns:

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.

• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

See Also:

AuthType

authTypeAsString

public final String authTypeAsString()

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.

• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

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

Returns:

The type of IAM policy.

• NONE: The resource does not use an IAM policy. This is the default.

• AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

See Also:

AuthType

certificateArn

public final String certificateArn()

The Amazon Resource Name (ARN) of the certificate.

Returns:

The Amazon Resource Name (ARN) of the certificate.

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.

customDomainName

public final String customDomainName()

The custom domain name of the service.

Returns:

The custom domain name of the service.

name

public final String name()

The name of the service. The name must be unique within the account. 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 service. The name must be unique within the account. 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.

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

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

toBuilder

public CreateServiceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

Specified by:

toBuilder in class VpcLatticeRequest

builder

public static CreateServiceRequest.Builder builder()

serializableBuilderClass

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