Adapter properties and commands

This section lists the properties and commands supported by the Google Drive adapter.

Adapter properties are used to configure the Google Drive adapter connections, actions, cards, and nodes in the Design Server Web UI.

When a map or flow is configured and built, the properties in the Google Drive cards and nodes are mapped to the adapter commands, which are used at runtime.

The adapter command line contains the generated adapter commands. It can be previewed in Design Server with the Use Command Line toggle in the Connection step in the Google Drive action, card, or node design workflow.

The following properties are supported by the adapter:

Credentials File

Specifies the file with the private key of the GCP service account used to access the Google Drive API service. It is the reference to the private key file of the GCP service account used to establish the Google Drive connection.

The corresponding adapter command is -CF (or -CREDENTIALSFILE).

Folder

Specifies the name of the folder that contains the file to access.

The corresponding adapter command is -F (or -FOLDER).

File

Specifies the name of the file to access. The Fetch button displayed next to the property can be used to retrieve the list of all files in a folder (if the folder is not specified, a list of all files in up to 10 folders), and a selection can be made from the list. Alternatively, you can type the name manually.

The corresponding adapter command is -FI (or -FILE).

Overwrite Object

Checkbox to allow overwriting of an already existing file. This checkbox should be selected to allow the adapter to overwrite an already existing file. If the checkbox is not selected, overwriting an already existing file will result in an error, shown with an appropriate message.

The corresponding adapter command is -OW (or -OVERWRITE).

Read Chunk Size (Bytes)

Size of chunks, in bytes, in which to retrieve data from the source file. When the property is not specified, is set to a non-positive value, or is set to a value exceeding 67108864 (64 MB), a default size of 8388608 (8 MB) is used.

The corresponding adapter command is -RCS (or -READCHUNKSIZE).

Logging

Specifies the settings for the adapter log severity, append mode, and file location. This property, along with its two sub-properties Append Log and Log File Name, is used to enable logging at the adapter level. When enabled, the adapter logs messages with details about the operations it is performing on the Google Drive API service. The default logging level is Info.

The corresponding adapter command is -T[V|E][+] [log_file] (or -TRACE[V|E][+] [log_file]).

-T (or -TRACE) -> The level Info is used to log informational level messages.

-TE (or -TRACEE) -> The level Error can be specified to enable logging of error level messages only.

-TV (or -TRACEV) -> The level Verbose can be used to enable logging of all messages.

+ -> The sub-property Append Log can be set to instruct the adapter to append messages to the log file if the log file exists already, instead of overwriting it, which is the default option.

log_file -> The sub-property Log File Name can be used to specify the file name for the log file. By default, the log file name is m4gdrive.mtr and the file is created in the current map directory.

Read Mode

Internal property that indicates the source operation the adapter needs to perform. This property is internally set to match the specified Operation, and it is mapped to the -READMODE adapter command. When creating the adapter command line manually, the -READMODE command needs to be manually included in the command line. The supported values for the property are as follows:

object_data (default)
object_list

The corresponding adapter command is -RM (or -READMODE).