Class CreatePartnerAppRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
-
- software.amazon.awssdk.services.sagemaker.model.CreatePartnerAppRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePartnerAppRequest.Builder,CreatePartnerAppRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePartnerAppRequest extends SageMakerRequest implements ToCopyableBuilder<CreatePartnerAppRequest.Builder,CreatePartnerAppRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreatePartnerAppRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PartnerAppConfig
applicationConfig()
Configuration settings for the SageMaker Partner AI App.PartnerAppAuthType
authType()
The authorization type that users use to access the SageMaker Partner AI App.String
authTypeAsString()
The authorization type that users use to access the SageMaker Partner AI App.static CreatePartnerAppRequest.Builder
builder()
String
clientToken()
A unique token that guarantees that the call to this API is idempotent.Boolean
enableIamSessionBasedIdentity()
When set toTRUE
, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
executionRoleArn()
The ARN of the IAM role that the partner application uses.<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.PartnerAppMaintenanceConfig
maintenanceConfig()
Maintenance configuration settings for the SageMaker Partner AI App.String
name()
The name to give the SageMaker Partner AI App.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends CreatePartnerAppRequest.Builder>
serializableBuilderClass()
List<Tag>
tags()
Each tag consists of a key and an optional value.String
tier()
Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.CreatePartnerAppRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.PartnerAppType
type()
The type of SageMaker Partner AI App to create.String
typeAsString()
The type of SageMaker Partner AI App to create.-
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
-
name
public final String name()
The name to give the SageMaker Partner AI App.
- Returns:
- The name to give the SageMaker Partner AI App.
-
type
public final PartnerAppType type()
The type of SageMaker Partner AI App to create. Must be one of the following:
lakera-guard
,comet
,deepchecks-llm-evaluation
, orfiddler
.If the service returns an enum value that is not available in the current SDK version,
type
will returnPartnerAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of SageMaker Partner AI App to create. Must be one of the following:
lakera-guard
,comet
,deepchecks-llm-evaluation
, orfiddler
. - See Also:
PartnerAppType
-
typeAsString
public final String typeAsString()
The type of SageMaker Partner AI App to create. Must be one of the following:
lakera-guard
,comet
,deepchecks-llm-evaluation
, orfiddler
.If the service returns an enum value that is not available in the current SDK version,
type
will returnPartnerAppType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of SageMaker Partner AI App to create. Must be one of the following:
lakera-guard
,comet
,deepchecks-llm-evaluation
, orfiddler
. - See Also:
PartnerAppType
-
executionRoleArn
public final String executionRoleArn()
The ARN of the IAM role that the partner application uses.
- Returns:
- The ARN of the IAM role that the partner application uses.
-
maintenanceConfig
public final PartnerAppMaintenanceConfig maintenanceConfig()
Maintenance configuration settings for the SageMaker Partner AI App.
- Returns:
- Maintenance configuration settings for the SageMaker Partner AI App.
-
tier
public final String tier()
Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
- Returns:
- Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App.
-
applicationConfig
public final PartnerAppConfig applicationConfig()
Configuration settings for the SageMaker Partner AI App.
- Returns:
- Configuration settings for the SageMaker Partner AI App.
-
authType
public final PartnerAppAuthType authType()
The authorization type that users use to access the SageMaker Partner AI App.
If the service returns an enum value that is not available in the current SDK version,
authType
will returnPartnerAppAuthType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthTypeAsString()
.- Returns:
- The authorization type that users use to access the SageMaker Partner AI App.
- See Also:
PartnerAppAuthType
-
authTypeAsString
public final String authTypeAsString()
The authorization type that users use to access the SageMaker Partner AI App.
If the service returns an enum value that is not available in the current SDK version,
authType
will returnPartnerAppAuthType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthTypeAsString()
.- Returns:
- The authorization type that users use to access the SageMaker Partner AI App.
- See Also:
PartnerAppAuthType
-
enableIamSessionBasedIdentity
public final Boolean enableIamSessionBasedIdentity()
When set to
TRUE
, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.- Returns:
- When set to
TRUE
, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user.
-
clientToken
public final String clientToken()
A unique token that guarantees that the call to this API is idempotent.
- Returns:
- A unique token that guarantees that the call to this API is idempotent.
-
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()
Each tag consists of a key and an optional value. Tag keys must be unique per resource.
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:
- Each tag consists of a key and an optional value. Tag keys must be unique per resource.
-
toBuilder
public CreatePartnerAppRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreatePartnerAppRequest.Builder,CreatePartnerAppRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static CreatePartnerAppRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreatePartnerAppRequest.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
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-