Console
    Contact Us Start free

    Google Cloud Dataplex V1 Client - Class ImportJobSpec (1.1.1)

    Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ImportJobSpec.

    Job specification for a metadata import job

    Generated from protobuf message google.cloud.dataplex.v1.MetadataJob.ImportJobSpec

    Namespace

    Google \ Cloud \ Dataplex \ V1 \ MetadataJob

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ source_storage_uri
    string

    Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with / ) that contains the metadata import files for this job. A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file . You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension). In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/ . Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.

    ↳ source_create_time
    Google\Protobuf\Timestamp

    Optional. The time when the process that created the metadata import files began.

    ↳ scope
    ImportJobSpec\ImportJobScope

    Required. A boundary on the scope of impact that the metadata import job can have.

    ↳ entry_sync_mode
    int

    Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.

    ↳ aspect_sync_mode
    int

    Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.

    ↳ log_level
    int

    Optional. The level of logs to write to Cloud Logging for this job. Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs that might not be merited for all jobs. If unspecified, defaults to INFO .

    getSourceStorageUri

    Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with / ) that contains the metadata import files for this job.

    A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file . You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension). In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/ . Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.

    Returns
    Type
    Description
    string

    setSourceStorageUri

    Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with / ) that contains the metadata import files for this job.

    A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file . You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension). In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/ . Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSourceCreateTime

    Optional. The time when the process that created the metadata import files began.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasSourceCreateTime

    clearSourceCreateTime

    setSourceCreateTime

    Optional. The time when the process that created the metadata import files began.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getScope

    Required. A boundary on the scope of impact that the metadata import job can have.

    Returns
    Type
    Description
    ImportJobSpec\ImportJobScope |null

    hasScope

    clearScope

    setScope

    Required. A boundary on the scope of impact that the metadata import job can have.

    Parameter
    Name
    Description
    var
    ImportJobSpec\ImportJobScope
    Returns
    Type
    Description
    $this

    getEntrySyncMode

    Required. The sync mode for entries.

    Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.

    Returns
    Type
    Description
    int

    setEntrySyncMode

    Required. The sync mode for entries.

    Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getAspectSyncMode

    Required. The sync mode for aspects.

    Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.

    Returns
    Type
    Description
    int

    setAspectSyncMode

    Required. The sync mode for aspects.

    Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getLogLevel

    Optional. The level of logs to write to Cloud Logging for this job.

    Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs that might not be merited for all jobs. If unspecified, defaults to INFO .

    Returns
    Type
    Description
    int

    setLogLevel

    Optional. The level of logs to write to Cloud Logging for this job.

    Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs that might not be merited for all jobs. If unspecified, defaults to INFO .

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: