Class StartNotebookImportRequest

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.StartNotebookImportRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartNotebookImportRequest.Builder,StartNotebookImportRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartNotebookImportRequest extends DataZoneRequest implements ToCopyableBuilder<StartNotebookImportRequest.Builder,StartNotebookImportRequest>

  • Method Details

    • domainIdentifier

      public final String domainIdentifier()

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

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

    • owningProjectIdentifier

      public final String owningProjectIdentifier()

      The identifier of the project that will own the imported notebook.

      Returns:
      The identifier of the project that will own the imported notebook.

    • sourceLocation

      public final SourceLocation sourceLocation()

      The source location of the notebook to import. Specify either a single Amazon Simple Storage Service URI, or a list of objects to import as the notebook's cells.

      Returns:
      The source location of the notebook to import. Specify either a single Amazon Simple Storage Service URI, or a list of objects to import as the notebook's cells.

    • name

      public final String name()

      The name of the imported notebook. The name must be between 1 and 256 characters.

      Returns:
      The name of the imported notebook. The name must be between 1 and 256 characters.

    • description

      public final String description()

      The description of the imported notebook.

      Returns:
      The description of the imported notebook.

    • type

      public final NotebookType type()

      The type of the notebook to import. If not specified, defaults to DATA.

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

      Returns:
      The type of the notebook to import. If not specified, defaults to DATA.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the notebook to import. If not specified, defaults to DATA.

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

      Returns:
      The type of the notebook to import. If not specified, defaults to DATA.
      See Also:

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

    • builder

      public static StartNotebookImportRequest.Builder builder()

    • serializableBuilderClass

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