imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00
Code Activity

gcloud: Wed Mar 16 08:47:18 UTC 2022

Browse source
This commit is contained in:
Automated 2022-03-16 08:47:18 +00:00
parent 7d82d0fc32
commit 971306823a
187 changed files with 3248 additions and 630 deletions
Download patch file Download diff file Expand all files Collapse all files

59
gcloud/transfer/agent-pools/create Normal file
View file

@ -0,0 +1,59 @@
NAME
gcloud transfer agent-pools create - create a Transfer Service agent pool
SYNOPSIS
gcloud transfer agent-pools create NAME [--no-async]
[--bandwidth-limit=BANDWIDTH_LIMIT] [--display-name=DISPLAY_NAME]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create an agent pool -- a group of agents used to connect to a source or
destination filesystem.
EXAMPLES
To create an agent pool with name 'my-pool', display name 'daily backups',
and no bandwidth limit, run:
$ gcloud transfer agent-pools create my-pool \
--display-name='daily backups'
To create an agent pool with name 'my-pool', display name 'daily backups',
and a bandwidth limit of 50 MB/s, run:
$ gcloud transfer agent-pools create my-pool \
--display-name="daily backups" --bandwidth-limit=50
POSITIONAL ARGUMENTS
NAME
A unique, permanent identifier for this pool.
FLAGS
--no-async
Block other tasks in your terminal until the pool has been created. If
not included, pool creation will run asynchronously.
--bandwidth-limit=BANDWIDTH_LIMIT
Set how much of your bandwidth to make available to this pool's agents.
A bandwidth limit applies to all agents in a pool and can help prevent
the pool's transfer workload from disrupting other operations that
share your bandwidth. For example, enter '50' to set a bandwidth limit
of 50 MB/s. By leaving this flag unspecified, this flag unspecified,
this pool's agents will use all bandwidth available to them.
--display-name=DISPLAY_NAME
A modifiable name to help you identify this pool. You can include
details that might not fit in the pool's unique full resource name.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer agent-pools create

39
gcloud/transfer/agent-pools/delete Normal file
View file

@ -0,0 +1,39 @@
NAME
gcloud transfer agent-pools delete - delete a Transfer Service agent pool
SYNOPSIS
gcloud transfer agent-pools delete NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete an agent pool. Note that before you can delete a pool, all the
pool's agents must be stopped, its associated jobs must be disabled, and
there must be no associated in-progress transfer operations.
EXAMPLES
To delete agent pool 'foo', run:
$ gcloud transfer agent-pools delete foo
To check if there are active operations associated with a pool before
deleting it, scroll through the results of:
$ gcloud transfer operations list --format=yaml \
--operation-statuses=in_progress
POSITIONAL ARGUMENTS
NAME
The name of the job you want to delete.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer agent-pools delete

32
gcloud/transfer/agent-pools/describe Normal file
View file

@ -0,0 +1,32 @@
NAME
gcloud transfer agent-pools describe - get details about a specific agent
pool
SYNOPSIS
gcloud transfer agent-pools describe NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get details about a specific agent pool.
EXAMPLES
To monitor an agent pool, run:
$ gcloud transfer agent-pools describe NAME
POSITIONAL ARGUMENTS
NAME
The name of the agent pool you want to describe.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer agent-pools describe

37
gcloud/transfer/agent-pools/help Normal file
View file

@ -0,0 +1,37 @@
NAME
gcloud transfer agent-pools - manage on-premise transfer agent pools
SYNOPSIS
gcloud transfer agent-pools COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage on-premise transfer agent pools.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a Transfer Service agent pool.
delete
Delete a Transfer Service agent pool.
describe
Get details about a specific agent pool.
list
List Transfer Service transfer agent pools.
update
Update a Transfer Service agent pool.
NOTES
This variant is also available:
$ gcloud alpha transfer agent-pools

50
gcloud/transfer/agent-pools/list Normal file
View file

@ -0,0 +1,50 @@
NAME
gcloud transfer agent-pools list - list Transfer Service transfer agent
pools
SYNOPSIS
gcloud transfer agent-pools list [--limit=LIMIT] [--names=[NAMES,...]]
[--page-size=PAGE_SIZE; default=256] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Transfer Service transfer pools in a given project to show their
configurations.
EXAMPLES
To list all agent pools in your current project, run:
$ gcloud transfer agent-pools list
To list agent pools named "foo" and "bar" in your project, run:
$ gcloud transfer agent-pools list --names=foo,bar
To list all information about jobs 'foo' and 'bar' formatted as JSON, run:
$ gcloud transfer agent-pools list --names=foo,bar --format=json
FLAGS
--limit=LIMIT
Return the first items from the API up to this limit.
--names=[NAMES,...]
The names of the agent pools you want to list. Separate multiple names
with commas (e.g., --name=foo,bar). If not specified, all agent pools
in your current project will be listed.
--page-size=PAGE_SIZE; default=256
Retrieve batches of this many items from the API.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer agent-pools list

66
gcloud/transfer/agent-pools/update Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud transfer agent-pools update - update a Transfer Service agent pool
SYNOPSIS
gcloud transfer agent-pools update NAME [--bandwidth-limit=BANDWIDTH_LIMIT]
[--clear-bandwidth-limit] [--clear-display-name]
[--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update an agent pool.
EXAMPLES
To remove the bandwidth limit for agent pool 'foo', run:
$ gcloud transfer agent-pools update foo --clear-bandwidth-limit
To remove the display name for agent pool 'foo', run:
$ gcloud transfer agent-pools update foo --clear-display-name
To update the bandwidth limit for agent pool 'foo' to 100 MB/s, run:
$ gcloud transfer agent-pools update foo --bandwidth-limit=100
To update the display name for agent pool 'foo' to 'example name', run:
$ gcloud transfer agent-pools update foo \
--display-name="example name"
POSITIONAL ARGUMENTS
NAME
A unique, permanent identifier for this pool.
FLAGS
--bandwidth-limit=BANDWIDTH_LIMIT
Set how much of your bandwidth to make available to this pool's agents.
A bandwidth limit applies to all agents in a pool and can help prevent
the pool's transfer workload from disrupting other operations that
share your bandwidth. For example, enter '50' to set a bandwidth limit
of 50 MB/s. By leaving this flag unspecified, this flag unspecified,
this pool's agents will use all bandwidth available to them.
--clear-bandwidth-limit
Remove the agent pool's bandwidth limit, which enables the pool's
agents to use all bandwidth available to them.
--clear-display-name
Remove the display name from the agent pool.
--display-name=DISPLAY_NAME
A modifiable name to help you identify this pool. You can include
details that might not fit in the pool's unique full resource name.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer agent-pools update

49
gcloud/transfer/agents/delete Normal file
View file

@ -0,0 +1,49 @@
NAME
gcloud transfer agents delete - delete a Transfer Service transfer agents
SYNOPSIS
gcloud transfer agents delete [--ids=[IDS,...] | --all | --uninstall]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete agents and remove agent resources from your machine.
EXAMPLES
If you plan to delete specific agents, you can list which agents are
running on your machine by running:
$ docker container list --all \
--filter ancestor=gcr.io/cloud-ingest/tsop-agent
Then run:
$ gcloud transfer agents delete --ids=id1,id2,...
FLAGS
At most one of these can be specified:
--ids=[IDS,...]
The IDs of the agents you want to delete. Separate multiple agent IDs
with commas, with no spaces following the commas.
--all
Delete all agents running on your machine.
--uninstall
Fully uninstall the agent Docker image in addition to deleting the
agents. Uninstalling the Docker image will free up space, but you'll
need to reinstall it to run agents on this machine in the future.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer agents delete

31
gcloud/transfer/agents/help Normal file
View file

@ -0,0 +1,31 @@
NAME
gcloud transfer agents - manage Transfer Service agents
SYNOPSIS
gcloud transfer agents COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage agents. Agents arre lightweight applications that enable Transfer
Service users to transfer data to or from POSIX filesystems, such as
on-premises filesystems. Agents are installed locally on your machine and
run within Docker containers.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
delete
Delete a Transfer Service transfer agents.
install
Install Transfer Service agents.
NOTES
This variant is also available:
$ gcloud alpha transfer agents

98
gcloud/transfer/agents/install Normal file
View file

@ -0,0 +1,98 @@
NAME
gcloud transfer agents install - install Transfer Service agents
SYNOPSIS
gcloud transfer agents install --pool=POOL [--count=COUNT]
[--creds-file=CREDS_FILE] [--id-prefix=ID_PREFIX]
[--logs-directory=LOGS_DIRECTORY; default="/tmp"]
[--memlock-limit=MEMLOCK_LIMIT; default=64000000]
[--mount-directories=[MOUNT-DIRECTORIES,...]] [--proxy=PROXY]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Install Transfer Service agents to enable you to transfer data to or from
POSIX filesystems, such as on-premises filesystems. Agents are installed
locally on your machine and run inside Docker containers.
EXAMPLES
To install an agent that authenticates with your user account credentials
and has default agent parameters, run:
$ gcloud transfer agents install
To install an agent that authenticates with a service account with
credentials stored at '/example/path.json', run:
$ gcloud transfer agents install --creds-file=/example/path.json
REQUIRED FLAGS
--pool=POOL
The agent pool to associate with the newly installed agent. When
creating transfer jobs, the agent pool parameter will determine which
agents are activated.
OPTIONAL FLAGS
--count=COUNT
Specify the number of agents to install on your current machine. System
requirements: 8 GB of memory and 4 CPUs per agent.
Note: If the 'id-prefix' flag is specified, Transfer Service increments
a number value after each prefix. Example: prefix1, prefix2, etc.
--creds-file=CREDS_FILE
Specify the path to the service account's credentials file.
No input required if authenticating with your user account credentials,
which Transfer Service will look for in your system.
Note that the credentials location will be mounted to the agent
container.
--id-prefix=ID_PREFIX
An optional prefix to add to the agent ID to help identify the agent.
--logs-directory=LOGS_DIRECTORY; default="/tmp"
Specify the absolute path to the directory you want to store transfer
logs in. If not specified, gcloud transfer will mount your /tmp
directory for logs.
--memlock-limit=MEMLOCK_LIMIT; default=64000000
Set the agent container's memlock limit. A value of 64000000 (default)
or higher is required to ensure that agent versions 1.14 or later have
enough locked memory to be able to start.
--mount-directories=[MOUNT-DIRECTORIES,...]
If you want to grant agents access to specific parts of your filesystem
instead of the entire filesystem, specify which directory paths to
mount to the agent container. Multiple paths must be separated by
commas with no spaces (e.g.,
--mount-directories=/system/path/to/dir1,/path/to/dir2). When mounting
specific directories, gcloud transfer will also mount a directory for
logs (either /tmp or what you've specified for --logs-directory) and
your Google credentials file for agent authentication.
If this flag is not specified, gcloud transfer will mount your entire
filesystem to the agent container.
--proxy=PROXY
Specify the HTTP URL and port of a proxy server if you want to use a
forward proxy. For example, to use the URL 'example.com' and port
'8080' specify 'http://www.example.com:8080/'
Ensure that you specify the HTTP URL and not an HTTPS URL to avoid
double-wrapping requests in TLS encryption. Double-wrapped requests
prevent the proxy server from sending valid outbound requests.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer agents install

55
gcloud/transfer/authorize Normal file
View file

@ -0,0 +1,55 @@
NAME
gcloud transfer authorize - authorize an account for all Transfer Service
features
SYNOPSIS
gcloud transfer authorize [--add-missing] [--creds-file=CREDS_FILE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Authorize a Google account for all Transfer Service features.
This command provides admin and owner rights for simplicity. If that's too
much authority for your use case, see custom setups here:
https://cloud.google.com/storage-transfer/docs/on-prem-set-up
EXAMPLES
To see what Transfer Service IAM roles the account logged into gcloud may
be missing, run:
$ gcloud transfer authorize
To add the missing IAM roles, run:
$ gcloud transfer authorize --add-missing
To check a custom service account for missing roles, run:
$ gcloud transfer authorize \
--creds-file=path/to/service-account-key.json
FLAGS
--add-missing
Add IAM roles necessary to use all Transfer Service features to the
specified account. By default, this command just prints missing roles.
--creds-file=CREDS_FILE
The path to the creds file for an account to authorize. The file should
be in JSON format and contain a "type" and "client_email", which are
automatically generated for most creds files downloaded from Google
(e.g. service account tokens). If this flag is not present, the command
authorizes the user currently logged into gcloud.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer authorize

46
gcloud/transfer/help Normal file
View file

@ -0,0 +1,46 @@
NAME
gcloud transfer - manage Transfer Service jobs, operations, and agents
SYNOPSIS
gcloud transfer GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
The gcloud transfer command group lets you create and manage Transfer
Service jobs, operations, and agents.
To get started, run: gcloud transfer jobs create --help
More info on prerequisite IAM permissions:
https://cloud.google.com/storage-transfer/docs/on-prem-set-up
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
agent-pools
Manage on-premise transfer agent pools.
agents
Manage Transfer Service agents.
jobs
Manage transfer jobs.
operations
Manage transfer operations.
COMMANDS
COMMAND is one of the following:
authorize
Authorize an account for all Transfer Service features.
NOTES
This variant is also available:
$ gcloud alpha transfer

335
gcloud/transfer/jobs/create Normal file
View file

@ -0,0 +1,335 @@
NAME
gcloud transfer jobs create - create a Transfer Service transfer job
SYNOPSIS
gcloud transfer jobs create SOURCE DESTINATION
[--name=NAME --description=DESCRIPTION
--source-creds-file=SOURCE_CREDS_FILE
--source-agent-pool=SOURCE_AGENT_POOL
--destination-agent-pool=DESTINATION_AGENT_POOL
--intermediate-storage-path=INTERMEDIATE_STORAGE_PATH
--manifest-file=MANIFEST_FILE]
[--do-not-run --schedule-starts=SCHEDULE_STARTS
--schedule-repeats-every=SCHEDULE_REPEATS_EVERY
--schedule-repeats-until=SCHEDULE_REPEATS_UNTIL]
[--include-prefixes=[INCLUDED_PREFIXES,...]
--exclude-prefixes=[EXCLUDED_PREFIXES,...]
--include-modified-before-absolute=INCLUDE_MODIFIED_BEFORE_ABSOLUTE
--include-modified-after-absolute=INCLUDE_MODIFIED_AFTER_ABSOLUTE
--include-modified-before-relative=INCLUDE_MODIFIED_BEFORE_RELATIVE
--include-modified-after-relative=INCLUDE_MODIFIED_AFTER_RELATIVE]
[--overwrite-when=OVERWRITE_WHEN --delete-from=DELETE_FROM
--preserve-metadata=[METADATA_FIELDS,...]
--custom-storage-class=CUSTOM_STORAGE_CLASS]
[--notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC
--notification-event-types=[EVENT_TYPES,...]
--notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT]
[--log-actions=[LOG_ACTIONS,...]
--log-action-states=[LOG_ACTION_STATES,...]] [--no-async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a Transfer Service transfer job, allowing you to transfer data to
Google Cloud Storage on a one-time or recurring basis.
EXAMPLES
To create a one-time, immediate transfer job to move data from Google Cloud
Storage bucket "foo" into the "baz" folder in Cloud Storage bucket "bar",
run:
$ gcloud transfer jobs create gs://foo gs://bar/baz/
To create a transfer job to move data from an Amazon S3 bucket called "foo"
to a Google Cloud Storage bucket named "bar" that runs every day with
custom name "my-test-job", run:
$ gcloud transfer jobs create s3://foo gs://bar --name=my-test-job \
--source-creds-file=/examplefolder/creds.txt \
--schedule-repeats-every=1d
To create a one-time, immediate transfer job to move data between Google
Cloud Storage buckets "foo" and "bar" with filters to include objects that
start with prefixes "baz" and "qux"; and objects modified in the 24 hours
before the transfer started, run:
$ gcloud transfer jobs create gs://foo gs://bar/ \
--include-prefixes=baz,qux --include-modified-after-relative=1d
To create a one-time, immediate transfer job to move data from a directory
with absolute path "/foo/bar/" in the filesystem associated with agent pool
"my-pool" into Google Cloud Storage bucket "example-bucket", run:
$ gcloud transfer jobs create posix:///foo/bar/ \
gs://example-bucket --source-agent-pool=my-pool
POSITIONAL ARGUMENTS
SOURCE
The source of your data. Available sources and formatting information:
Public clouds - For Google Cloud Storage and Amazon S3, specify the
scheme of the source type; name of the resource; and, if transferring
from a folder, the path to the folder. For Azure Storage, note the
Azure-specific formatting below. For example:
◆ [Google Cloud Storage] gs://example-bucket/example-folder
◆ [Amazon S3] s3://examplebucket/example-folder
◆ [Azure Blob Storage or Data Lake Storage]
http://examplestorageaccount.blob.core.windows.net/examplecontainer/examplefolder
POSIX filesystem - Specify the posix:// scheme followed by the full
path to the desired directory. POSIX filesystem - Specify the posix://
scheme followed by the absolute path to the desired directory, starting
from the root of the host machine (denoted by a leading slash). For
example:
◆ posix:///path/directory/
A file transfer agent must be installed on the POSIX filesystem, and
you need an agent pool flag on this jobs command to activate the agent.
Publicly-accessible objects - Specify the URL of a TSV file containing
a list of URLs of publicly-accessible objects. For example:
◆ http://example.com/tsvfile
DESTINATION
The destination of your transferred data. Available destinations and
formatting information:
Google Cloud Storage - Specify the gs:// scheme; name of the bucket;
and, if transferring to a folder, the path to the folder. For example:
◆ gs://example-bucket/example-folder
POSIX filesystem - Specify the posix:// scheme followed by the full
path to the desired directory. POSIX filesystem - Specify the posix://
scheme followed by the absolute path to the desired directory, starting
from the root of the host machine (denoted by a leading slash). For
example:
◆ posix:///path/directory/
A file transfer agent must be installed on the POSIX filesystem, and
you need an agent pool flag on this jobs command to activate the agent.
FLAGS
JOB INFORMATION
--name=NAME
A unique identifier for the job. Referring to your source and
destination is recommended. If left blank, the name is auto-generated
upon submission of the job.
--description=DESCRIPTION
An optional description to help identify the job using details that
don't fit in its name.
--source-creds-file=SOURCE_CREDS_FILE
Path to a local file on your machine that includes credentials for an
Amazon S3 or Azure Blob Storage source (not required for Google Cloud
Storage sources). If not specified for an S3 source, gcloud will
check your system for an AWS config file. However, this flag must be
specified to use AWS's "role_arn" auth service. For formatting, see:
S3:
https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#AwsAccessKey
Note: Be sure to put quotations around the JSON value strings.
Azure:
http://cloud/storage-transfer/docs/reference/rest/v1/TransferSpec#AzureCredentials
--source-agent-pool=SOURCE_AGENT_POOL
If using a POSIX filesystem source, specify the ID of the agent pool
associated with source filesystem.
--destination-agent-pool=DESTINATION_AGENT_POOL
If using a POSIX filesystem destination, specify the ID of the agent
pool associated with destination filesystem.
--intermediate-storage-path=INTERMEDIATE_STORAGE_PATH
If transferring between filesystems, specify the path to a folder in
a Google Cloud Storage bucket (gs://example-bucket/example-folder) to
use as intermediary storage. Recommended: Use an empty folder
reserved for this transfer job to ensure transferred data doesn't
interact with any of your existing Cloud Storage data.
--manifest-file=MANIFEST_FILE
Path to a .csv file in a Google Cloud Storage bucket containing a
list of files to transfer from your source. E.g.,
gs://mybucket/manifest.csv. For manifest file formatting, see
https://cloud.google.com/storage-transfer/docs/manifest.
SCHEDULE
A job's schedule determines when and how often the job will run. For
formatting information, see
https://cloud.google.com/sdk/gcloud/reference/topic/datetimes.
--do-not-run
Disable default Transfer Service behavior of running job upon
creation if no schedule is set. If this flag is specified, the job
won't run until an operation is manually started or a schedule is
added.
--schedule-starts=SCHEDULE_STARTS
Set when the job will start using the %Y-%m-%dT%H:%M:%S%z datetime
format (e.g., 2020-04-12T06:42:12+04:00). If not set, the job will
run upon the successful submission of the create job command unless
the --do-not-run flag is included.
--schedule-repeats-every=SCHEDULE_REPEATS_EVERY
Set the frequency of the job using the absolute duration format
(e.g., 1 month is p1m; 1 hour 30 minutes is 1h30m). If not set, the
job will run once.
--schedule-repeats-until=SCHEDULE_REPEATS_UNTIL
Set when the job will stop recurring using the %Y-%m-%dT%H:%M:%S%z
datetime format (e.g., 2020-04-12T06:42:12+04:00). If specified, you
must also include a value for the --schedule-repeats-every flag. If
not specified, the job will continue to repeat as specified in its
repeat-every field unless the job is manually disabled or you add
this field later.
OBJECT CONDITIONS
A set of conditions to determine which objects are transferred. For
time-based object condition formatting tips, see
https://cloud.google.com/sdk/gcloud/reference/topic/datetimes. Note: If
you specify multiple conditions, objects must have at least one of the
specified 'include' prefixes and all of the specified time conditions. If
an object has an 'exclude' prefix, it will be excluded even if it matches
other conditions.
--include-prefixes=[INCLUDED_PREFIXES,...]
Include only objects that start with the specified prefix(es).
Separate multiple prefixes with commas, omitting spaces after the
commas (e.g., --include-prefixes=foo,bar).
--exclude-prefixes=[EXCLUDED_PREFIXES,...]
Exclude any objects that start with the prefix(es) entered. Separate
multiple prefixes with commas, omitting spaces after the commas
(e.g., --exclude-prefixes=foo,bar).
--include-modified-before-absolute=INCLUDE_MODIFIED_BEFORE_ABSOLUTE
Include objects last modified before an absolute date/time. Ex. by
specifying '2020-01-01', the transfer would include objects last
modified before January 1, 2020. Use the %Y-%m-%dT%H:%M:%S%z datetime
format.
--include-modified-after-absolute=INCLUDE_MODIFIED_AFTER_ABSOLUTE
Include objects last modified after an absolute date/time. Ex. by
specifying '2020-01-01', the transfer would include objects last
modified after January 1, 2020. Use the %Y-%m-%dT%H:%M:%S%z datetime
format.
--include-modified-before-relative=INCLUDE_MODIFIED_BEFORE_RELATIVE
Include objects that were modified before a relative date/time in the
past. Ex. by specifying a duration of '10d', the transfer would
include objects last modified more than 10 days before its start
time. Use the absolute duration format (ex. 1m for 1 month; 1h30m for
1 hour 30 minutes).
--include-modified-after-relative=INCLUDE_MODIFIED_AFTER_RELATIVE
Include objects that were modified after a relative date/time in the
past. Ex. by specifying a duration of '10d', the transfer would
include objects last modified less than 10 days before its start
time. Use the absolute duration format (ex. 1m for 1 month; 1h30m for
1 hour 30 minutes).
TRANSFER OPTIONS
--overwrite-when=OVERWRITE_WHEN
Determine when destination objects are overwritten by source objects.
Options include:
▸ 'different' - Overwrites files with the same name if the contents
are different (e.g., if etags or checksums don't match)
▸ 'always' - Overwrite destination file whenever source file has
the same name -- even if they're identical
OVERWRITE_WHEN must be one of: always, different.
--delete-from=DELETE_FROM
By default, transfer jobs won't delete any data from your source or
destination. These options enable you to delete data if needed for
your use case. Options include:
▸ 'destination-if-unique' - Delete files from destination if
they're not also at source. Use to sync destination to source
(i.e., make destination match source exactly)
▸ 'source-after-transfer' - Delete files from source after they're
transferred
DELETE_FROM must be one of: destination-if-unique,
source-after-transfer.
--preserve-metadata=[METADATA_FIELDS,...]
Specify object metadata values that can optionally be preserved.
Example: --preserve-metadata=storage-class,uid
For more info, see:
https://cloud.google.com/storage-transfer/docs/metadata-preservation.
METADATA_FIELDS must be one of: acl, gid, kms-key, mode,
storage-class, symlink, temporary-hold, uid.
--custom-storage-class=CUSTOM_STORAGE_CLASS
Specifies the storage class to set on objects being transferred to
Google Cloud Storage buckets. If unspecified, the behavior is to
match the destination bucket default. The value "preserve" will use
the class from the object's Google Cloud Storage source bucket.
NOTIFICATION CONFIG
A configuration for receiving notifications oftransfer operation status
changes via Cloud Pub/Sub.
--notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC
Pub/Sub topic used for notifications.
--notification-event-types=[EVENT_TYPES,...]
Define which change of transfer operation status will trigger Pub/Sub
notifications. Choices include 'success', 'failed', 'aborted'. To
trigger notifications for all three status changes, you can leave
this flag unspecified as long as you've specified a topic for the
--notification-pubsub-topic flag. EVENT_TYPES must be one of:
success, failed, aborted.
--notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT
If 'none', no transfer operation details are included with
notifications. If 'json', a json representation of the relevant
transfer operation is included in notification messages (e.g., to see
errors after an operation fails). NOTIFICATION_PAYLOAD_FORMAT must be
one of: json, none.
LOGGING CONFIG
Configure which transfer actions and action states are reported when logs
are generated for this job. Logs can be viewed by running the following
command: gcloud logging read "resource.type=storage_transfer_job"
--log-actions=[LOG_ACTIONS,...]
Define the transfer operation actions to report in logs. Separate
multiple actions with commas, omitting spaces after the commas (e.g.,
--log-actions=find,copy). LOG_ACTIONS must be one of: copy, delete,
find.
--log-action-states=[LOG_ACTION_STATES,...]
The states in which the actions specified in --log-actions are
logged. Separate multiple states with a comma, omitting the space
after the comma (e.g., --log-action-states=succeeded,failed).
LOG_ACTION_STATES must be one of: failed, succeeded.
EXECUTION OPTIONS
--no-async
For jobs set to run upon creation, this flag blocks other tasks in
your terminal until the job's initial, immediate transfer operation
has completed. If not included, tasks will run asynchronously.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs create

31
gcloud/transfer/jobs/delete Normal file
View file

@ -0,0 +1,31 @@
NAME
gcloud transfer jobs delete - delete a Transfer Service transfer job
SYNOPSIS
gcloud transfer jobs delete NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a Transfer Service transfer job.
EXAMPLES
To delete job 'foo', run:
$ gcloud transfer jobs delete foo
POSITIONAL ARGUMENTS
NAME
The name of the job you want to delete.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs delete

41
gcloud/transfer/jobs/describe Normal file
View file

@ -0,0 +1,41 @@
NAME
gcloud transfer jobs describe - get configuration and latest operation
details about transfer job
SYNOPSIS
gcloud transfer jobs describe NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get configuration and latest operation details about a specific transfer
job.
EXAMPLES
To describe a job, run:
$ gcloud transfer jobs describe JOB-NAME
If you're looking for recent error details, use the "latestOperationName"
returned by this command as input to the "operations describe" command:
$ gcloud transfer jobs describe JOB-NAME \
--format="json(latestOperationName)"
$ gcloud transfer operations describe OPERATION-NAME
POSITIONAL ARGUMENTS
NAME
The name of the job you want to describe.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs describe

43
gcloud/transfer/jobs/help Normal file
View file

@ -0,0 +1,43 @@
NAME
gcloud transfer jobs - manage transfer jobs
SYNOPSIS
gcloud transfer jobs COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage transfer jobs.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a Transfer Service transfer job.
delete
Delete a Transfer Service transfer job.
describe
Get configuration and latest operation details about transfer job.
list
List Transfer Service transfer jobs.
monitor
Track progress in real time for a transfer job's latest operation.
run
Run a Transfer Service transfer job.
update
Update a Transfer Service transfer job.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs

70
gcloud/transfer/jobs/list Normal file
View file

@ -0,0 +1,70 @@
NAME
gcloud transfer jobs list - list Transfer Service transfer jobs
SYNOPSIS
gcloud transfer jobs list [--limit=LIMIT]
[--page-size=PAGE_SIZE; default=256] [--job-names=[JOB_NAMES,...]]
[--job-statuses=[JOB_STATUSES,...]] [--expand-table]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Transfer Service transfer jobs in a given project to show their
configurations and latest operations.
EXAMPLES
To list all jobs in your current project, run:
$ gcloud transfer jobs list
To list all disabled jobs in your project, run:
$ gcloud transfer jobs list --job-statuses=disabled
To list jobs 'foo' and 'bar', run:
$ gcloud transfer jobs list --job-names=foo,bar
To list all information about all jobs formatted as JSON, run:
$ gcloud transfer jobs list --format=json
To list all information about jobs 'foo' and 'bar' formatted as YAML, run:
$ gcloud transfer jobs list --job-names=foo,bar --format=YAML
FLAGS
--limit=LIMIT
Return the first items from the API up to this limit.
--page-size=PAGE_SIZE; default=256
Retrieve batches of this many items from the API.
--job-names=[JOB_NAMES,...]
The names of the jobs you want to list. Separate multiple job names
with commas (e.g., --job-names=foo,bar). If not specified, all jobs
will be listed.
--job-statuses=[JOB_STATUSES,...]
List only jobs with the statuses you specify. Options include
'enabled', 'disabled', 'deleted' (case insensitive). Separate multiple
statuses with commas (e.g., --job-statuses=enabled,deleted). If not
specified, all jobs will be listed.
--expand-table
Include additional table columns (job name, source, destination,
frequency, lastest operation name, job status) in command output. Tip:
increase the size of your terminal before running the command.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs list

40
gcloud/transfer/jobs/monitor Normal file
View file

@ -0,0 +1,40 @@
NAME
gcloud transfer jobs monitor - track progress in real time for a transfer
job's latest operation
SYNOPSIS
gcloud transfer jobs monitor NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Track progress in real time for a transfer job's latest operation.
EXAMPLES
To monitor a job, run:
$ gcloud transfer jobs monitor JOB-NAME
If you're looking for recent error details, use the "Operation name"
returned by this command as input to the "operations describe" command:
$ gcloud transfer jobs monitor JOB-NAME
$ gcloud transfer operations describe OPERATION-NAME
POSITIONAL ARGUMENTS
NAME
The name of the job you want to monitor (you'll see details for the
job's latest operation).
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs monitor

36
gcloud/transfer/jobs/run Normal file
View file

@ -0,0 +1,36 @@
NAME
gcloud transfer jobs run - run a Transfer Service transfer job
SYNOPSIS
gcloud transfer jobs run NAME [--no-async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Run a Transfer Service transfer job.
EXAMPLES
To run job 'foo', run:
$ gcloud transfer jobs run foo
POSITIONAL ARGUMENTS
NAME
The name of the job you want to run.
FLAGS
--no-async
Blocks other tasks in your terminal until the transfer operation has
completed. If not included, tasks will run asynchronously.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs run

390
gcloud/transfer/jobs/update Normal file
View file

@ -0,0 +1,390 @@
NAME
gcloud transfer jobs update - update a Transfer Service transfer job
SYNOPSIS
gcloud transfer jobs update NAME
[--status=STATUS --source=SOURCE --destination=DESTINATION
--clear-description --clear-source-creds-file
--clear-source-agent-pool --clear-destination-agent-pool
--clear-intermediate-storage-path --clear-manifest-file
--description=DESCRIPTION --source-creds-file=SOURCE_CREDS_FILE
--source-agent-pool=SOURCE_AGENT_POOL
--destination-agent-pool=DESTINATION_AGENT_POOL
--intermediate-storage-path=INTERMEDIATE_STORAGE_PATH
--manifest-file=MANIFEST_FILE]
[--clear-schedule --schedule-starts=SCHEDULE_STARTS
--schedule-repeats-every=SCHEDULE_REPEATS_EVERY
--schedule-repeats-until=SCHEDULE_REPEATS_UNTIL]
[--clear-include-prefixes --clear-exclude-prefixes
--clear-include-modified-before-absolute
--clear-include-modified-after-absolute
--clear-include-modified-before-relative
--clear-include-modified-after-relative
--include-prefixes=[INCLUDED_PREFIXES,...]
--exclude-prefixes=[EXCLUDED_PREFIXES,...]
--include-modified-before-absolute=INCLUDE_MODIFIED_BEFORE_ABSOLUTE
--include-modified-after-absolute=INCLUDE_MODIFIED_AFTER_ABSOLUTE
--include-modified-before-relative=INCLUDE_MODIFIED_BEFORE_RELATIVE
--include-modified-after-relative=INCLUDE_MODIFIED_AFTER_RELATIVE]
[--clear-delete-from --clear-preserve-metadata
--clear-custom-storage-class --overwrite-when=OVERWRITE_WHEN
--delete-from=DELETE_FROM --preserve-metadata=[METADATA_FIELDS,...]
--custom-storage-class=CUSTOM_STORAGE_CLASS]
[--clear-notification-config --clear-notification-event-types
--notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC
--notification-event-types=[EVENT_TYPES,...]
--notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT]
[--clear-log-config --log-actions=[LOG_ACTIONS,...]
--log-action-states=[LOG_ACTION_STATES,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update a Transfer Service transfer job.
EXAMPLES
To disable transfer job 'foo', run:
$ gcloud transfer jobs update foo --status=disabled
To remove the schedule for transfer job 'foo' so that it will only run when
you manually start it, run:
$ gcloud transfer jobs update foo --clear-schedule
To clear the values from the include=prefixes object condition in transfer
job 'foo', run:
$ gcloud transfer jobs update foo --clear-include-prefixes
POSITIONAL ARGUMENTS
NAME
Name of the transfer job you'd like to update.
FLAGS
JOB INFORMATION
--status=STATUS
Specify this flag to change the status of the job. Options include
'enabled', 'disabled', 'deleted'. STATUS must be one of: deleted,
disabled, enabled.
--source=SOURCE
The source of your data. Available sources and formatting
information:
Public clouds - For Google Cloud Storage and Amazon S3, specify the
scheme of the source type; name of the resource; and, if transferring
from a folder, the path to the folder. For Azure Storage, note the
Azure-specific formatting below. For example:
▸ [Google Cloud Storage] gs://example-bucket/example-folder
▸ [Amazon S3] s3://examplebucket/example-folder
▸ [Azure Blob Storage or Data Lake Storage]
http://examplestorageaccount.blob.core.windows.net/examplecontainer/examplefolder
POSIX filesystem - Specify the posix:// scheme followed by the full
path to the desired directory. POSIX filesystem - Specify the
posix:// scheme followed by the absolute path to the desired
directory, starting from the root of the host machine (denoted by a
leading slash). For example:
▸ posix:///path/directory/
A file transfer agent must be installed on the POSIX filesystem, and
you need an agent pool flag on this jobs command to activate the
agent.
Publicly-accessible objects - Specify the URL of a TSV file
containing a list of URLs of publicly-accessible objects. For
example:
▸ http://example.com/tsvfile
--destination=DESTINATION
The destination of your transferred data. Available destinations and
formatting information:
Google Cloud Storage - Specify the gs:// scheme; name of the bucket;
and, if transferring to a folder, the path to the folder. For
example:
▸ gs://example-bucket/example-folder
POSIX filesystem - Specify the posix:// scheme followed by the full
path to the desired directory. POSIX filesystem - Specify the
posix:// scheme followed by the absolute path to the desired
directory, starting from the root of the host machine (denoted by a
leading slash). For example:
▸ posix:///path/directory/
A file transfer agent must be installed on the POSIX filesystem, and
you need an agent pool flag on this jobs command to activate the
agent.
--clear-description
Remove the description from the transfer job.
--clear-source-creds-file
Remove the source creds file from the transfer job.
--clear-source-agent-pool
Remove the source agent pool from the transfer job.
--clear-destination-agent-pool
Remove the destination agent pool from the transfer job.
--clear-intermediate-storage-path
Remove the intermediate storage path from the transfer job.
--clear-manifest-file
Remove the manifest file from the transfer job.
--description=DESCRIPTION
An optional description to help identify the job using details that
don't fit in its name.
--source-creds-file=SOURCE_CREDS_FILE
Path to a local file on your machine that includes credentials for an
Amazon S3 or Azure Blob Storage source (not required for Google Cloud
Storage sources). If not specified for an S3 source, gcloud will
check your system for an AWS config file. However, this flag must be
specified to use AWS's "role_arn" auth service. For formatting, see:
S3:
https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#AwsAccessKey
Note: Be sure to put quotations around the JSON value strings.
Azure:
http://cloud/storage-transfer/docs/reference/rest/v1/TransferSpec#AzureCredentials
--source-agent-pool=SOURCE_AGENT_POOL
If using a POSIX filesystem source, specify the ID of the agent pool
associated with source filesystem.
--destination-agent-pool=DESTINATION_AGENT_POOL
If using a POSIX filesystem destination, specify the ID of the agent
pool associated with destination filesystem.
--intermediate-storage-path=INTERMEDIATE_STORAGE_PATH
If transferring between filesystems, specify the path to a folder in
a Google Cloud Storage bucket (gs://example-bucket/example-folder) to
use as intermediary storage. Recommended: Use an empty folder
reserved for this transfer job to ensure transferred data doesn't
interact with any of your existing Cloud Storage data.
--manifest-file=MANIFEST_FILE
Path to a .csv file in a Google Cloud Storage bucket containing a
list of files to transfer from your source. E.g.,
gs://mybucket/manifest.csv. For manifest file formatting, see
https://cloud.google.com/storage-transfer/docs/manifest.
SCHEDULE
A job's schedule determines when and how often the job will run. For
formatting information, see
https://cloud.google.com/sdk/gcloud/reference/topic/datetimes.
--clear-schedule
Remove the job's entire schedule by clearing all scheduling flags.
The job will no longer run unless an operation is manually started or
a new schedule is specified.
--schedule-starts=SCHEDULE_STARTS
Set when the job will start using the %Y-%m-%dT%H:%M:%S%z datetime
format (e.g., 2020-04-12T06:42:12+04:00). If not set, the job will
run upon the successful submission of the create job command unless
the --do-not-run flag is included.
--schedule-repeats-every=SCHEDULE_REPEATS_EVERY
Set the frequency of the job using the absolute duration format
(e.g., 1 month is p1m; 1 hour 30 minutes is 1h30m). If not set, the
job will run once.
--schedule-repeats-until=SCHEDULE_REPEATS_UNTIL
Set when the job will stop recurring using the %Y-%m-%dT%H:%M:%S%z
datetime format (e.g., 2020-04-12T06:42:12+04:00). If specified, you
must also include a value for the --schedule-repeats-every flag. If
not specified, the job will continue to repeat as specified in its
repeat-every field unless the job is manually disabled or you add
this field later.
OBJECT CONDITIONS
A set of conditions to determine which objects are transferred. For
time-based object condition formatting tips, see
https://cloud.google.com/sdk/gcloud/reference/topic/datetimes. Note: If
you specify multiple conditions, objects must have at least one of the
specified 'include' prefixes and all of the specified time conditions. If
an object has an 'exclude' prefix, it will be excluded even if it matches
other conditions.
--clear-include-prefixes
Remove the list of object prefixes to include from the object
conditions.
--clear-exclude-prefixes
Remove the list of object prefixes to exclude from the object
conditions.
--clear-include-modified-before-absolute
Remove the maximum modification datetime from the object conditions.
--clear-include-modified-after-absolute
Remove the minimum modification datetime from the object conditions.
--clear-include-modified-before-relative
Remove the maximum duration since modification from the object
conditions.
--clear-include-modified-after-relative
Remove the minimum duration since modification from the object
conditions.
--include-prefixes=[INCLUDED_PREFIXES,...]
Include only objects that start with the specified prefix(es).
Separate multiple prefixes with commas, omitting spaces after the
commas (e.g., --include-prefixes=foo,bar).
--exclude-prefixes=[EXCLUDED_PREFIXES,...]
Exclude any objects that start with the prefix(es) entered. Separate
multiple prefixes with commas, omitting spaces after the commas
(e.g., --exclude-prefixes=foo,bar).
--include-modified-before-absolute=INCLUDE_MODIFIED_BEFORE_ABSOLUTE
Include objects last modified before an absolute date/time. Ex. by
specifying '2020-01-01', the transfer would include objects last
modified before January 1, 2020. Use the %Y-%m-%dT%H:%M:%S%z datetime
format.
--include-modified-after-absolute=INCLUDE_MODIFIED_AFTER_ABSOLUTE
Include objects last modified after an absolute date/time. Ex. by
specifying '2020-01-01', the transfer would include objects last
modified after January 1, 2020. Use the %Y-%m-%dT%H:%M:%S%z datetime
format.
--include-modified-before-relative=INCLUDE_MODIFIED_BEFORE_RELATIVE
Include objects that were modified before a relative date/time in the
past. Ex. by specifying a duration of '10d', the transfer would
include objects last modified more than 10 days before its start
time. Use the absolute duration format (ex. 1m for 1 month; 1h30m for
1 hour 30 minutes).
--include-modified-after-relative=INCLUDE_MODIFIED_AFTER_RELATIVE
Include objects that were modified after a relative date/time in the
past. Ex. by specifying a duration of '10d', the transfer would
include objects last modified less than 10 days before its start
time. Use the absolute duration format (ex. 1m for 1 month; 1h30m for
1 hour 30 minutes).
TRANSFER OPTIONS
--clear-delete-from
Remove a specified deletion option from the transfer job. If this
flag is specified, the transfer job won't delete any data from your
source or destination.
--clear-preserve-metadata
Skips preserving optional metadata fields of objects being
transferred.
--clear-custom-storage-class
Reverts to using destination default storage class.
--overwrite-when=OVERWRITE_WHEN
Determine when destination objects are overwritten by source objects.
Options include:
▸ 'different' - Overwrites files with the same name if the contents
are different (e.g., if etags or checksums don't match)
▸ 'always' - Overwrite destination file whenever source file has
the same name -- even if they're identical
OVERWRITE_WHEN must be one of: always, different.
--delete-from=DELETE_FROM
By default, transfer jobs won't delete any data from your source or
destination. These options enable you to delete data if needed for
your use case. Options include:
▸ 'destination-if-unique' - Delete files from destination if
they're not also at source. Use to sync destination to source
(i.e., make destination match source exactly)
▸ 'source-after-transfer' - Delete files from source after they're
transferred
DELETE_FROM must be one of: destination-if-unique,
source-after-transfer.
--preserve-metadata=[METADATA_FIELDS,...]
Specify object metadata values that can optionally be preserved.
Example: --preserve-metadata=storage-class,uid
For more info, see:
https://cloud.google.com/storage-transfer/docs/metadata-preservation.
METADATA_FIELDS must be one of: acl, gid, kms-key, mode,
storage-class, symlink, temporary-hold, uid.
--custom-storage-class=CUSTOM_STORAGE_CLASS
Specifies the storage class to set on objects being transferred to
Google Cloud Storage buckets. If unspecified, the behavior is to
match the destination bucket default. The value "preserve" will use
the class from the object's Google Cloud Storage source bucket.
NOTIFICATION CONFIG
A configuration for receiving notifications oftransfer operation status
changes via Cloud Pub/Sub.
--clear-notification-config
Remove the job's full notification configuration to no longer receive
notifications via Cloud Pub/Sub.
--clear-notification-event-types
Remove the event types from the notification config.
--notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC
Pub/Sub topic used for notifications.
--notification-event-types=[EVENT_TYPES,...]
Define which change of transfer operation status will trigger Pub/Sub
notifications. Choices include 'success', 'failed', 'aborted'. To
trigger notifications for all three status changes, you can leave
this flag unspecified as long as you've specified a topic for the
--notification-pubsub-topic flag. EVENT_TYPES must be one of:
success, failed, aborted.
--notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT
If 'none', no transfer operation details are included with
notifications. If 'json', a json representation of the relevant
transfer operation is included in notification messages (e.g., to see
errors after an operation fails). NOTIFICATION_PAYLOAD_FORMAT must be
one of: json, none.
LOGGING CONFIG
Configure which transfer actions and action states are reported when logs
are generated for this job. Logs can be viewed by running the following
command: gcloud logging read "resource.type=storage_transfer_job"
--clear-log-config
Remove the job's full logging config.
--log-actions=[LOG_ACTIONS,...]
Define the transfer operation actions to report in logs. Separate
multiple actions with commas, omitting spaces after the commas (e.g.,
--log-actions=find,copy). LOG_ACTIONS must be one of: copy, delete,
find.
--log-action-states=[LOG_ACTION_STATES,...]
The states in which the actions specified in --log-actions are
logged. Separate multiple states with a comma, omitting the space
after the comma (e.g., --log-action-states=succeeded,failed).
LOG_ACTION_STATES must be one of: failed, succeeded.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer jobs update

31
gcloud/transfer/operations/cancel Normal file
View file

@ -0,0 +1,31 @@
NAME
gcloud transfer operations cancel - cancel a transfer operation
SYNOPSIS
gcloud transfer operations cancel NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Cancel a transfer operation.
EXAMPLES
To cancel an operation, run:
$ gcloud transfer operations cancel OPERATION-NAME
POSITIONAL ARGUMENTS
NAME
The name of the transfer operation you want to cancel.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer operations cancel

32
gcloud/transfer/operations/describe Normal file
View file

@ -0,0 +1,32 @@
NAME
gcloud transfer operations describe - get configuration and latest transfer
operation details
SYNOPSIS
gcloud transfer operations describe NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get details about a specific transfer operation.
EXAMPLES
To describe an operation, run:
$ gcloud transfer operations describe OPERATION-NAME
POSITIONAL ARGUMENTS
NAME
The name of the operation you want to describe.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer operations describe

40
gcloud/transfer/operations/help Normal file
View file

@ -0,0 +1,40 @@
NAME
gcloud transfer operations - manage transfer operations
SYNOPSIS
gcloud transfer operations COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage transfer operations.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
cancel
Cancel a transfer operation.
describe
Get configuration and latest transfer operation details.
list
List Transfer Service transfer operations.
monitor
Track progress in real time for a transfer operation.
pause
Pause a currently running transfer operation.
resume
Resume a currently paused transfer operation.
NOTES
This variant is also available:
$ gcloud alpha transfer operations

73
gcloud/transfer/operations/list Normal file
View file

@ -0,0 +1,73 @@
NAME
gcloud transfer operations list - list Transfer Service transfer operations
SYNOPSIS
gcloud transfer operations list [--limit=LIMIT]
[--page-size=PAGE_SIZE; default=256] [--job-names=[JOB_NAMES,...]]
[--operation-names=[OPERATION_NAMES,...]]
[--operation-statuses=[OPERATION_STATUSES,...]] [--expand-table]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Transfer Service transfer operations to view their progress details at
a glance.
EXAMPLES
To list all transfer operations in your current project, run:
$ gcloud transfer operations list
To list all failed operations in your project, run:
$ gcloud transfer operations list --operation-statuses=failed
To list operations 'foo' and 'bar', run:
$ gcloud transfer operations list --operation-names=foo,bar
To list all operations in your current project as JSON, which provides all
fields and formatting available in the API, run:
$ gcloud transfer operations list --format=json
FLAGS
--limit=LIMIT
Return the first items from the API up to this limit.
--page-size=PAGE_SIZE; default=256
Retrieve batches of this many items from the API.
--job-names=[JOB_NAMES,...]
The names of the jobs whose operations you want to list. Separate
multiple job names with commas (e.g., --job-names=foo,bar). If not
specified, operations for all jobs are listed.
--operation-names=[OPERATION_NAMES,...]
The names of operations you want to list. Separate multiple operation
names with commas (e.g., --operation-names-name=foo,bar). If not
specified, all operations are listed.
--operation-statuses=[OPERATION_STATUSES,...]
List only transfer operations with the statuses you specify. Options
include 'in_progress', 'paused', 'success','failed', 'aborted'.
Separate multiple statuses with commas (e.g.,
--operation-statuses=failed,aborted).
--expand-table
Include additional table columns (operation name, start time, status,
data copied, status, has errors, job name) in command output. Tip:
increase the size of your terminal before running the command.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer operations list

37
gcloud/transfer/operations/monitor Normal file
View file

@ -0,0 +1,37 @@
NAME
gcloud transfer operations monitor - track progress in real time for a
transfer operation
SYNOPSIS
gcloud transfer operations monitor NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Track progress in real time for a transfer operation.
EXAMPLES
To monitor an operation, run:
$ gcloud transfer operations monitor OPERATION-NAME
If you're looking for specific error details, use the "operations describe"
command:
$ gcloud transfer operations describe OPERATION-NAME
POSITIONAL ARGUMENTS
NAME
The name of the operation you want to monitor.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer operations monitor

32
gcloud/transfer/operations/pause Normal file
View file

@ -0,0 +1,32 @@
NAME
gcloud transfer operations pause - pause a currently running transfer
operation
SYNOPSIS
gcloud transfer operations pause NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Pause a currently running transfer operation.
EXAMPLES
To pause an operation, run:
$ gcloud transfer operations pause OPERATION-NAME
POSITIONAL ARGUMENTS
NAME
The name of the paused transfer operation you want to cancel.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer operations pause

32
gcloud/transfer/operations/resume Normal file
View file

@ -0,0 +1,32 @@
NAME
gcloud transfer operations resume - resume a currently paused transfer
operation
SYNOPSIS
gcloud transfer operations resume NAME [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Resume a currently paused transfer operation.
EXAMPLES
To resume an operation, run:
$ gcloud transfer operations resume OPERATION-NAME
POSITIONAL ARGUMENTS
NAME
The name of the paused transfer operation you want to resume.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This variant is also available:
$ gcloud alpha transfer operations resume