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

gcloud: Wed Mar 8 10:34:05 UTC 2023

Browse source
This commit is contained in:
Automated 2023-03-08 10:34:05 +00:00
parent bdaa0b3cfc
commit 29661f002c
111 changed files with 1800 additions and 704 deletions
Download patch file Download diff file Expand all files Collapse all files

52
gcloud/alpha/monitoring/snoozes/cancel Normal file
View file

@ -0,0 +1,52 @@
NAME
gcloud alpha monitoring snoozes cancel - cancels a snooze
SYNOPSIS
gcloud alpha monitoring snoozes cancel SNOOZE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Cancels a snooze.
If the snooze is upcoming, i.e. the start time is in the future, then this
command is equivalent to:
▪ update --start-time="+PT1S" --end-time="+PT1S
Otherwise, if the snooze is active, i.e. the start time is past and the
ending time is in the future, then this command is equivalent to:
▪ update --end-time="+PT1S
For information about the JSON/YAML format of a snooze:
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.snoozes
POSITIONAL ARGUMENTS
Snooze resource - Name of the Snooze to be canceled. 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 snooze 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.
SNOOZE
ID of the Snooze or fully qualified identifier for the Snooze. To set
the snooze attribute:
▸ provide the argument snooze 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.

53
gcloud/alpha/monitoring/snoozes/create Normal file
View file

@ -0,0 +1,53 @@
NAME
gcloud alpha monitoring snoozes create - create a new snooze
SYNOPSIS
gcloud alpha monitoring snoozes create
[--snooze-from-file=SNOOZE_FROM_FILE]
[--criteria-policies=CRITERIA_POLICIES,[...]
--display-name=DISPLAY_NAME
--end-time=END_TIME --start-time=START_TIME] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Creates a new snooze. A snooze can be specified as a JSON/YAML
value passed in as a file through the --snooze-from-file flag. A snooze can
also be specified through command line flags. If a snooze is specified
through --snooze-from-file, and additional flags are supplied, the flags
will override the snooze's settings.
For information about the JSON/YAML format of a snooze:
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.snoozes
FLAGS
--snooze-from-file=SNOOZE_FROM_FILE
The path to a JSON or YAML file containing the snooze.
Snooze Settings. If any of these are specified, they will overwrite fields
in the --snooze-from-file flags if specified.
--criteria-policies=CRITERIA_POLICIES,[...]
The policies that the Snooze applies to.
--display-name=DISPLAY_NAME
The display name for the Snooze.
--end-time=END_TIME
The start time for the Snooze.
--start-time=START_TIME
The start time for the Snooze.
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.

39
gcloud/alpha/monitoring/snoozes/describe Normal file
View file

@ -0,0 +1,39 @@
NAME
gcloud alpha monitoring snoozes describe - describe a snooze
SYNOPSIS
gcloud alpha monitoring snoozes describe SNOOZE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a snooze.
POSITIONAL ARGUMENTS
Snooze resource - Name of the Snooze to be described. 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 snooze 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.
SNOOZE
ID of the Snooze or fully qualified identifier for the Snooze. To set
the snooze attribute:
▸ provide the argument snooze 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.

41
gcloud/alpha/monitoring/snoozes/help Normal file
View file

@ -0,0 +1,41 @@
NAME
gcloud alpha monitoring snoozes - manage Cloud Monitoring snoozes
SYNOPSIS
gcloud alpha monitoring snoozes COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Monitoring snoozes.
More information can be found here:
https://cloud.google.com/monitoring/api/v3/
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
cancel
(ALPHA) Cancels a snooze.
create
(ALPHA) Create a new snooze.
describe
(ALPHA) Describe a snooze.
list
(ALPHA) List snoozes.
update
(ALPHA) Updates a snooze.
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.

86
gcloud/alpha/monitoring/snoozes/list Normal file
View file

@ -0,0 +1,86 @@
NAME
gcloud alpha monitoring snoozes list - list snoozes
SYNOPSIS
gcloud alpha monitoring snoozes list [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List snoozes.
EXAMPLES
To order your results first by the snooze's display name and then the end
time:
$ gcloud alpha monitoring snoozes list \
--sort-by=display_name,interval.end_time
To order your results in reverse order, you can add '~' in front of the
field name:
$ gcloud alpha monitoring snoozes list --sort-by="~display_name"
To return results with past, i.e. historical, snoozes only:
$ gcloud alpha monitoring snoozes list \
--filter="interval.end_time<+PT1S"
To return results whose display name contain the word 'cloud':
$ gcloud alpha monitoring snoozes list \
--filter="display_name:(cloud)"
More information can be found at
https://cloud.google.com/sdk/gcloud/reference/topic/filters
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 monitoring/v3 API. The full documentation for this
API can be found at: https://cloud.google.com/monitoring/api/
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.

78
gcloud/alpha/monitoring/snoozes/update Normal file
View file

@ -0,0 +1,78 @@
NAME
gcloud alpha monitoring snoozes update - updates a snooze
SYNOPSIS
gcloud alpha monitoring snoozes update SNOOZE
[--snooze-from-file=SNOOZE_FROM_FILE]
[--fields=[field,...] | --display-name=DISPLAY_NAME
--end-time=END_TIME --start-time=START_TIME] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Updates a snooze.
If `--snooze-from-file` is specified:
* If `--fields` is specified, then only the specified fields will be
updated.
* Else, the snooze will be replaced with the provided snooze. The
snooze can be modified further using the flags from the Snooze
Settings group below.
Otherwise, the snooze will be updated with the values specified in the
flags from the Snooze Settings group.
For information about the JSON/YAML format of a snooze:
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.snoozes
POSITIONAL ARGUMENTS
Snooze resource - Name of the Snooze to be updated. 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 snooze 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.
SNOOZE
ID of the Snooze or fully qualified identifier for the Snooze. To set
the snooze attribute:
▸ provide the argument snooze on the command line.
FLAGS
--snooze-from-file=SNOOZE_FROM_FILE
The path to a JSON or YAML file containing the snooze.
At most one of these can be specified:
--fields=[field,...]
The list of fields to update. Must specify --snooze-from-file if
using this flag.
Snooze Settings. If any of these are specified, they will overwrite
fields in the --snooze-from-file flags if specified.
--display-name=DISPLAY_NAME
The display name for the Snooze.
--end-time=END_TIME
The start time for the Snooze.
--start-time=START_TIME
The start time for the Snooze.
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.