mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-11 07:29:40 +00:00
1675 lines
72 KiB
Text
1675 lines
72 KiB
Text
NAME
|
|
gcloud apihub apis update - update apis
|
|
|
|
SYNOPSIS
|
|
gcloud apihub apis update [--api=API] [--description=DESCRIPTION]
|
|
[--display-name=DISPLAY_NAME] [--fingerprint=FINGERPRINT]
|
|
[--location=LOCATION]
|
|
[--attributes=[ATTRIBUTES,...]
|
|
| --update-attributes=[UPDATE_ATTRIBUTES,...] --clear-attributes
|
|
| --remove-attributes=REMOVE_ATTRIBUTES]
|
|
[--clear-api-functional-requirements
|
|
--api-functional-requirements-json-values=[API_FUNCTIONAL_REQUIREMENTS_JSON_VALUES,
|
|
...]
|
|
| --api-functional-requirements-string-values=[API_FUNCTIONAL_REQUIREMENTS_STRING_VALUES,
|
|
...]
|
|
| --api-functional-requirements-uri-values=[API_FUNCTIONAL_REQUIREMENTS_URI_VALUES,
|
|
...]
|
|
| --api-functional-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-api-functional-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-api-functional-requirements-enum-values
|
|
| --remove-api-functional-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[--clear-api-requirements
|
|
--api-requirements-json-values=[API_REQUIREMENTS_JSON_VALUES,...]
|
|
| --api-requirements-string-values=[API_REQUIREMENTS_STRING_VALUES,
|
|
...]
|
|
| --api-requirements-uri-values=[API_REQUIREMENTS_URI_VALUES,...]
|
|
| --api-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-api-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-api-requirements-enum-values
|
|
| --remove-api-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[--clear-api-style --api-style-json-values=[API_STYLE_JSON_VALUES,...]
|
|
| --api-style-string-values=[API_STYLE_STRING_VALUES,...]
|
|
| --api-style-uri-values=[API_STYLE_URI_VALUES,...]
|
|
| --api-style-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-api-style-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-api-style-enum-values
|
|
| --remove-api-style-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[--clear-api-technical-requirements
|
|
--api-technical-requirements-json-values=[API_TECHNICAL_REQUIREMENTS_JSON_VALUES,
|
|
...]
|
|
| --api-technical-requirements-string-values=[API_TECHNICAL_REQUIREMENTS_STRING_VALUES,
|
|
...]
|
|
| --api-technical-requirements-uri-values=[API_TECHNICAL_REQUIREMENTS_URI_VALUES,
|
|
...]
|
|
| --api-technical-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-api-technical-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-api-technical-requirements-enum-values
|
|
| --remove-api-technical-requirements-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[--clear-business-unit
|
|
--business-unit-json-values=[BUSINESS_UNIT_JSON_VALUES,...]
|
|
| --business-unit-string-values=[BUSINESS_UNIT_STRING_VALUES,...]
|
|
| --business-unit-uri-values=[BUSINESS_UNIT_URI_VALUES,...]
|
|
| --business-unit-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-business-unit-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-business-unit-enum-values
|
|
| --remove-business-unit-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[--clear-documentation
|
|
--documentation-external-uri=DOCUMENTATION_EXTERNAL_URI]
|
|
[--clear-maturity-level
|
|
--maturity-level-json-values=[MATURITY_LEVEL_JSON_VALUES,...]
|
|
| --maturity-level-string-values=[MATURITY_LEVEL_STRING_VALUES,...]
|
|
| --maturity-level-uri-values=[MATURITY_LEVEL_URI_VALUES,...]
|
|
| --maturity-level-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-maturity-level-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-maturity-level-enum-values
|
|
| --remove-maturity-level-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[--clear-owner
|
|
--owner-display-name=OWNER_DISPLAY_NAME --owner-email=OWNER_EMAIL]
|
|
[--clear-selected-version | --selected-version=SELECTED_VERSION]
|
|
[--clear-target-user
|
|
--target-user-json-values=[TARGET_USER_JSON_VALUES,...]
|
|
| --target-user-string-values=[TARGET_USER_STRING_VALUES,...]
|
|
| --target-user-uri-values=[TARGET_USER_URI_VALUES,...]
|
|
| --target-user-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-target-user-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-target-user-enum-values
|
|
| --remove-target-user-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[--clear-team --team-json-values=[TEAM_JSON_VALUES,...]
|
|
| --team-string-values=[TEAM_STRING_VALUES,...]
|
|
| --team-uri-values=[TEAM_URI_VALUES,...]
|
|
| --team-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
| --add-team-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
--clear-team-enum-values
|
|
| --remove-team-enum-values=[description=DESCRIPTION],
|
|
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]]
|
|
[GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
Update an api
|
|
|
|
Note: The positional argument for API ID is currently not supported. Please
|
|
use the --api flag to specify the API ID.
|
|
|
|
EXAMPLES
|
|
To update an API with the ID my-api, run:
|
|
|
|
$ gcloud apihub apis update --api=my-api --project=my-project \
|
|
--location=us-central1
|
|
|
|
FLAGS
|
|
--api=API
|
|
For resources [api, selected-version], provides fallback value for
|
|
resource api attribute. When the resource's full URI path is not
|
|
provided, api will fallback to this flag value.
|
|
|
|
--description=DESCRIPTION
|
|
The description of the API resource.
|
|
|
|
--display-name=DISPLAY_NAME
|
|
The display name of the API resource.
|
|
|
|
--fingerprint=FINGERPRINT
|
|
Fingerprint of the API resource. This must be unique for each API
|
|
resource. It can neither be unset nor be updated to an existing
|
|
fingerprint of another API resource.
|
|
|
|
--location=LOCATION
|
|
For resources [api, selected-version], provides fallback value for
|
|
resource location attribute. When the resource's full URI path is not
|
|
provided, location will fallback to this flag value.
|
|
|
|
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 API 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 API 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)
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-api-functional-requirements
|
|
Set googleCloudApihubV1Api.apiFunctionalRequirements back to default
|
|
value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-functional-requirements-json-values=[API_FUNCTIONAL_REQUIREMENTS_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-functional-requirements-string-values=[API_FUNCTIONAL_REQUIREMENTS_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-functional-requirements-uri-values=[API_FUNCTIONAL_REQUIREMENTS_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update api_functional_requirements_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--api-functional-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set api_functional_requirements_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--api-functional-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --api-functional-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--api-functional-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--api-functional-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-api-functional-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to api_functional_requirements_enum_values list.
|
|
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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-api-functional-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-api-functional-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-api-functional-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-api-functional-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-api-functional-requirements-enum-values
|
|
Clear api_functional_requirements_enum_values value and set to
|
|
empty list.
|
|
|
|
--remove-api-functional-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from
|
|
api_functional_requirements_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-api-functional-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-api-functional-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-api-functional-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-api-functional-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-api-requirements
|
|
Set googleCloudApihubV1Api.apiRequirements back to default value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-requirements-json-values=[API_REQUIREMENTS_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-requirements-string-values=[API_REQUIREMENTS_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-requirements-uri-values=[API_REQUIREMENTS_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update api_requirements_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--api-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set api_requirements_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--api-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --api-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--api-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--api-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-api-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to api_requirements_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-api-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-api-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-api-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-api-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-api-requirements-enum-values
|
|
Clear api_requirements_enum_values value and set to empty list.
|
|
|
|
--remove-api-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from api_requirements_enum_values list.
|
|
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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-api-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-api-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-api-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-api-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-api-style
|
|
Set googleCloudApihubV1Api.apiStyle back to default value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-style-json-values=[API_STYLE_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-style-string-values=[API_STYLE_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-style-uri-values=[API_STYLE_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update api_style_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--api-style-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set api_style_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--api-style-enum-values=description=string,displayName=string,id=string,immutable=boolean --api-style-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--api-style-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--api-style-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-api-style-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to api_style_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-api-style-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-api-style-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-api-style-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-api-style-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-api-style-enum-values
|
|
Clear api_style_enum_values value and set to empty list.
|
|
|
|
--remove-api-style-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from api_style_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-api-style-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-api-style-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-api-style-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-api-style-enum-values=path_to_file.(yaml|json)
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-api-technical-requirements
|
|
Set googleCloudApihubV1Api.apiTechnicalRequirements back to default
|
|
value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-technical-requirements-json-values=[API_TECHNICAL_REQUIREMENTS_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-technical-requirements-string-values=[API_TECHNICAL_REQUIREMENTS_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--api-technical-requirements-uri-values=[API_TECHNICAL_REQUIREMENTS_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update api_technical_requirements_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--api-technical-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set api_technical_requirements_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--api-technical-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --api-technical-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--api-technical-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--api-technical-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-api-technical-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to api_technical_requirements_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-api-technical-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-api-technical-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-api-technical-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-api-technical-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-api-technical-requirements-enum-values
|
|
Clear api_technical_requirements_enum_values value and set to
|
|
empty list.
|
|
|
|
--remove-api-technical-requirements-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from
|
|
api_technical_requirements_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-api-technical-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-api-technical-requirements-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-api-technical-requirements-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-api-technical-requirements-enum-values=path_to_file.(yaml|json)
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-business-unit
|
|
Set googleCloudApihubV1Api.businessUnit back to default value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--business-unit-json-values=[BUSINESS_UNIT_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--business-unit-string-values=[BUSINESS_UNIT_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--business-unit-uri-values=[BUSINESS_UNIT_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update business_unit_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--business-unit-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set business_unit_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--business-unit-enum-values=description=string,displayName=string,id=string,immutable=boolean --business-unit-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--business-unit-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--business-unit-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-business-unit-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to business_unit_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-business-unit-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-business-unit-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-business-unit-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-business-unit-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-business-unit-enum-values
|
|
Clear business_unit_enum_values value and set to empty list.
|
|
|
|
--remove-business-unit-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from business_unit_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-business-unit-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-business-unit-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-business-unit-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-business-unit-enum-values=path_to_file.(yaml|json)
|
|
|
|
Documentation details.
|
|
|
|
--clear-documentation
|
|
Set googleCloudApihubV1Api.documentation back to default value.
|
|
|
|
--documentation-external-uri=DOCUMENTATION_EXTERNAL_URI
|
|
The uri of the externally hosted documentation.
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-maturity-level
|
|
Set googleCloudApihubV1Api.maturityLevel back to default value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--maturity-level-json-values=[MATURITY_LEVEL_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--maturity-level-string-values=[MATURITY_LEVEL_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--maturity-level-uri-values=[MATURITY_LEVEL_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update maturity_level_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--maturity-level-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set maturity_level_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--maturity-level-enum-values=description=string,displayName=string,id=string,immutable=boolean --maturity-level-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--maturity-level-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--maturity-level-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-maturity-level-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to maturity_level_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-maturity-level-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-maturity-level-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-maturity-level-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-maturity-level-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-maturity-level-enum-values
|
|
Clear maturity_level_enum_values value and set to empty list.
|
|
|
|
--remove-maturity-level-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from maturity_level_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-maturity-level-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-maturity-level-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-maturity-level-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-maturity-level-enum-values=path_to_file.(yaml|json)
|
|
|
|
Owner details.
|
|
|
|
--clear-owner
|
|
Set googleCloudApihubV1Api.owner back to default value.
|
|
|
|
--owner-display-name=OWNER_DISPLAY_NAME
|
|
The name of the owner.
|
|
|
|
--owner-email=OWNER_EMAIL
|
|
The email of the owner.
|
|
|
|
Update selected_version.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-selected-version
|
|
Clear selected_version value and set to null.
|
|
|
|
Version resource - Set selected_version to new value.
|
|
|
|
The selected version for an API resource. This can be used when special
|
|
handling is needed on client side for particular version of the API.
|
|
Format is
|
|
projects/{project}/locations/{location}/apis/{api}/versions/{version}
|
|
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 --selected-version on the command line with a
|
|
fully specified name;
|
|
▸ provide the argument --project on the command line;
|
|
▸ set the property core/project.
|
|
|
|
To set the location attribute:
|
|
▸ provide the argument --selected-version on the command line with a
|
|
fully specified name;
|
|
▸ provide the argument --location on the command line.
|
|
|
|
To set the api attribute:
|
|
▸ provide the argument --selected-version on the command line with a
|
|
fully specified name;
|
|
▸ provide the argument --api on the command line.
|
|
|
|
--selected-version=SELECTED_VERSION
|
|
ID of the version or fully qualified identifier for the version.
|
|
|
|
To set the version attribute:
|
|
▸ provide the argument --selected-version on the command line.
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-target-user
|
|
Set googleCloudApihubV1Api.targetUser back to default value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--target-user-json-values=[TARGET_USER_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--target-user-string-values=[TARGET_USER_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--target-user-uri-values=[TARGET_USER_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update target_user_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--target-user-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set target_user_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--target-user-enum-values=description=string,displayName=string,id=string,immutable=boolean --target-user-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--target-user-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--target-user-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-target-user-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to target_user_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-target-user-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-target-user-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-target-user-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-target-user-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-target-user-enum-values
|
|
Clear target_user_enum_values value and set to empty list.
|
|
|
|
--remove-target-user-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from target_user_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-target-user-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-target-user-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-target-user-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-target-user-enum-values=path_to_file.(yaml|json)
|
|
|
|
The attribute values associated with resource.
|
|
|
|
--clear-team
|
|
Set googleCloudApihubV1Api.team back to default value.
|
|
|
|
Arguments for the Value.
|
|
|
|
At most one of these can be specified:
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--team-json-values=[TEAM_JSON_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--team-string-values=[TEAM_STRING_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type string or JSON.
|
|
|
|
--team-uri-values=[TEAM_URI_VALUES,...]
|
|
The attribute values in case attribute data type is string or JSON.
|
|
|
|
The attribute values of data type enum.
|
|
|
|
Update team_enum_values.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--team-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Set team_enum_values to new value. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--team-enum-values=description=string,displayName=string,id=string,immutable=boolean --team-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--team-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--team-enum-values=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--add-team-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Add new value to team_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--add-team-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-team-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--add-team-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--add-team-enum-values=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-team-enum-values
|
|
Clear team_enum_values value and set to empty list.
|
|
|
|
--remove-team-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
|
|
Remove existing value from team_enum_values list. 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.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-team-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-team-enum-values=description=string,displayName=string,id=string,immutable=boolean
|
|
|
|
JSON Example:
|
|
|
|
--remove-team-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
|
|
|
|
File Example:
|
|
|
|
--remove-team-enum-values=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 apis update
|
|
|