mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-16 12:22:03 +00:00
gcloud: Wed Jan 25 10:09:52 UTC 2023
This commit is contained in:
parent
1248f773ec
commit
6dc17bdd4a
218 changed files with 6694 additions and 2033 deletions
73
gcloud/alpha/pubsub/schemas/commit
Normal file
73
gcloud/alpha/pubsub/schemas/commit
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
NAME
|
||||
gcloud alpha pubsub schemas commit - commit a Pub/Sub schema revision
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha pubsub schemas commit SCHEMA --type=TYPE
|
||||
(--definition=DEFINITION | --definition-file=DEFINITION_FILE)
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Commit a Pub/Sub schema revision.
|
||||
|
||||
EXAMPLES
|
||||
To commit a PROTOCOL_BUFFER schema revision called "key-schema" that
|
||||
requires exactly one-string field named "key", run:
|
||||
|
||||
$ gcloud alpha pubsub schemas commit key-schema \
|
||||
--definition="syntax = 'proto3'; message Message { optional \
|
||||
string key = 1; }" --type=protocol-buffer To commit an equivalent \
|
||||
AVRO schema revision, run:
|
||||
|
||||
$ gcloud alpha pubsub schemas commit key-schema \
|
||||
--definition="{ 'type': 'record', 'namespace': 'my.ns', 'name': \
|
||||
'KeyMsg', 'fields': [ { 'name': 'key', 'type': 'string' } ] }" \
|
||||
--type=avro
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Schema resource - Name of the schema to revise. This represents a Cloud
|
||||
resource. (NOTE) Some attributes are not given arguments in this group but
|
||||
can be set in other ways. To set the project attribute:
|
||||
◆ provide the argument schema on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
SCHEMA
|
||||
ID of the schema or fully qualified identifier for the schema. To set
|
||||
the schema attribute:
|
||||
▸ provide the argument schema on the command line.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--type=TYPE
|
||||
The type of the schema.
|
||||
|
||||
Schema definition
|
||||
|
||||
Exactly one of these must be specified:
|
||||
|
||||
--definition=DEFINITION
|
||||
The new definition of the schema.
|
||||
|
||||
--definition-file=DEFINITION_FILE
|
||||
File containing the new schema definition.
|
||||
|
||||
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 command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist. These variants are also available:
|
||||
|
||||
$ gcloud pubsub schemas commit
|
||||
|
||||
$ gcloud beta pubsub schemas commit
|
||||
|
||||
50
gcloud/alpha/pubsub/schemas/delete-revision
Normal file
50
gcloud/alpha/pubsub/schemas/delete-revision
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
NAME
|
||||
gcloud alpha pubsub schemas delete-revision - delete a Pub/Sub schema
|
||||
revision
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha pubsub schemas delete-revision SCHEMA [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Delete a Pub/Sub schema revision.
|
||||
|
||||
EXAMPLES
|
||||
To roll back to an existing schema revision called "key-schema" with
|
||||
revision_id: "0a0b0c0d", run:
|
||||
|
||||
$ gcloud alpha pubsub schemas delete-revision key-schema@0a0b0c0d
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Schema resource - Name of the schema revision to delete. This represents a
|
||||
Cloud resource. (NOTE) Some attributes are not given arguments in this
|
||||
group but can be set in other ways. To set the project attribute:
|
||||
◆ provide the argument schema on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
SCHEMA
|
||||
ID of the schema or fully qualified identifier for the schema. To set
|
||||
the schema attribute:
|
||||
▸ provide the argument schema on the command line.
|
||||
|
||||
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 command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist. These variants are also available:
|
||||
|
||||
$ gcloud pubsub schemas delete-revision
|
||||
|
||||
$ gcloud beta pubsub schemas delete-revision
|
||||
|
||||
|
|
@ -18,18 +18,30 @@ GCLOUD WIDE FLAGS
|
|||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
commit
|
||||
(ALPHA) Commit a Pub/Sub schema revision.
|
||||
|
||||
create
|
||||
(ALPHA) Create a Pub/Sub schema.
|
||||
|
||||
delete
|
||||
(ALPHA) Delete a Pub/Sub schema.
|
||||
|
||||
delete-revision
|
||||
(ALPHA) Delete a Pub/Sub schema revision.
|
||||
|
||||
describe
|
||||
(ALPHA) Show details of a Pub/Sub schema.
|
||||
|
||||
list
|
||||
(ALPHA) List Pub/Sub schemas.
|
||||
|
||||
list-revisions
|
||||
(ALPHA) List revisions of a Pub/Sub schema.
|
||||
|
||||
rollback
|
||||
(ALPHA) Roll back a Pub/Sub schema to a specified revision.
|
||||
|
||||
validate-message
|
||||
(ALPHA) Validate a message against a Pub/Sub schema.
|
||||
|
||||
|
|
|
|||
100
gcloud/alpha/pubsub/schemas/list-revisions
Normal file
100
gcloud/alpha/pubsub/schemas/list-revisions
Normal file
|
|
@ -0,0 +1,100 @@
|
|||
NAME
|
||||
gcloud alpha pubsub schemas list-revisions - list revisions of a Pub/Sub
|
||||
schema
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha pubsub schemas list-revisions SCHEMA
|
||||
[--view=VIEW; default="basic"] [--filter=EXPRESSION] [--limit=LIMIT]
|
||||
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) List revisions of a Pub/Sub schema.
|
||||
|
||||
EXAMPLES
|
||||
To list the revisions for a schema, run:
|
||||
|
||||
$ gcloud alpha pubsub schemas list-revisions my-schema
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Schema resource - Parent Pub/Sub schema to list all contained revisions.
|
||||
This represents a Cloud resource. (NOTE) Some attributes are not given
|
||||
arguments in this group but can be set in other ways. To set the project
|
||||
attribute:
|
||||
◆ provide the argument schema on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
SCHEMA
|
||||
ID of the schema or fully qualified identifier for the schema. To set
|
||||
the schema attribute:
|
||||
▸ provide the argument schema on the command line.
|
||||
|
||||
FLAGS
|
||||
--view=VIEW; default="basic"
|
||||
There are two possible views, 'basic' and 'full', default is 'basic'.
|
||||
VIEW must be one of:
|
||||
|
||||
basic
|
||||
Include the name and type of the schema, but not the definition.
|
||||
|
||||
full
|
||||
Include all Schema object fields.
|
||||
|
||||
LIST COMMAND FLAGS
|
||||
--filter=EXPRESSION
|
||||
Apply a Boolean filter EXPRESSION to each resource item to be listed.
|
||||
If the expression evaluates True, then that item is listed. For more
|
||||
details and examples of filter expressions, run $ gcloud topic filters.
|
||||
This flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--limit=LIMIT
|
||||
Maximum number of resources to list. The default is unlimited. This
|
||||
flag interacts with other flags that are applied in this order:
|
||||
--flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--page-size=PAGE_SIZE
|
||||
Some services group resource list output into pages. This flag
|
||||
specifies the maximum number of resources per page. The default is
|
||||
determined by the service if it supports paging, otherwise it is
|
||||
unlimited (no paging). Paging may be applied before or after --filter
|
||||
and --limit depending on the service.
|
||||
|
||||
--sort-by=[FIELD,...]
|
||||
Comma-separated list of resource field key names to sort by. The
|
||||
default order is ascending. Prefix a field with ``~'' for descending
|
||||
order on that field. This flag interacts with other flags that are
|
||||
applied in this order: --flatten, --sort-by, --filter, --limit.
|
||||
|
||||
--uri
|
||||
Print a list of resource URIs instead of the default output, and change
|
||||
the command output to a list of URIs. If this flag is used with
|
||||
--format, the formatting is applied on this URI list. To display URIs
|
||||
alongside other keys instead, use the uri() transform.
|
||||
|
||||
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.
|
||||
|
||||
API REFERENCE
|
||||
This command uses the pubsub/v1 API. The full documentation for this API
|
||||
can be found at: https://cloud.google.com/pubsub/docs
|
||||
|
||||
NOTES
|
||||
This command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist. These variants are also available:
|
||||
|
||||
$ gcloud pubsub schemas list-revisions
|
||||
|
||||
$ gcloud beta pubsub schemas list-revisions
|
||||
|
||||
56
gcloud/alpha/pubsub/schemas/rollback
Normal file
56
gcloud/alpha/pubsub/schemas/rollback
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
NAME
|
||||
gcloud alpha pubsub schemas rollback - roll back a Pub/Sub schema to a
|
||||
specified revision
|
||||
|
||||
SYNOPSIS
|
||||
gcloud alpha pubsub schemas rollback SCHEMA --revision-id=REVISION_ID
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(ALPHA) Roll back a Pub/Sub schema to a specified revision.
|
||||
|
||||
EXAMPLES
|
||||
To roll back to an existing schema revision called "key-schema" with
|
||||
revision_id: "0a0b0c0d", run:
|
||||
|
||||
$ gcloud alpha pubsub schemas rollback key-schema \
|
||||
--revision-id=0a0b0c0d
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
Schema resource - Name of the schema to rollback. This represents a Cloud
|
||||
resource. (NOTE) Some attributes are not given arguments in this group but
|
||||
can be set in other ways. To set the project attribute:
|
||||
◆ provide the argument schema on the command line with a fully
|
||||
specified name;
|
||||
◆ provide the argument --project on the command line;
|
||||
◆ set the property core/project.
|
||||
|
||||
This must be specified.
|
||||
|
||||
SCHEMA
|
||||
ID of the schema or fully qualified identifier for the schema. To set
|
||||
the schema attribute:
|
||||
▸ provide the argument schema on the command line.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--revision-id=REVISION_ID
|
||||
The revision to roll back to.
|
||||
|
||||
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 command is currently in alpha and might change without notice. If this
|
||||
command fails with API permission errors despite specifying the correct
|
||||
project, you might be trying to access an API with an invitation-only early
|
||||
access allowlist. These variants are also available:
|
||||
|
||||
$ gcloud pubsub schemas rollback
|
||||
|
||||
$ gcloud beta pubsub schemas rollback
|
||||
|
||||
|
|
@ -8,7 +8,9 @@ SYNOPSIS
|
|||
[--message-retention-duration=MESSAGE_RETENTION_DURATION]
|
||||
[--message-storage-policy-allowed-regions=[REGION,...]]
|
||||
[--message-encoding=ENCODING (--schema=SCHEMA
|
||||
: --schema-project=SCHEMA_PROJECT)]
|
||||
: --schema-project=SCHEMA_PROJECT)
|
||||
: --first-revision-id=FIRST_REVISION_ID
|
||||
--last-revision-id=LAST_REVISION_ID]
|
||||
[--topic-encryption-key=TOPIC_ENCRYPTION_KEY
|
||||
: --topic-encryption-key-keyring=TOPIC_ENCRYPTION_KEY_KEYRING
|
||||
--topic-encryption-key-location=TOPIC_ENCRYPTION_KEY_LOCATION
|
||||
|
|
@ -74,6 +76,12 @@ FLAGS
|
|||
This flag argument must be specified if any of the other arguments in
|
||||
this group are specified.
|
||||
|
||||
--first-revision-id=FIRST_REVISION_ID
|
||||
The id of the oldest revision allowed for the specified schema.
|
||||
|
||||
--last-revision-id=LAST_REVISION_ID
|
||||
The id of the most recent revision allowed for the specified schema
|
||||
|
||||
Schema resource - Name of the schema that messages published to this
|
||||
topic must conform to. The arguments in this group can be used to
|
||||
specify the attributes of this resource.
|
||||
|
|
|
|||
|
|
@ -6,6 +6,11 @@ SYNOPSIS
|
|||
[--clear-labels | --remove-labels=[KEY,...]]
|
||||
[--clear-message-retention-duration
|
||||
| --message-retention-duration=MESSAGE_RETENTION_DURATION]
|
||||
[--clear-schema-settings
|
||||
| [--message-encoding=ENCODING (--schema=SCHEMA
|
||||
: --schema-project=SCHEMA_PROJECT)
|
||||
: --first-revision-id=FIRST_REVISION_ID
|
||||
--last-revision-id=LAST_REVISION_ID]]
|
||||
[--message-storage-policy-allowed-regions=[REGION,...]
|
||||
| --recompute-message-storage-policy]
|
||||
[--topic-encryption-key=TOPIC_ENCRYPTION_KEY
|
||||
|
|
@ -124,6 +129,50 @@ FLAGS
|
|||
seconds, minutes, hours, and days, respectively. If the unit is
|
||||
omitted, seconds is assumed.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--clear-schema-settings
|
||||
If set, clear the Schema Settings from the topic.
|
||||
|
||||
Schema settings. The schema that messages published to this topic must
|
||||
conform to and the expected message encoding.
|
||||
|
||||
--message-encoding=ENCODING
|
||||
The encoding of messages validated against the schema. ENCODING
|
||||
must be one of: json, binary.
|
||||
|
||||
This flag argument must be specified if any of the other arguments
|
||||
in this group are specified.
|
||||
|
||||
--first-revision-id=FIRST_REVISION_ID
|
||||
The id of the oldest revision allowed for the specified schema.
|
||||
|
||||
--last-revision-id=LAST_REVISION_ID
|
||||
The id of the most recent revision allowed for the specified schema
|
||||
|
||||
Schema resource - Name of the schema that messages published to this
|
||||
topic must conform to. The arguments in this group can be used to
|
||||
specify the attributes of this resource.
|
||||
|
||||
This must be specified.
|
||||
|
||||
--schema=SCHEMA
|
||||
ID of the schema or fully qualified identifier for the schema. To
|
||||
set the schema attribute:
|
||||
◇ provide the argument --schema on the command line.
|
||||
|
||||
This flag argument must be specified if any of the other
|
||||
arguments in this group are specified.
|
||||
|
||||
--schema-project=SCHEMA_PROJECT
|
||||
Project ID of the Google Cloud project for the schema. To set the
|
||||
project attribute:
|
||||
◇ provide the argument --schema on the command line with a
|
||||
fully specified name;
|
||||
◇ provide the argument --schema-project on the command line;
|
||||
◇ provide the argument --project on the command line;
|
||||
◇ set the property core/project.
|
||||
|
||||
Message storage policy options.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue