Class CreateExplainabilityRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateExplainabilityRequest.Builder,
CreateExplainabilityRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DataSource
Returns the value of the DataSource property for this object.final Boolean
Create an Explainability visualization that is viewable within the Amazon Web Services console.final String
IfTimePointGranularity
is set toSPECIFIC
, define the last time point for the Explainability.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExplainabilityConfig
The configuration settings that define the granularity of time series and time points for the Explainability.final String
A unique name for the Explainability.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.final Schema
schema()
Returns the value of the Schema property for this object.static Class
<? extends CreateExplainabilityRequest.Builder> final String
IfTimePointGranularity
is set toSPECIFIC
, define the first point for the Explainability.tags()
Optional metadata to help you categorize and organize your resources.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
explainabilityName
A unique name for the Explainability.
- Returns:
- A unique name for the Explainability.
-
resourceArn
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
- Returns:
- The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
-
explainabilityConfig
The configuration settings that define the granularity of time series and time points for the Explainability.
- Returns:
- The configuration settings that define the granularity of time series and time points for the Explainability.
-
dataSource
Returns the value of the DataSource property for this object.- Returns:
- The value of the DataSource property for this object.
-
schema
Returns the value of the Schema property for this object.- Returns:
- The value of the Schema property for this object.
-
enableVisualization
Create an Explainability visualization that is viewable within the Amazon Web Services console.
- Returns:
- Create an Explainability visualization that is viewable within the Amazon Web Services console.
-
startDateTime
If
TimePointGranularity
is set toSPECIFIC
, define the first point for the Explainability.Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
- Returns:
- If
TimePointGranularity
is set toSPECIFIC
, define the first point for the Explainability.Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
-
endDateTime
If
TimePointGranularity
is set toSPECIFIC
, define the last time point for the Explainability.Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
- Returns:
- If
TimePointGranularity
is set toSPECIFIC
, define the last time point for the Explainability.Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
-
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
Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
-
For each resource, each tag key must be unique and each tag key must have one value.
-
Maximum number of tags per resource: 50.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
-
Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
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:
- Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an
optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
-
For each resource, each tag key must be unique and each tag key must have one value.
-
Maximum number of tags per resource: 50.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
-
Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateExplainabilityRequest.Builder,
CreateExplainabilityRequest> - Specified by:
toBuilder
in classForecastRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-