mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-14 08:55:34 +00:00
271 lines
10 KiB
Text
271 lines
10 KiB
Text
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
|
|
|