software.amazon.awssdk.services.neptunedata.model

Class CreateMlEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.neptunedata.model.NeptunedataRequest

software.amazon.awssdk.services.neptunedata.model.CreateMlEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateMlEndpointRequest.Builder,CreateMlEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateMlEndpointRequest
extends NeptunedataRequest
implements ToCopyableBuilder<CreateMlEndpointRequest.Builder,CreateMlEndpointRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateMlEndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateMlEndpointRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() A unique identifier for the new inference endpoint.
Integer	instanceCount() The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction.
String	instanceType() The type of Neptune ML instance to use for online servicing.
String	mlModelTrainingJobId() The job Id of the completed model-training job that has created the model that the inference endpoint will point to.
String	mlModelTransformJobId() The job Id of the completed model-transform job.
String	modelName() Model type for training.
String	neptuneIamRoleArn() The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateMlEndpointRequest.Builder>	serializableBuilderClass()
CreateMlEndpointRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	update() If set to true, update indicates that this is an update request.
String	volumeEncryptionKMSKey() The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job.

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

id

public final String id()

A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.

Returns:

A unique identifier for the new inference endpoint. The default is an autogenerated timestamped name.

mlModelTrainingJobId

public final String mlModelTrainingJobId()

The job Id of the completed model-training job that has created the model that the inference endpoint will point to. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

Returns:

The job Id of the completed model-training job that has created the model that the inference endpoint will point to. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

mlModelTransformJobId

public final String mlModelTransformJobId()

The job Id of the completed model-transform job. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

Returns:

The job Id of the completed model-transform job. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

update

public final Boolean update()

If set to true, update indicates that this is an update request. The default is false. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

Returns:

If set to true, update indicates that this is an update request. The default is false. You must supply either the mlModelTrainingJobId or the mlModelTransformJobId.

neptuneIamRoleArn

public final String neptuneIamRoleArn()

The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.

Returns:

The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.

modelName

public final String modelName()

Model type for training. By default the Neptune ML model is automatically based on the modelType used in data processing, but you can specify a different model type here. The default is rgcn for heterogeneous graphs and kge for knowledge graphs. The only valid value for heterogeneous graphs is rgcn. Valid values for knowledge graphs are: kge, transe, distmult, and rotate.

Returns:

Model type for training. By default the Neptune ML model is automatically based on the modelType used in data processing, but you can specify a different model type here. The default is rgcn for heterogeneous graphs and kge for knowledge graphs. The only valid value for heterogeneous graphs is rgcn. Valid values for knowledge graphs are: kge, transe, distmult, and rotate.

instanceType

public final String instanceType()

The type of Neptune ML instance to use for online servicing. The default is ml.m5.xlarge. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.

Returns:

The type of Neptune ML instance to use for online servicing. The default is ml.m5.xlarge. Choosing the ML instance for an inference endpoint depends on the task type, the graph size, and your budget.

instanceCount

public final Integer instanceCount()

The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1

Returns:

The minimum number of Amazon EC2 instances to deploy to an endpoint for prediction. The default is 1

volumeEncryptionKMSKey

public final String volumeEncryptionKMSKey()

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

Returns:

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.

toBuilder

public CreateMlEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateMlEndpointRequest.Builder,CreateMlEndpointRequest>

Specified by:

toBuilder in class NeptunedataRequest

builder

public static CreateMlEndpointRequest.Builder builder()

serializableBuilderClass

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