Interface ExportOptions.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ExportOptions.Builder,ExportOptions>, SdkBuilder<ExportOptions.Builder,ExportOptions>, SdkPojo
Enclosing class:
ExportOptions
@Mutable @NotThreadSafe public static interface ExportOptions.Builder extends SdkPojo, CopyableBuilder<ExportOptions.Builder,ExportOptions>

  • Method Details

    • types

      ExportOptions.Builder types(Collection<String> types)

      A list of saved object types to include in the migration. Valid values include dashboard, visualization, index-pattern, search, and query.

      Parameters:
      types - A list of saved object types to include in the migration. Valid values include dashboard, visualization, index-pattern, search, and query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • types

      ExportOptions.Builder types(String... types)

      A list of saved object types to include in the migration. Valid values include dashboard, visualization, index-pattern, search, and query.

      Parameters:
      types - A list of saved object types to include in the migration. Valid values include dashboard, visualization, index-pattern, search, and query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objects

      ExportOptions.Builder objects(Collection<SavedObjectIdentifier> objects)

      A list of specific saved objects to include in the migration, identified by type and ID.

      Parameters:
      objects - A list of specific saved objects to include in the migration, identified by type and ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objects

      ExportOptions.Builder objects(SavedObjectIdentifier... objects)

      A list of specific saved objects to include in the migration, identified by type and ID.

      Parameters:
      objects - A list of specific saved objects to include in the migration, identified by type and ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • objects

      ExportOptions.Builder objects(Consumer<SavedObjectIdentifier.Builder>... objects)

      A list of specific saved objects to include in the migration, identified by type and ID.

      This is a convenience method that creates an instance of the SavedObjectIdentifier.Builder avoiding the need to create one manually via SavedObjectIdentifier.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to objects(List<SavedObjectIdentifier>).

      Parameters:
      objects - a consumer that will call methods on SavedObjectIdentifier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeReferencesDeep

      ExportOptions.Builder includeReferencesDeep(Boolean includeReferencesDeep)

      Specifies whether to include all objects referenced by the exported objects, recursively.

      Parameters:
      includeReferencesDeep - Specifies whether to include all objects referenced by the exported objects, recursively.
      Returns:
      Returns a reference to this object so that method calls can be chained together.