1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-20 04:58:26 +00:00

gcloud: Thu Mar 26 12:11:21 UTC 2026

This commit is contained in:
Automated 2026-03-26 12:11:21 +00:00
parent c0febd2be1
commit 89a3bc9276
1093 changed files with 69108 additions and 2686 deletions

View file

@ -0,0 +1,205 @@
NAME
gcloud apihub dependencies create - create a Dependency
SYNOPSIS
gcloud apihub dependencies create (DEPENDENCY : --location=LOCATION)
(--consumer-external-api-resource-name=CONSUMER_EXTERNAL_API_RESOURCE_NAME | --consumer-operation-resource-name=CONSUMER_OPERATION_RESOURCE_NAME)
(--supplier-external-api-resource-name=SUPPLIER_EXTERNAL_API_RESOURCE_NAME | --supplier-operation-resource-name=SUPPLIER_OPERATION_RESOURCE_NAME)
[--attributes=[ATTRIBUTES,...]] [--description=DESCRIPTION]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a dependency
Note: The positional argument for Dependency ID is currently not supported.
Please use the --dependency flag to specify the Dependency ID.
EXAMPLES
To create a dependency with the ID my-dependency, run:
$ gcloud apihub dependencies create --dependency=my-dependency \
--consumer=projects/my-project/locations/us-central1/apis/\
my-api/versions/v1/operations/get-users \
--supplier=projects/my-project/locations/us-central1/apis/\
other-api/versions/v1/operations/list-items --project=my-project \
--location=us-central1
POSITIONAL ARGUMENTS
Dependency resource - Identifier. The name of the dependency in the API
Hub.
Format: projects/{project}/locations/{location}/dependencies/{dependency}
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 dependency 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.
DEPENDENCY
ID of the dependency or fully qualified identifier for the
dependency.
To set the dependency attribute:
▸ provide the argument dependency 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 id of the dependency resource.
To set the location attribute:
▸ provide the argument dependency on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
Reference to an entity participating in a dependency.
This must be specified.
Arguments for the identifier.
At most one of these can be specified:
--consumer-external-api-resource-name=CONSUMER_EXTERNAL_API_RESOURCE_NAME
The resource name of an external API in the API Hub.
Format:
projects/{project}/locations/{location}/externalApis/{external_api}
--consumer-operation-resource-name=CONSUMER_OPERATION_RESOURCE_NAME
The resource name of an operation in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
Reference to an entity participating in a dependency.
This must be specified.
Arguments for the identifier.
At most one of these can be specified:
--supplier-external-api-resource-name=SUPPLIER_EXTERNAL_API_RESOURCE_NAME
The resource name of an external API in the API Hub.
Format:
projects/{project}/locations/{location}/externalApis/{external_api}
--supplier-operation-resource-name=SUPPLIER_OPERATION_RESOURCE_NAME
The resource name of an operation in the API Hub.
Format:
projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}
OPTIONAL FLAGS
--attributes=[ATTRIBUTES,...]
The list of user defined attributes associated with the dependency
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}. The
value is the attribute values associated with the resource.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
enumValues
The attribute values associated with a resource in case
attribute data type is enum.
values
The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
▹ If provided, the same will be used. The service
will throw an error if the specified id is already
used by another allowed value in the same attribute
resource.
▹ If not provided, a system generated id derived from
the display name will be used. In this case, the
service will handle conflict resolution by adding a
system generated suffix in case of duplicates.
This value should be 4-63 characters, and valid
characters are /[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated
or deleted by the user. It can only be true for System
defined attributes.
jsonValues
The attribute values associated with a resource in case
attribute data type is JSON.
values
The attribute values in case attribute data type is string
or JSON.
stringValues
The attribute values associated with a resource in case
attribute data type is string.
values
The attribute values in case attribute data type is string
or JSON.
uriValues
The attribute values associated with a resource in case
attribute data type is URL, URI or IP, like
gs://bucket-name/object-name.
values
The attribute values in case attribute data type is string
or JSON.
Shorthand Example:
--attributes=string={enumValues={values=[{description=string,displayName=string,id=string,immutable=boolean}]},jsonValues={values=[string]},stringValues={values=[string]},uriValues={values=[string]}}
JSON Example:
--attributes='{"string": {"enumValues": {"values": [{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]}, "jsonValues": {"values": ["string"]}, "stringValues": {"values": ["string"]}, "uriValues": {"values": ["string"]}}}'
File Example:
--attributes=path_to_file.(yaml|json)
--description=DESCRIPTION
Human readable description corresponding of the dependency.
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 apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub dependencies create

View file

@ -0,0 +1,67 @@
NAME
gcloud apihub dependencies delete - delete a Dependency
SYNOPSIS
gcloud apihub dependencies delete (DEPENDENCY : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a dependency
EXAMPLES
To delete a dependency with the ID my-dependency, run:
$ gcloud apihub dependencies delete my-dependency \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Dependency resource - The name of the dependency resource to delete.
Format: projects/{project}/locations/{location}/dependencies/{dependency}
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 dependency 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.
DEPENDENCY
ID of the dependency or fully qualified identifier for the
dependency.
To set the dependency attribute:
▸ provide the argument dependency 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 id of the dependency resource.
To set the location attribute:
▸ provide the argument dependency on the command line with a fully
specified name;
▸ provide the argument --location 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.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub dependencies delete

View file

@ -0,0 +1,67 @@
NAME
gcloud apihub dependencies describe - describe a Dependency
SYNOPSIS
gcloud apihub dependencies describe (DEPENDENCY : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe a dependency
EXAMPLES
To describe a dependency with the ID my-dependency, run:
$ gcloud apihub dependencies describe my-dependency \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Dependency resource - The name of the dependency resource to retrieve.
Format: projects/{project}/locations/{location}/dependencies/{dependency}
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 dependency 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.
DEPENDENCY
ID of the dependency or fully qualified identifier for the
dependency.
To set the dependency attribute:
▸ provide the argument dependency 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 id of the dependency resource.
To set the location attribute:
▸ provide the argument dependency on the command line with a fully
specified name;
▸ provide the argument --location 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.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub dependencies describe

View file

@ -0,0 +1,37 @@
NAME
gcloud apihub dependencies - manage Dependency resources
SYNOPSIS
gcloud apihub dependencies COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Dependency resources.
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 Dependency.
delete
Delete a Dependency.
describe
Describe a Dependency.
list
List Dependencies.
update
Update a Dependency.
NOTES
This variant is also available:
$ gcloud alpha apihub dependencies

View file

@ -0,0 +1,88 @@
NAME
gcloud apihub dependencies list - list Dependencies
SYNOPSIS
gcloud apihub dependencies list --location=LOCATION [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List dependencies
EXAMPLES
To list all dependencies in project my-project and location us-central1,
run:
$ gcloud apihub dependencies list --project=my-project \
--location=us-central1
REQUIRED FLAGS
Location resource - The parent which owns this collection of dependency
resources. Format: projects/{project}/locations/{location} 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;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
--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.
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 apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub dependencies list

View file

@ -0,0 +1,271 @@
NAME
gcloud apihub dependencies update - update a Dependency
SYNOPSIS
gcloud apihub dependencies update (DEPENDENCY : --location=LOCATION)
[--description=DESCRIPTION]
[--attributes=[ATTRIBUTES,...]
| --update-attributes=[UPDATE_ATTRIBUTES,...] --clear-attributes
| --remove-attributes=REMOVE_ATTRIBUTES] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update a dependency
EXAMPLES
To update the description of a dependency with the ID my-dependency, run:
$ gcloud apihub dependencies update my-dependency \
--description="New Description" --project=my-project \
--location=us-central1
POSITIONAL ARGUMENTS
Dependency resource - Identifier. The name of the dependency in the API
Hub.
Format: projects/{project}/locations/{location}/dependencies/{dependency}
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 dependency 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.
DEPENDENCY
ID of the dependency or fully qualified identifier for the
dependency.
To set the dependency attribute:
▸ provide the argument dependency 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 id of the dependency resource.
To set the location attribute:
▸ provide the argument dependency on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
FLAGS
--description=DESCRIPTION
Human readable description corresponding of the dependency.
Update attributes.
At most one of these can be specified:
--attributes=[ATTRIBUTES,...]
Set attributes to new value. The list of user defined attributes
associated with the dependency resource. The key is the attribute
name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}. The
value is the attribute values associated with the resource.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
enumValues
The attribute values associated with a resource in case
attribute data type is enum.
values
The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
▪ If provided, the same will be used. The service
will throw an error if the specified id is already
used by another allowed value in the same attribute
resource.
▪ If not provided, a system generated id derived
from the display name will be used. In this case,
the service will handle conflict resolution by
adding a system generated suffix in case of
duplicates.
This value should be 4-63 characters, and valid
characters are /[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated
or deleted by the user. It can only be true for
System defined attributes.
jsonValues
The attribute values associated with a resource in case
attribute data type is JSON.
values
The attribute values in case attribute data type is
string or JSON.
stringValues
The attribute values associated with a resource in case
attribute data type is string.
values
The attribute values in case attribute data type is
string or JSON.
uriValues
The attribute values associated with a resource in case
attribute data type is URL, URI or IP, like
gs://bucket-name/object-name.
values
The attribute values in case attribute data type is
string or JSON.
Shorthand Example:
--attributes=string={enumValues={values=[{description=string,displayName=string,id=string,immutable=boolean}]},jsonValues={values=[string]},stringValues={values=[string]},uriValues={values=[string]}}
JSON Example:
--attributes='{"string": {"enumValues": {"values": [{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]}, "jsonValues": {"values": ["string"]}, "stringValues": {"values": ["string"]}, "uriValues": {"values": ["string"]}}}'
File Example:
--attributes=path_to_file.(yaml|json)
Or at least one of these can be specified:
--update-attributes=[UPDATE_ATTRIBUTES,...]
Update attributes value or add key value pair. The list of user
defined attributes associated with the dependency resource. The key
is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}. The
value is the attribute values associated with the resource.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
enumValues
The attribute values associated with a resource in case
attribute data type is enum.
values
The attribute values in case attribute data type is
enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
◆ If provided, the same will be used. The service
will throw an error if the specified id is
already used by another allowed value in the same
attribute resource.
◆ If not provided, a system generated id derived
from the display name will be used. In this case,
the service will handle conflict resolution by
adding a system generated suffix in case of
duplicates.
This value should be 4-63 characters, and valid
characters are /[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be
updated or deleted by the user. It can only be true
for System defined attributes.
jsonValues
The attribute values associated with a resource in case
attribute data type is JSON.
values
The attribute values in case attribute data type is
string or JSON.
stringValues
The attribute values associated with a resource in case
attribute data type is string.
values
The attribute values in case attribute data type is
string or JSON.
uriValues
The attribute values associated with a resource in case
attribute data type is URL, URI or IP, like
gs://bucket-name/object-name.
values
The attribute values in case attribute data type is
string or JSON.
Shorthand Example:
--update-attributes=string={enumValues={values=[{description=string,displayName=string,id=string,immutable=boolean}]},jsonValues={values=[string]},stringValues={values=[string]},uriValues={values=[string]}}
JSON Example:
--update-attributes='{"string": {"enumValues": {"values": [{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]}, "jsonValues": {"values": ["string"]}, "stringValues": {"values": ["string"]}, "uriValues": {"values": ["string"]}}}'
File Example:
--update-attributes=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-attributes
Clear attributes value and set to empty map.
--remove-attributes=REMOVE_ATTRIBUTES
Remove existing value from map attributes. Sets remove_attributes
value.
Shorthand Example:
--remove-attributes=string,string
JSON Example:
--remove-attributes=["string"]
File Example:
--remove-attributes=path_to_file.(yaml|json)
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 apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub dependencies update