Class UpdateNotebookRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.datazone.model.DataZoneRequest
software.amazon.awssdk.services.datazone.model.UpdateNotebookRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateNotebookRequest.Builder,UpdateNotebookRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateNotebookRequest extends DataZoneRequest implements ToCopyableBuilder<UpdateNotebookRequest.Builder,UpdateNotebookRequest>

  • Method Details

    • domainIdentifier

      public final String domainIdentifier()

      The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.

      Returns:
      The identifier of the Amazon SageMaker Unified Studio domain in which the notebook exists.

    • identifier

      public final String identifier()

      The identifier of the notebook to update.

      Returns:
      The identifier of the notebook to update.

    • description

      public final String description()

      The updated description of the notebook.

      Returns:
      The updated description of the notebook.

    • status

      public final NotebookStatus status()

      The updated status of the notebook.

      If the service returns an enum value that is not available in the current SDK version, status will return NotebookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The updated status of the notebook.
      See Also:

    • statusAsString

      public final String statusAsString()

      The updated status of the notebook.

      If the service returns an enum value that is not available in the current SDK version, status will return NotebookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The updated status of the notebook.
      See Also:

    • name

      public final String name()

      The updated name of the notebook.

      Returns:
      The updated name of the notebook.

    • hasCellOrder

      public final boolean hasCellOrder()
      For responses, this returns true if the service returned a value for the CellOrder property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • cellOrder

      public final List<CellInformation> cellOrder()

      The updated ordered list of cells in the notebook.

      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 hasCellOrder() method.

      Returns:
      The updated ordered list of cells in the notebook.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • metadata

      public final Map<String,String> metadata()

      The updated metadata for the notebook, specified as key-value pairs.

      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 hasMetadata() method.

      Returns:
      The updated metadata for the notebook, specified as key-value pairs.

    • hasParameters

      public final boolean hasParameters()
      For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • parameters

      public final Map<String,String> parameters()

      The updated sensitive parameters for the notebook, specified as key-value pairs.

      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 hasParameters() method.

      Returns:
      The updated sensitive parameters for the notebook, specified as key-value pairs.

    • environmentConfiguration

      public final EnvironmentConfig environmentConfiguration()

      The updated environment configuration for the notebook.

      Returns:
      The updated environment configuration for the notebook.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

      Returns:
      A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

    • toBuilder

      public UpdateNotebookRequest.Builder 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 interface ToCopyableBuilder<UpdateNotebookRequest.Builder,UpdateNotebookRequest>
      Specified by:
      toBuilder in class DataZoneRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateNotebookRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateNotebookRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.