Class: Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec

Inherits:

Object

Object
Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/dataplex/v1/catalog.rb

Overview

Export job specification.

Defined Under Namespace

Classes: ExportJobScope

Instance Attribute Summary collapse

#output_path ⇒ ::String
Required.
#scope ⇒ ::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope
Required.

Instance Attribute Details

#output_path ⇒ `::String`

Returns Required. The root path of the exported metadata. Must be in the format: "gs://" Or specify a customized prefix after the bucket: "gs://///.../". The length limit of the customized prefix is 128 characters. The bucket must be in the same VPC-SC perimeter with the job.

Returns:

(::String) —
Required. The root path of the exported metadata. Must be in the format: "gs://" Or specify a customized prefix after the bucket: "gs://///.../". The length limit of the customized prefix is 128 characters. The bucket must be in the same VPC-SC perimeter with the job.

# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1542

class ExportJobSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Scope of the export job.
  # @!attribute [rw] organization_level
  #   @return [::Boolean]
  #     Indicating if it is an organization level export job.
  #     - When set to true, exports all entries from entry groups and projects
  #     sharing the same organization id of the Metadata Job. Only projects and
  #     entry groups in the VPC-SC perimeter will be exported. The projects and
  #     entry groups are ignored.
  #     - When set to false, one of the projects or entry groups must be
  #     specified.
  #     - Default to false.
  # @!attribute [rw] projects
  #   @return [::Array<::String>]
  #     The projects that are in the scope of the export job. Can either be
  #     project numbers or project IDs. If specified, only the entries from the
  #     specified projects will be exported. The projects must be in the same
  #     organization and in the VPC-SC perimeter. Either projects or
  #     entry_groups can be specified when organization_level_export is set to
  #     false.
  #     Must follow the format: "projects/<project_id_or_number>"
  # @!attribute [rw] entry_groups
  #   @return [::Array<::String>]
  #     The entry groups that are in scope for the export job. Optional. If
  #     specified, only entries in the specified entry groups will be exported
  #     by the job. Must be in the VPC-SC perimeter of the job. The location of
  #     the entry groups must be the same as the job. Either projects or
  #     entry_groups can be specified when organization_level_export is set to
  #     false. Must follow the format:
  #     "projects/<project_id_or_number>/locations/<location>/entryGroups/<entry_group_id>"
  # @!attribute [rw] entry_types
  #   @return [::Array<::String>]
  #     If specified, only entries of the specified types will be
  #     affected by the job.
  #     Must follow the format:
  #     "projects/<project_id_or_number>/locations/<location>/entryTypes/<entry_type_id>"
  # @!attribute [rw] aspect_types
  #   @return [::Array<::String>]
  #     The aspect types that are in scope for the export job.
  #     Optional. If specified, only aspects of the specified types will be
  #     affected by the job.
  #     Must follow the format:
  #     "projects/<project_id_or_number>/locations/<location>/aspectTypes/<aspect_type_id>"
  class ExportJobScope
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#scope ⇒ `::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec::ExportJobScope`

Returns Required. Selects the entries to be exported by this job.