gcloud: Thu Jan 19 00:56:33 UTC 2023

2026-07-08 02:25:19 +00:00 · 2023-01-19 00:56:33 +00:00 · 2023-01-19 00:56:33 +00:00 · 1248f773ec
commit 1248f773ec
parent 348d9760ee
1462 changed files with 51835 additions and 5402 deletions
--- a/gcloud/transfer/agents/install
+++ b/gcloud/transfer/agents/install
@ -3,7 +3,8 @@ NAME

 SYNOPSIS
    gcloud transfer agents install --pool=POOL [--count=COUNT]
-        [--creds-file=CREDS_FILE] [--enable-multipart] [--id-prefix=ID_PREFIX]
+        [--creds-file=CREDS_FILE] [--[no-]enable-multipart]
+        [--id-prefix=ID_PREFIX]
        [--logs-directory=LOGS_DIRECTORY; default="/tmp"]
        [--memlock-limit=MEMLOCK_LIMIT; default=64000000]
        [--mount-directories=[MOUNT-DIRECTORIES,...]] [--proxy=PROXY]
@ -15,15 +16,22 @@ DESCRIPTION
    locally on your machine and run inside Docker containers.

 EXAMPLES
+    To create an agent pool for your agent, see the gcloud transfer agent-pools
+    create command.
+
    To install an agent that authenticates with your user account credentials
    and has default agent parameters, run:

-        $ gcloud transfer agents install
+        $ gcloud transfer agents install --pool=AGENT_POOL
+
+    You will be prompted to run a command to generate a credentials file if one
+    does not already exist.

    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
+        $ gcloud transfer agents install --creds-file=/example/path.json \
+            --pool=AGENT_POOL

 REQUIRED FLAGS
     --pool=POOL
@ -48,11 +56,12 @@ OPTIONAL FLAGS
        Note that the credentials location will be mounted to the agent
        container.

-     --enable-multipart
+     --[no-]enable-multipart
        Split up files and transfer the resulting chunks in parallel before
        merging them at the destination. Can be used make transfers of large
        files faster as long as the network and disk speed are not limiting
-        factors.
+        factors. If unset, agent decides when to use the feature. Use
+        --enable-multipart to enable and --no-enable-multipart to disable.

     --id-prefix=ID_PREFIX
        An optional prefix to add to the agent ID to help identify the agent.
--- a/gcloud/transfer/jobs/create
+++ b/gcloud/transfer/jobs/create
@ -9,6 +9,9 @@ SYNOPSIS
          --destination-agent-pool=DESTINATION_AGENT_POOL
          --intermediate-storage-path=INTERMEDIATE_STORAGE_PATH
          --manifest-file=MANIFEST_FILE]
+        [--event-stream-name=EVENT_STREAM_NAME
+          --event-stream-starts=EVENT_STREAM_STARTS
+          --event-stream-expires=EVENT_STREAM_EXPIRES]
        [--do-not-run --schedule-starts=SCHEDULE_STARTS
          --schedule-repeats-every=SCHEDULE_REPEATS_EVERY
          --schedule-repeats-until=SCHEDULE_REPEATS_UNTIL]
@ -24,7 +27,7 @@ SYNOPSIS
        [--notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC
          --notification-event-types=[EVENT_TYPES,...]
          --notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT]
-        [--log-actions=[LOG_ACTIONS,...]
+        [--[no-]enable-posix-transfer-logs --log-actions=[LOG_ACTIONS,...]
          --log-action-states=[LOG_ACTION_STATES,...]]
        [--source-endpoint=SOURCE_ENDPOINT
          --source-signing-region=SOURCE_SIGNING_REGION
@ -153,6 +156,36 @@ FLAGS
          gs://mybucket/manifest.csv. For manifest file formatting, see
          https://cloud.google.com/storage-transfer/docs/manifest.

+     EVENT STREAM
+
+     Configure an event stream to transfer data whenever it is added or changed
+     at your source, enabling you to act on the data in near real time. This
+     event-driven transfer execution mode is available for transfers from
+     Google Cloud Storage and Amazon S3. For formatting information, see
+     https://cloud.google.com/sdk/gcloud/reference/topic/datetimes.
+
+       --event-stream-name=EVENT_STREAM_NAME
+          Specify an event stream that Storage Transfer Service can use to
+          listen for when objects are created or updated. For Google Cloud
+          Storage sources, specify a Cloud Pub/Sub subscription, using format
+          "projects/yourproject/subscriptions/yoursubscription". For Amazon S3
+          sources, specify the Amazon Resource Name (ARN) of an Amazon Simple
+          Queue Service (SQS) queue using format
+          "arn:aws:sqs:region:account_id:queue_name".
+
+       --event-stream-starts=EVENT_STREAM_STARTS
+          Set when to start listening for events UTC 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 start running
+          and listening for events upon the successful submission of the create
+          job command.
+
+       --event-stream-expires=EVENT_STREAM_EXPIRES
+          Set when to stop listening for events UTC 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 continue running
+          and listening for events indefinitely.
+
     SCHEDULE

     A job's schedule determines when and how often the job will run. For
@ -269,9 +302,20 @@ FLAGS

       --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.
+          Cloud Storage buckets. If unspecified, the objects' storage class is
+          set to the destination bucket default. Valid values are:
+
+          ▸ Any of the values listed in the Cloud Storage documentation:
+            Available storage classes
+            (https://cloud.google.com/storage/docs/storage-classes#classes).
+          ▸ preserve - Preserves each object's original storage class. Only
+            supported for transfers between Cloud Storage buckets.
+
+          Custom storage class settings are ignored if the destination bucket
+          is Autoclass-enabled
+          (https://cloud.google.com/storage/docs/autoclass). Objects
+          transferred into Autoclass-enabled buckets are initially set to the
+          STANDARD storage class.

     NOTIFICATION CONFIG

@ -302,6 +346,12 @@ FLAGS
     are generated for this job. Logs can be viewed by running the following
     command: gcloud logging read "resource.type=storage_transfer_job"

+       --[no-]enable-posix-transfer-logs
+          Sets whether to generate logs for transfers with a POSIX filesystem
+          source. This setting will later be merged with other log
+          configurations. Use --enable-posix-transfer-logs to enable and
+          --no-enable-posix-transfer-logs to disable.
+
       --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.,
--- a/gcloud/transfer/jobs/update
+++ b/gcloud/transfer/jobs/update
@ -12,6 +12,9 @@ SYNOPSIS
          --destination-agent-pool=DESTINATION_AGENT_POOL
          --intermediate-storage-path=INTERMEDIATE_STORAGE_PATH
          --manifest-file=MANIFEST_FILE]
+        [--event-stream-name=EVENT_STREAM_NAME
+          --event-stream-starts=EVENT_STREAM_STARTS
+          --event-stream-expires=EVENT_STREAM_EXPIRES --clear-event-stream]
        [--clear-schedule --schedule-starts=SCHEDULE_STARTS
          --schedule-repeats-every=SCHEDULE_REPEATS_EVERY
          --schedule-repeats-until=SCHEDULE_REPEATS_UNTIL]
@ -34,7 +37,8 @@ SYNOPSIS
          --notification-pubsub-topic=NOTIFICATION_PUBSUB_TOPIC
          --notification-event-types=[EVENT_TYPES,...]
          --notification-payload-format=NOTIFICATION_PAYLOAD_FORMAT]
-        [--clear-log-config --log-actions=[LOG_ACTIONS,...]
+        [--clear-log-config --[no-]enable-posix-transfer-logs
+          --log-actions=[LOG_ACTIONS,...]
          --log-action-states=[LOG_ACTION_STATES,...]]
        [--source-endpoint=SOURCE_ENDPOINT
          --source-signing-region=SOURCE_SIGNING_REGION
@ -176,6 +180,41 @@ FLAGS
          gs://mybucket/manifest.csv. For manifest file formatting, see
          https://cloud.google.com/storage-transfer/docs/manifest.

+     EVENT STREAM
+
+     Configure an event stream to transfer data whenever it is added or changed
+     at your source, enabling you to act on the data in near real time. This
+     event-driven transfer execution mode is available for transfers from
+     Google Cloud Storage and Amazon S3. For formatting information, see
+     https://cloud.google.com/sdk/gcloud/reference/topic/datetimes.
+
+       --event-stream-name=EVENT_STREAM_NAME
+          Specify an event stream that Storage Transfer Service can use to
+          listen for when objects are created or updated. For Google Cloud
+          Storage sources, specify a Cloud Pub/Sub subscription, using format
+          "projects/yourproject/subscriptions/yoursubscription". For Amazon S3
+          sources, specify the Amazon Resource Name (ARN) of an Amazon Simple
+          Queue Service (SQS) queue using format
+          "arn:aws:sqs:region:account_id:queue_name".
+
+       --event-stream-starts=EVENT_STREAM_STARTS
+          Set when to start listening for events UTC 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 start running
+          and listening for events upon the successful submission of the create
+          job command.
+
+       --event-stream-expires=EVENT_STREAM_EXPIRES
+          Set when to stop listening for events UTC 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 continue running
+          and listening for events indefinitely.
+
+       --clear-event-stream
+          Remove the job's entire event stream configuration by clearing all
+          scheduling all event stream flags. The job will no longer listen for
+          events unless a new configuratin is specified.
+
     SCHEDULE

     A job's schedule determines when and how often the job will run. For
@ -325,9 +364,20 @@ FLAGS

       --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.
+          Cloud Storage buckets. If unspecified, the objects' storage class is
+          set to the destination bucket default. Valid values are:
+
+          ▸ Any of the values listed in the Cloud Storage documentation:
+            Available storage classes
+            (https://cloud.google.com/storage/docs/storage-classes#classes).
+          ▸ preserve - Preserves each object's original storage class. Only
+            supported for transfers between Cloud Storage buckets.
+
+          Custom storage class settings are ignored if the destination bucket
+          is Autoclass-enabled
+          (https://cloud.google.com/storage/docs/autoclass). Objects
+          transferred into Autoclass-enabled buckets are initially set to the
+          STANDARD storage class.

     NOTIFICATION CONFIG

@ -368,6 +418,12 @@ FLAGS
       --clear-log-config
          Remove the job's full logging config.

+       --[no-]enable-posix-transfer-logs
+          Sets whether to generate logs for transfers with a POSIX filesystem
+          source. This setting will later be merged with other log
+          configurations. Use --enable-posix-transfer-logs to enable and
+          --no-enable-posix-transfer-logs to disable.
+
       --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.,