- NAME
-
- gcloud apihub deployments update - update deployments
- SYNOPSIS
-
-
gcloud apihub deployments update(DEPLOYMENT:--location=LOCATION) [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--endpoints=[ENDPOINTS,…]] [--resource-uri=RESOURCE_URI] [--source-environment=SOURCE_ENVIRONMENT] [--source-project=SOURCE_PROJECT] [--attributes=[ATTRIBUTES,…] |--update-attributes=[UPDATE_ATTRIBUTES,…]--clear-attributes|--remove-attributes=REMOVE_ATTRIBUTES] [--clear-deployment-type--deployment-type-json-values=[DEPLOYMENT_TYPE_JSON_VALUES,…] |--deployment-type-string-values=[DEPLOYMENT_TYPE_STRING_VALUES,…] |--deployment-type-uri-values=[DEPLOYMENT_TYPE_URI_VALUES,…] |--deployment-type-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE] |--add-deployment-type-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]--clear-deployment-type-enum-values|--remove-deployment-type-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]] [--clear-documentation--documentation-external-uri=DOCUMENTATION_EXTERNAL_URI] [--clear-environment--environment-json-values=[ENVIRONMENT_JSON_VALUES,…] |--environment-string-values=[ENVIRONMENT_STRING_VALUES,…] |--environment-uri-values=[ENVIRONMENT_URI_VALUES,…] |--environment-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE] |--add-environment-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]--clear-environment-enum-values|--remove-environment-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]] [--clear-management-url--management-url-json-values=[MANAGEMENT_URL_JSON_VALUES,…] |--management-url-string-values=[MANAGEMENT_URL_STRING_VALUES,…] |--management-url-uri-values=[MANAGEMENT_URL_URI_VALUES,…] |--management-url-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE] |--add-management-url-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]--clear-management-url-enum-values|--remove-management-url-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]] [--clear-slo--slo-json-values=[SLO_JSON_VALUES,…] |--slo-string-values=[SLO_STRING_VALUES,…] |--slo-uri-values=[SLO_URI_VALUES,…] |--slo-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE] |--add-slo-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]--clear-slo-enum-values|--remove-slo-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]] [--clear-source-uri--source-uri-json-values=[SOURCE_URI_JSON_VALUES,…] |--source-uri-string-values=[SOURCE_URI_STRING_VALUES,…] |--source-uri-values=[SOURCE_URI_VALUES,…] |--source-uri-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE] |--add-source-uri-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]--clear-source-uri-enum-values|--remove-source-uri-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
- Update a deployment
- EXAMPLES
-
To update a deployment with the ID
my-deployment, run:gcloud apihub deployments update my-deployment --display-name="New Deployment Name" --project=my-project --location=us-central1 - POSITIONAL ARGUMENTS
-
-
Deployment resource - Identifier. The name of the deployment.
Format:
projects/{project}/locations/{location}/deployments/{deployment}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
projectattribute:-
provide the argument
deploymenton the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
DEPLOYMENT-
ID of the deployment or fully qualified identifier for the deployment.
To set the
deploymentattribute:-
provide the argument
deploymenton the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The location id of the deployment resource.
To set the
locationattribute:-
provide the argument
deploymenton the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
Deployment resource - Identifier. The name of the deployment.
- FLAGS
-
--description=DESCRIPTION- The description of the deployment.
--display-name=DISPLAY_NAME- The display name of the deployment.
--endpoints=[ENDPOINTS,…]- The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.
--resource-uri=RESOURCE_URI-
The resource URI identifies the deployment within its gateway. For Apigee
gateways, its recommended to use the format:
organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name
ordersis deployed instagingenvironment ofcymbalorganization, the resource URI would be:organizations/cymbal/environments/staging/apis/orders. --source-environment=SOURCE_ENVIRONMENT- The environment at source for the deployment. For example: prod, dev, staging, etc.
--source-project=SOURCE_PROJECT- The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.
-
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 deployment 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
KEYvalue. VALUE-
Sets
VALUEvalue.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 deployment 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
KEYvalue. VALUE-
Sets
VALUEvalue.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_attributesvalue.Shorthand Example:--remove-attributes=string,stringJSON Example:--remove-attributes=["string"]
File Example:--remove-attributes=path_to_file.(yaml|json)
- The attribute values associated with resource.
--clear-deployment-type- Set googleCloudApihubV1Deployment.deploymentType 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.
--deployment-type-json-values=[DEPLOYMENT_TYPE_JSON_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--deployment-type-string-values=[DEPLOYMENT_TYPE_STRING_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--deployment-type-uri-values=[DEPLOYMENT_TYPE_URI_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type enum.
-
Update deployment_type_enum_values.
At most one of these can be specified:
--deployment-type-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Set deployment_type_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:--deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean --deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--deployment-type-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--deployment-type-enum-values=path_to_file.(yaml|json)
-
Or at least one of these can be specified:
--add-deployment-type-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Add new value to deployment_type_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-deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--add-deployment-type-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--add-deployment-type-enum-values=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-deployment-type-enum-values- Clear deployment_type_enum_values value and set to empty list.
--remove-deployment-type-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Remove existing value from deployment_type_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-deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--remove-deployment-type-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--remove-deployment-type-enum-values=path_to_file.(yaml|json)
- Documentation details.
--clear-documentation- Set googleCloudApihubV1Deployment.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-environment- Set googleCloudApihubV1Deployment.environment 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.
--environment-json-values=[ENVIRONMENT_JSON_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--environment-string-values=[ENVIRONMENT_STRING_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--environment-uri-values=[ENVIRONMENT_URI_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type enum.
-
Update environment_enum_values.
At most one of these can be specified:
--environment-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Set environment_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:--environment-enum-values=description=string,displayName=string,id=string,immutable=boolean --environment-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--environment-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--environment-enum-values=path_to_file.(yaml|json)
-
Or at least one of these can be specified:
--add-environment-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Add new value to environment_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-environment-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-environment-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--add-environment-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--add-environment-enum-values=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-environment-enum-values- Clear environment_enum_values value and set to empty list.
--remove-environment-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Remove existing value from environment_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-environment-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-environment-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--remove-environment-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--remove-environment-enum-values=path_to_file.(yaml|json)
- The attribute values associated with resource.
--clear-management-url- Set googleCloudApihubV1Deployment.managementUrl 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.
--management-url-json-values=[MANAGEMENT_URL_JSON_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--management-url-string-values=[MANAGEMENT_URL_STRING_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--management-url-uri-values=[MANAGEMENT_URL_URI_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type enum.
-
Update management_url_enum_values.
At most one of these can be specified:
--management-url-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Set management_url_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:--management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean --management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--management-url-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--management-url-enum-values=path_to_file.(yaml|json)
-
Or at least one of these can be specified:
--add-management-url-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Add new value to management_url_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-management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--add-management-url-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--add-management-url-enum-values=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-management-url-enum-values- Clear management_url_enum_values value and set to empty list.
--remove-management-url-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Remove existing value from management_url_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-management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--remove-management-url-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--remove-management-url-enum-values=path_to_file.(yaml|json)
- The attribute values associated with resource.
--clear-slo- Set googleCloudApihubV1Deployment.slo 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.
--slo-json-values=[SLO_JSON_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--slo-string-values=[SLO_STRING_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--slo-uri-values=[SLO_URI_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type enum.
-
Update slo_enum_values.
At most one of these can be specified:
--slo-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Set slo_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:--slo-enum-values=description=string,displayName=string,id=string,immutable=boolean --slo-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--slo-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--slo-enum-values=path_to_file.(yaml|json)
-
Or at least one of these can be specified:
--add-slo-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Add new value to slo_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-slo-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-slo-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--add-slo-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--add-slo-enum-values=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-slo-enum-values- Clear slo_enum_values value and set to empty list.
--remove-slo-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Remove existing value from slo_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-slo-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-slo-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--remove-slo-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--remove-slo-enum-values=path_to_file.(yaml|json)
- The attribute values associated with resource.
--clear-source-uri- Set googleCloudApihubV1Deployment.sourceUri 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.
--source-uri-json-values=[SOURCE_URI_JSON_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--source-uri-string-values=[SOURCE_URI_STRING_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type string or JSON.
--source-uri-values=[SOURCE_URI_VALUES,…]- The attribute values in case attribute data type is string or JSON.
- The attribute values of data type enum.
-
Update source_uri_enum_values.
At most one of these can be specified:
--source-uri-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Set source_uri_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:--source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean --source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--source-uri-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--source-uri-enum-values=path_to_file.(yaml|json)
-
Or at least one of these can be specified:
--add-source-uri-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Add new value to source_uri_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-source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean --add-source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--add-source-uri-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--add-source-uri-enum-values=path_to_file.(yaml|json)
-
At most one of these can be specified:
--clear-source-uri-enum-values- Clear source_uri_enum_values value and set to empty list.
--remove-source-uri-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]-
Remove existing value from source_uri_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-source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean --remove-source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:--remove-source-uri-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:--remove-source-uri-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 helpfor details. - API REFERENCE
-
This command uses the
apihub/v1API. 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 deployments update
gcloud apihub deployments update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-24 UTC.