Class Endpoint
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.Endpoint
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Endpoint.Builder,Endpoint>
@Generated("software.amazon.awssdk:codegen") public final class Endpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Endpoint.Builder,Endpoint>
A hosted endpoint for real-time inference.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Endpoint.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Endpoint.Builder
builder()
Instant
creationTime()
The time that the endpoint was created.DataCaptureConfigSummary
dataCaptureConfig()
Returns the value of the DataCaptureConfig property for this object.String
endpointArn()
The Amazon Resource Name (ARN) of the endpoint.String
endpointConfigName()
The endpoint configuration associated with the endpoint.String
endpointName()
The name of the endpoint.EndpointStatus
endpointStatus()
The status of the endpoint.String
endpointStatusAsString()
The status of the endpoint.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
failureReason()
If the endpoint failed, the reason it failed.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasMonitoringSchedules()
For responses, this returns true if the service returned a value for the MonitoringSchedules property.boolean
hasProductionVariants()
For responses, this returns true if the service returned a value for the ProductionVariants property.boolean
hasShadowProductionVariants()
For responses, this returns true if the service returned a value for the ShadowProductionVariants property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Instant
lastModifiedTime()
The last time the endpoint was modified.List<MonitoringSchedule>
monitoringSchedules()
A list of monitoring schedules for the endpoint.List<ProductionVariantSummary>
productionVariants()
A list of the production variants hosted on the endpoint.List<SdkField<?>>
sdkFields()
static Class<? extends Endpoint.Builder>
serializableBuilderClass()
List<ProductionVariantSummary>
shadowProductionVariants()
A list of the shadow variants hosted on the endpoint.List<Tag>
tags()
A list of the tags associated with the endpoint.Endpoint.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
endpointName
public final String endpointName()
The name of the endpoint.
- Returns:
- The name of the endpoint.
-
endpointArn
public final String endpointArn()
The Amazon Resource Name (ARN) of the endpoint.
- Returns:
- The Amazon Resource Name (ARN) of the endpoint.
-
endpointConfigName
public final String endpointConfigName()
The endpoint configuration associated with the endpoint.
- Returns:
- The endpoint configuration associated with the endpoint.
-
hasProductionVariants
public final boolean hasProductionVariants()
For responses, this returns true if the service returned a value for the ProductionVariants 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.
-
productionVariants
public final List<ProductionVariantSummary> productionVariants()
A list of the production variants hosted on the endpoint. Each production variant is a model.
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
hasProductionVariants()
method.- Returns:
- A list of the production variants hosted on the endpoint. Each production variant is a model.
-
dataCaptureConfig
public final DataCaptureConfigSummary dataCaptureConfig()
Returns the value of the DataCaptureConfig property for this object.- Returns:
- The value of the DataCaptureConfig property for this object.
-
endpointStatus
public final EndpointStatus endpointStatus()
The status of the endpoint.
If the service returns an enum value that is not available in the current SDK version,
endpointStatus
will returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointStatusAsString()
.- Returns:
- The status of the endpoint.
- See Also:
EndpointStatus
-
endpointStatusAsString
public final String endpointStatusAsString()
The status of the endpoint.
If the service returns an enum value that is not available in the current SDK version,
endpointStatus
will returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointStatusAsString()
.- Returns:
- The status of the endpoint.
- See Also:
EndpointStatus
-
failureReason
public final String failureReason()
If the endpoint failed, the reason it failed.
- Returns:
- If the endpoint failed, the reason it failed.
-
creationTime
public final Instant creationTime()
The time that the endpoint was created.
- Returns:
- The time that the endpoint was created.
-
lastModifiedTime
public final Instant lastModifiedTime()
The last time the endpoint was modified.
- Returns:
- The last time the endpoint was modified.
-
hasMonitoringSchedules
public final boolean hasMonitoringSchedules()
For responses, this returns true if the service returned a value for the MonitoringSchedules 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.
-
monitoringSchedules
public final List<MonitoringSchedule> monitoringSchedules()
A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.
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
hasMonitoringSchedules()
method.- Returns:
- A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.
-
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()
A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
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:
- A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
-
hasShadowProductionVariants
public final boolean hasShadowProductionVariants()
For responses, this returns true if the service returned a value for the ShadowProductionVariants 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.
-
shadowProductionVariants
public final List<ProductionVariantSummary> shadowProductionVariants()
A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.
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
hasShadowProductionVariants()
method.- Returns:
- A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.
-
toBuilder
public Endpoint.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Endpoint.Builder,Endpoint>
-
builder
public static Endpoint.Builder builder()
-
serializableBuilderClass
public static Class<? extends Endpoint.Builder> serializableBuilderClass()
-
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.
-
-