Class UpdateNotebookRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateNotebookRequest.Builder,
UpdateNotebookRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 String
The ID of the notebook to update.final String
payload()
The updated content for the notebook.static Class
<? extends UpdateNotebookRequest.Builder> final String
The active notebook session ID.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.final NotebookType
type()
The notebook content type.final String
The notebook content type.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
notebookId
The ID of the notebook to update.
- Returns:
- The ID of the notebook to update.
-
payload
The updated content for the notebook.
- Returns:
- The updated content for the notebook.
-
type
The notebook content type. Currently, the only valid type is
IPYNB
.If the service returns an enum value that is not available in the current SDK version,
type
will returnNotebookType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The notebook content type. Currently, the only valid type is
IPYNB
. - See Also:
-
typeAsString
The notebook content type. Currently, the only valid type is
IPYNB
.If the service returns an enum value that is not available in the current SDK version,
type
will returnNotebookType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The notebook content type. Currently, the only valid type is
IPYNB
. - See Also:
-
sessionId
The active notebook session ID. Required if the notebook has an active session.
- Returns:
- The active notebook session ID. Required if the notebook has an active session.
-
clientRequestToken
A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
- Returns:
- A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes
only once).
This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.
-
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<UpdateNotebookRequest.Builder,
UpdateNotebookRequest> - Specified by:
toBuilder
in classAthenaRequest
- 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
-