Package software.amazon.awssdk.services.finspace.model

Class UpdateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.finspace.model.FinspaceRequest

software.amazon.awssdk.services.finspace.model.UpdateEnvironmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateEnvironmentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateEnvironmentRequest.Builder	builder()
String	description()	The description of the environment.
String	environmentId()	The identifier of the FinSpace environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FederationMode	federationMode()	Authentication mode for the environment.
String	federationModeAsString()	Authentication mode for the environment.
FederationParameters	federationParameters()	Returns the value of the FederationParameters property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the environment.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateEnvironmentRequest.Builder>	serializableBuilderClass()
UpdateEnvironmentRequest.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

environmentId

public final String environmentId()

The identifier of the FinSpace environment.

Returns:

The identifier of the FinSpace environment.

name

public final String name()

The name of the environment.

Returns:

The name of the environment.

description

public final String description()

The description of the environment.

Returns:

The description of the environment.

federationMode

public final FederationMode federationMode()

Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

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

Returns:

Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

See Also:

FederationMode

federationModeAsString

public final String federationModeAsString()

Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

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

Returns:

Authentication mode for the environment.

• FEDERATED - Users access FinSpace through Single Sign On (SSO) via your Identity provider.

• LOCAL - Users access FinSpace via email and password managed within the FinSpace environment.

See Also:

FederationMode

federationParameters

public final FederationParameters federationParameters()

Returns the value of the FederationParameters property for this object.

Returns:

The value of the FederationParameters property for this object.

toBuilder

public UpdateEnvironmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Specified by:

toBuilder in class FinspaceRequest

builder

public static UpdateEnvironmentRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo