gcloud beta workspace-add-ons chat-app-config update

INFORMATION
gcloud beta workspace-add-ons chat-app-config update is not available in universe domain universe.
NAME
gcloud beta workspace-add-ons chat-app-config update - update the Google Chat app configuration of a project
SYNOPSIS
gcloud beta workspace-add-ons chat-app-config update (--config-file=PATH_TO_FILE     | --description=DESCRIPTION --display-name=DISPLAY_NAME --[no-]error-logging-enabled --markup-syntax=MARKUP_SYNTAX --state=STATE --[no-]supports-multiuser-spaces --add-allowlisted-testing-principals=[EMAIL,…] --clear-allowlisted-testing-principals     | --remove-allowlisted-testing-principals=[EMAIL,…] --apps-script-deployment-id=APPS_SCRIPT_DEPLOYMENT_ID     | --http-endpoint-url=HTTP_ENDPOINT_URL     | --pubsub-topic=PUBSUB_TOPIC     | [--dialogflow-edition=DIALOGFLOW_EDITION : --dialogflow-agent=DIALOGFLOW_AGENT] --avatar-uri=AVATAR_URI     | --clear-avatar-uri) [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(BETA) Update the Google Chat app configuration of a Google Cloud project. If the project doesn't have a Chat app yet, the first update initializes it, so it must set at least the display name and the description.

Pass either --config-file or the per-field flags. Only the fields you specify are changed:

  • With the per-field flags, the update covers the flags you pass.
  • With --config-file, the update covers the fields that are present in the file. A field that is present with an empty value, such as urlPatterns: [], is cleared. The name field is ignored; the target project comes from --project.

Lists, such as app commands, URL patterns, and testing principals, are replaced as a whole. To add or remove testing principals without listing all of them, use --add-allowlisted-testing-principals and --remove-allowlisted-testing-principals, which read the current list first. Setting a Dialogflow edition replaces the whole Dialogflow configuration.

While the app is published or under review in the Google Workspace Marketplace, the API rejects changes to the display name, avatar, description, app commands, and URL patterns.

EXAMPLES
To update the Chat app configuration of the current project from a YAML file, run:
gcloud beta workspace-add-ons chat-app-config update --config-file=chat_app_config.yaml

To change the display name and the description, run:

gcloud beta workspace-add-ons chat-app-config update --display-name="Standup Bot v2" --description="Team standups"

To disable the app, run:

gcloud beta workspace-add-ons chat-app-config update --state=disabled

To send events to an HTTP endpoint, run:

gcloud beta workspace-add-ons chat-app-config update --http-endpoint-url=https://bot.example.com/events

To let another person test the app, run:

gcloud beta workspace-add-ons chat-app-config update --add-allowlisted-testing-principals=alice@example.com

To stop letting that person test the app, run:

gcloud beta workspace-add-ons chat-app-config update --remove-allowlisted-testing-principals=alice@example.com
REQUIRED FLAGS
Exactly one of these must be specified:
--config-file=PATH_TO_FILE
Path to a YAML or JSON file with the Chat app configuration fields to set. The file uses the same field names as the output of describe. Fields that aren't in the file are left unchanged. Use a full or relative path to a local file containing the value of config_file.
Or at least one of these can be specified:
Chat app configuration fields to update.
--description=DESCRIPTION
Short description of the Chat app, between 1 and 40 characters.
--display-name=DISPLAY_NAME
Display name of the Chat app, between 3 and 25 characters.
--[no-]error-logging-enabled
Whether to log the app's errors to Cloud Logging. New apps log errors unless you turn it off. Use --error-logging-enabled to enable and --no-error-logging-enabled to disable.
--markup-syntax=MARKUP_SYNTAX
Markup syntax for the text of messages that the app sends and reads. New apps use Markdown. MARKUP_SYNTAX must be one of:
chat
Google Chat's own markup syntax.
markdown
Markdown, based on CommonMark.
--state=STATE
State of the Chat app. If the state isn't set when the app is initialized, the app is active. STATE must be one of:
active
People who can see the app can find and use it.
disabled
Nobody can find or talk to the app.
--[no-]supports-multiuser-spaces
Whether people can add the app to spaces and group conversations, not just direct messages. Use --supports-multiuser-spaces to enable and --no-supports-multiuser-spaces to disable.
Users and groups in your Google Workspace organization who can find and use the app while you test it. These flags update the app's current testing principals list.
--add-allowlisted-testing-principals=[EMAIL,…]
Email addresses of users or groups to add to the testing principals. Addresses that are already in the list are left as they are.
At most one of these can be specified:
--clear-allowlisted-testing-principals
Remove all testing principals. To replace the list, combine this flag with --add-allowlisted-testing-principals.
--remove-allowlisted-testing-principals=[EMAIL,…]
Email addresses of users or groups to remove from the testing principals. Addresses that aren't in the list are ignored.
Where Google Chat sends the app's events. Set at most one connection type; setting one replaces the app's current connection. At most one of these can be specified:
--apps-script-deployment-id=APPS_SCRIPT_DEPLOYMENT_ID
ID of the Apps Script deployment that handles the app's events.
--http-endpoint-url=HTTP_ENDPOINT_URL
HTTPS URL that receives all of the app's events.
--pubsub-topic=PUBSUB_TOPIC
Pub/Sub topic that receives the app's events, in the form projects/PROJECT/topics/TOPIC. The topic must be in the same project.
Or at least one of these can be specified:
Dialogflow agent that handles the app's events.
--dialogflow-edition=DIALOGFLOW_EDITION
Dialogflow edition of the agent. Setting it replaces the whole Dialogflow configuration. DIALOGFLOW_EDITION must be one of:
cx
Dialogflow CX. Also set --dialogflow-agent.
es
Dialogflow ES.
This flag argument must be specified if any of the other arguments in this group are specified.
--dialogflow-agent=DIALOGFLOW_AGENT
Name of the Dialogflow CX agent or environment, in the form projects/PROJECT/locations/LOCATION/agents/AGENT or projects/PROJECT/locations/LOCATION/agents/AGENT/environments/ENVIRONMENT. Required for Dialogflow CX; don't set it for Dialogflow ES.
At most one of these can be specified:
--avatar-uri=AVATAR_URI
HTTPS URL of a square PNG image to use as the app's avatar.
--clear-avatar-uri
Reset the app's avatar to the default avatar.
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 gsuiteaddons/v1 API. The full documentation for this API can be found at: https://developers.google.com/workspace/add-ons/guides/alternate-runtimes
NOTES
This command is currently in beta and might change without notice.