Class CreateApplicationRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ssoadmin.model.SsoAdminRequest
-
- software.amazon.awssdk.services.ssoadmin.model.CreateApplicationRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateApplicationRequest extends SsoAdminRequest implements ToCopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateApplicationRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
applicationProviderArn()
The ARN of the application provider under which the operation will run.static CreateApplicationRequest.Builder
builder()
String
clientToken()
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request.String
description()
The description of the .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
instanceArn()
The ARN of the instance of IAM Identity Center under which the operation will run.String
name()
The name of the .PortalOptions
portalOptions()
A structure that describes the options for the portal associated with an application.List<SdkField<?>>
sdkFields()
static Class<? extends CreateApplicationRequest.Builder>
serializableBuilderClass()
ApplicationStatus
status()
Specifies whether the application is enabled or disabled.String
statusAsString()
Specifies whether the application is enabled or disabled.List<Tag>
tags()
Specifies tags to be attached to the application.CreateApplicationRequest.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
-
applicationProviderArn
public final String applicationProviderArn()
The ARN of the application provider under which the operation will run.
- Returns:
- The ARN of the application provider under which the operation will run.
-
clientToken
public final String clientToken()
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.- Returns:
- Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This
lets you safely retry the request without accidentally performing the same operation a second time.
Passing the same value to a later call to an operation requires that you also pass the same value for all
other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.
-
description
public final String description()
The description of the .
- Returns:
- The description of the .
-
instanceArn
public final String instanceArn()
The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
- Returns:
- The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
-
name
public final String name()
The name of the .
- Returns:
- The name of the .
-
portalOptions
public final PortalOptions portalOptions()
A structure that describes the options for the portal associated with an application.
- Returns:
- A structure that describes the options for the portal associated with an application.
-
status
public final ApplicationStatus status()
Specifies whether the application is enabled or disabled.
If the service returns an enum value that is not available in the current SDK version,
status
will returnApplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Specifies whether the application is enabled or disabled.
- See Also:
ApplicationStatus
-
statusAsString
public final String statusAsString()
Specifies whether the application is enabled or disabled.
If the service returns an enum value that is not available in the current SDK version,
status
will returnApplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Specifies whether the application is enabled or disabled.
- See Also:
ApplicationStatus
-
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 theisEmpty()
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 List<Tag> tags()
Specifies tags to be attached to the application.
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:
- Specifies tags to be attached to the application.
-
toBuilder
public CreateApplicationRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>
- Specified by:
toBuilder
in classSsoAdminRequest
-
builder
public static CreateApplicationRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateApplicationRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-