Package software.amazon.awssdk.services.workspaces.model

Class ModifySamlPropertiesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workspaces.model.WorkSpacesRequest

software.amazon.awssdk.services.workspaces.model.ModifySamlPropertiesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifySamlPropertiesRequest.Builder,ModifySamlPropertiesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifySamlPropertiesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ModifySamlPropertiesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPropertiesToDelete()	For responses, this returns true if the service returned a value for the PropertiesToDelete property.
List<DeletableSamlProperty>	propertiesToDelete()	The SAML properties to delete as part of your request.
List<String>	propertiesToDeleteAsStrings()	The SAML properties to delete as part of your request.
String	resourceId()	The directory identifier for which you want to configure SAML properties.
SamlProperties	samlProperties()	The properties for configuring SAML 2.0 authentication.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifySamlPropertiesRequest.Builder>	serializableBuilderClass()
ModifySamlPropertiesRequest.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

resourceId

public final String resourceId()

The directory identifier for which you want to configure SAML properties.

Returns:

The directory identifier for which you want to configure SAML properties.

samlProperties

public final SamlProperties samlProperties()

The properties for configuring SAML 2.0 authentication.

Returns:

The properties for configuring SAML 2.0 authentication.

propertiesToDelete

public final List<DeletableSamlProperty> propertiesToDelete()

The SAML properties to delete as part of your request.

Specify one of the following options:

• SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

• SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

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

Returns:

The SAML properties to delete as part of your request.

Specify one of the following options:

• SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

• SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

hasPropertiesToDelete

public final boolean hasPropertiesToDelete()

For responses, this returns true if the service returned a value for the PropertiesToDelete 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.

propertiesToDeleteAsStrings

public final List<String> propertiesToDeleteAsStrings()

The SAML properties to delete as part of your request.

Specify one of the following options:

• SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

• SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

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

Returns:

The SAML properties to delete as part of your request.

Specify one of the following options:

• SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

• SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

toBuilder

public ModifySamlPropertiesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifySamlPropertiesRequest.Builder,ModifySamlPropertiesRequest>

Specified by:

toBuilder in class WorkSpacesRequest

builder

public static ModifySamlPropertiesRequest.Builder builder()

serializableBuilderClass

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