batch

Batch patches schemas using a CSV file as input.

Synopsis

Implements the API documented at https://developers.google.com/admin-sdk/directory/reference/rest/v1/schemas/patch

gsm schemas patch batch [flags]

Options

      --batchThreads int        Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
      --customerId int          Immutable ID of the Workspace account.
      --customerId_ALL string   Same as customerId but value is applied to all lines in the CSV file
      --delimiter string        Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
      --displayName int         Display name for the schema.
      --fields int              Fields allows partial responses to be retrieved.
                                See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
      --fields_ALL string       Same as fields but value is applied to all lines in the CSV file
  -h, --help                    help for batch
      --path string             Path of the import file (CSV)
      --schemaFields int        The fields that should be present in this schema.
                                Can be used multiple times in the form of: "--schemaFields "fieldName=<Some Name>;fieldType=<Type>;multValued=[true|false]...
                                The following properties are available:
                                fieldName       - The name of the field.
                                fieldType       - The type of the field.
                                				  Possible values are:
                                                    - STRING  - "Text"
                                                    - DATE    - "Date
                                                    - INT64   - "Whole Number"
                                                    - BOOL    - "Yes or no"
                                                    - DOUBLE  - "Decimal Number"
                                                    - PHONE   - "Phone"
                                                    - EMAIL   - "Email"
                                multiValued     - A boolean specifying whether this is a multi-valued field or not. Default: false.
                                indexed         - Boolean specifying whether the field is indexed or not. Default: true.
                                displayName     - Display Name of the field.
                                readAccessType  - Specifies who can view values of this field. See Retrieve users as a non-administrator for more information.
                                				  Note: It may take up to 24 hours for changes to this field to be reflected.
                                minValue        - Minimum value of this field.
                                				  This is meant to be indicative rather than enforced.
                                				  Values outside this range will still be indexed, but search may not be as performant.
                                maxValue        - Maximum value of this field.
                                				  This is meant to be indicative rather than enforced.
                                				  Values outside this range will still be indexed, but search may not be as performant.
      --schemaKey int           Name or immutable ID of the schema.
      --schemaName int          The schema's name.
      --skipHeader              Whether to skip the first row (header)

Options inherited from parent commands

      --compressOutput         By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
      --config string          config file (default is $HOME/.config/gsm/.gsm.yaml)
      --delay int              This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
      --dwdSubject string      Specify a subject used for DWD impersonation (overrides value in config file)
      --log string             Set the path of the log file. Default is either ~/gsm.log or defined in your config file
      --maxElapsedTime int     This is the maximum total time that will be spent retrying a request in minutes. (default 15)
      --maxRetryInterval int   This is the maximum interval that will be used between retry attempts in seconds. (default 320)
      --redirectPort int       This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
      --retryOn ints           Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
      --streamOutput           Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object

SEE ALSO

• gsm schemas patch - Patches a custom schema