1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-19 07:15:23 +00:00

gcloud: Wed Oct 30 10:13:17 UTC 2024

This commit is contained in:
Automated 2024-10-30 10:13:17 +00:00
parent fc66f7f0ca
commit d7d92f8000
166 changed files with 6197 additions and 300 deletions

View file

@ -0,0 +1,77 @@
NAME
gcloud beta eventarc message-buses create - create an Eventarc message bus
SYNOPSIS
gcloud beta eventarc message-buses create
(MESSAGE_BUS : --location=LOCATION) [--async] [--crypto-key=CRYPTO_KEY]
[--logging-config=LOGGING_CONFIG] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Create an Eventarc message bus.
EXAMPLES
To create a new message bus my-message-bus in location us-central1, run:
$ gcloud beta eventarc message-buses create my-message-bus \
--location=us-central1
POSITIONAL ARGUMENTS
Message bus resource - The message bus to create. The arguments in this
group can be used to specify the attributes of this 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 message_bus 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.
MESSAGE_BUS
ID of the message bus or fully qualified identifier for the message
bus.
To set the message-bus attribute:
▸ provide the argument message_bus on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location for the Eventarc message bus, which should be one of the
supported regions. Alternatively, set the [eventarc/location]
property.
To set the location attribute:
▸ provide the argument message_bus on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property eventarc/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--crypto-key=CRYPTO_KEY
Fully qualified name of the crypto key to use for customer-managed
encryption. If this is unspecified, Google-managed keys will be used
for encryption.
--logging-config=LOGGING_CONFIG
The logging config of the message bus. LOGGING_CONFIG must be one of:
NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
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 beta and might change without notice.

View file

@ -0,0 +1,67 @@
NAME
gcloud beta eventarc message-buses delete - delete an Eventarc message bus
SYNOPSIS
gcloud beta eventarc message-buses delete
(MESSAGE_BUS : --location=LOCATION) [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Delete an Eventarc message bus.
EXAMPLES
To delete the message bus my-message-bus in location us-central1, run:
$ gcloud beta eventarc message-buses delete my-message-bus \
--location=us-central1
POSITIONAL ARGUMENTS
Message bus resource - Message bus to delete. The arguments in this group
can be used to specify the attributes of this 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 message_bus 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.
MESSAGE_BUS
ID of the message bus or fully qualified identifier for the message
bus.
To set the message-bus attribute:
▸ provide the argument message_bus on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location for the Eventarc message bus, which should be one of the
supported regions. Alternatively, set the [eventarc/location]
property.
To set the location attribute:
▸ provide the argument message_bus on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property eventarc/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 beta and might change without notice.

View file

@ -0,0 +1,63 @@
NAME
gcloud beta eventarc message-buses describe - describe an Eventarc message
bus
SYNOPSIS
gcloud beta eventarc message-buses describe
(MESSAGE_BUS : --location=LOCATION) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Describe an Eventarc message bus.
EXAMPLES
To describe the message bus my-message-bus in location us-central1, run:
$ gcloud beta eventarc message-buses describe my-message-bus \
--location=us-central1
POSITIONAL ARGUMENTS
Message bus resource - Message bus to describe. The arguments in this
group can be used to specify the attributes of this 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 message_bus 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.
MESSAGE_BUS
ID of the message bus or fully qualified identifier for the message
bus.
To set the message-bus attribute:
▸ provide the argument message_bus on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location for the Eventarc message bus, which should be one of the
supported regions. Alternatively, set the [eventarc/location]
property.
To set the location attribute:
▸ provide the argument message_bus on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property eventarc/location.
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 beta and might change without notice.

View file

@ -0,0 +1,41 @@
NAME
gcloud beta eventarc message-buses - manage Eventarc message buses
SYNOPSIS
gcloud beta eventarc message-buses COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Eventarc message buses.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(BETA) Create an Eventarc message bus.
delete
(BETA) Delete an Eventarc message bus.
describe
(BETA) Describe an Eventarc message bus.
list
(BETA) List Eventarc message buses.
list-enrollments
(BETA) List Eventarc enrollments attached to an Eventarc message bus.
publish
(BETA) Publish to an Eventarc message bus.
update
(BETA) Update an Eventarc message bus.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,90 @@
NAME
gcloud beta eventarc message-buses list - list Eventarc message buses
SYNOPSIS
gcloud beta eventarc message-buses list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List Eventarc message buses.
EXAMPLES
To list all message buses in location us-central1, run:
$ gcloud beta eventarc message-buses list --location=us-central1
To list all message buses in all locations, run:
$ gcloud beta eventarc message-buses list --location=-
or
$ gcloud beta eventarc message-buses list
FLAGS
Location resource - The location for which to list message buses. This
should be one of the supported regions. 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 --location on the command line with a fully
specified name;
◆ set the property eventarc/location with a fully specified name;
◆ use '-' location to aggregate results for all Eventarc locations with
a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property eventarc/location;
▸ use '-' location to aggregate results for all Eventarc locations.
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.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,97 @@
NAME
gcloud beta eventarc message-buses list-enrollments - list Eventarc
enrollments attached to an Eventarc message bus
SYNOPSIS
gcloud beta eventarc message-buses list-enrollments
(MESSAGE_BUS : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) List Eventarc enrollments attached to an Eventarc message bus.
EXAMPLES
To list all enrollments in message-bus my-message-bus in us-central1, run:
$ gcloud beta eventarc message-buses list-enrollments \
my-message-bus --location=us-central1
POSITIONAL ARGUMENTS
Message bus resource - The message bus on which to list enrollments. The
arguments in this group can be used to specify the attributes of this
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 message_bus 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.
MESSAGE_BUS
ID of the message bus or fully qualified identifier for the message
bus.
To set the message-bus attribute:
▸ provide the argument message_bus on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location for the Eventarc message bus, which should be one of the
supported regions. Alternatively, set the [eventarc/location]
property.
To set the location attribute:
▸ provide the argument message_bus on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property eventarc/location.
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.
NOTES
This command is currently in beta and might change without notice.

View file

@ -0,0 +1,121 @@
NAME
gcloud beta eventarc message-buses publish - publish to an Eventarc message
bus
SYNOPSIS
gcloud beta eventarc message-buses publish
(MESSAGE_BUS : --location=LOCATION)
(--avro-message=AVRO_MESSAGE | --json-message=JSON_MESSAGE
| [--event-data=EVENT_DATA --event-id=EVENT_ID
--event-source=EVENT_SOURCE --event-type=EVENT_TYPE
: --event-attributes=[ATTRIBUTE=VALUE,...]]) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Publish to an Eventarc message bus.
EXAMPLES
To publish an event to the message bus my-message-bus with event id 1234,
event type event-provider.event.v1.eventType, event source
//event-provider/event/source, event data { "key": "value" } and event
attributes of attribute1=value, run:
$ gcloud beta eventarc message-buses publish my-message-bus \
--location=us-central1 --event-id=1234 \
--event-type=event-provider.event.v1.eventType \
--event-source="//event-provider/event/source" \
--event-data='{"key": "value"}' \
--event-attributes=attribute1=value
To publish an event to the message bus my-message-bus with a json message,
run:
$ gcloud beta eventarc message-buses publish my-message-bus \
--location=us-central1 \
--json-message='{"id": 1234, "type":
"event-provider.event.v1.eventType", "source":
"//event-provider/event/source", "specversion": "1.0", "data":
{"key": "value"}}'
POSITIONAL ARGUMENTS
Message bus resource - Message bus to publish to. The arguments in this
group can be used to specify the attributes of this 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 message_bus 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.
MESSAGE_BUS
ID of the message bus or fully qualified identifier for the message
bus.
To set the message-bus attribute:
▸ provide the argument message_bus on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location for the Eventarc message bus, which should be one of the
supported regions. Alternatively, set the [eventarc/location]
property.
To set the location attribute:
▸ provide the argument message_bus on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property eventarc/location.
REQUIRED FLAGS
Exactly one of these must be specified:
--avro-message=AVRO_MESSAGE
An Avro message to publish to the message bus.
--json-message=JSON_MESSAGE
A JSON message to publish to the message bus.
--event-data=EVENT_DATA
An event data. The event data of a published event.
This flag argument must be specified if any of the other arguments in
this group are specified.
--event-id=EVENT_ID
An event id. The id of a published event.
This flag argument must be specified if any of the other arguments in
this group are specified.
--event-source=EVENT_SOURCE
An event source. The event source of a published event.
This flag argument must be specified if any of the other arguments in
this group are specified.
--event-type=EVENT_TYPE
An event type. The event type of a published event.
This flag argument must be specified if any of the other arguments in
this group are specified.
--event-attributes=[ATTRIBUTE=VALUE,...]
Event attributes. The event attributes of a published event.This flag
can be repeated to add more attributes.
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 beta and might change without notice.

View file

@ -0,0 +1,92 @@
NAME
gcloud beta eventarc message-buses update - update an Eventarc message bus
SYNOPSIS
gcloud beta eventarc message-buses update
(MESSAGE_BUS : --location=LOCATION) [--async]
[--logging-config=LOGGING_CONFIG]
[--clear-crypto-key | --crypto-key=CRYPTO_KEY] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update an Eventarc message bus.
EXAMPLES
To update the message bus my-message-bus in location us-central1, run:
$ gcloud beta eventarc message-buses update my-message-bus \
--location=us-central1
To configure the message bus my-message-bus in location us-central1 with a
Cloud KMS CryptoKey, run:
$ gcloud beta eventarc message-buses update my-message-bus \
--location=us-central1 \
--crypto-key=projects/PROJECT_ID/locations/KMS_LOCATION/\
keyRings/KEYRING/cryptoKeys/KEY
POSITIONAL ARGUMENTS
Message bus resource - Message bus to update. The arguments in this group
can be used to specify the attributes of this 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 message_bus 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.
MESSAGE_BUS
ID of the message bus or fully qualified identifier for the message
bus.
To set the message-bus attribute:
▸ provide the argument message_bus on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location for the Eventarc message bus, which should be one of the
supported regions. Alternatively, set the [eventarc/location]
property.
To set the location attribute:
▸ provide the argument message_bus on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property eventarc/location.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--logging-config=LOGGING_CONFIG
The logging config of the message bus. LOGGING_CONFIG must be one of:
NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
At most one of these can be specified:
--clear-crypto-key
Remove the previously configured crypto key. The channel will
continue to be encrypted using Google-managed keys.
--crypto-key=CRYPTO_KEY
Fully qualified name of the crypto key to use for customer-managed
encryption. If this is unspecified, Google-managed keys will be used
for encryption.
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 beta and might change without notice.