imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-21 22:49:22 +00:00
Code Activity

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

Browse source
This commit is contained in:
Automated 2026-03-26 12:11:21 +00:00
parent c0febd2be1
commit 89a3bc9276
1093 changed files with 69108 additions and 2686 deletions
Download patch file Download diff file Expand all files Collapse all files

310
gcloud/alpha/apihub/plugins/create Normal file
View file

@ -0,0 +1,310 @@
NAME
gcloud alpha apihub plugins create - create a Plugin
SYNOPSIS
gcloud alpha apihub plugins create (PLUGIN : --location=LOCATION)
--display-name=DISPLAY_NAME
[--actions-config=[description=DESCRIPTION],
[displayName=DISPLAYNAME],[id=ID],[triggerMode=TRIGGERMODE]]
[--description=DESCRIPTION]
[--documentation-external-uri=DOCUMENTATION_EXTERNAL_URI]
[--gateway-type=GATEWAY_TYPE]
[--hosting-service-uri=HOSTING_SERVICE_URI]
[--plugin-category=PLUGIN_CATEGORY]
[--auth-config-template-supported-types=[AUTH_CONFIG_TEMPLATE_SUPPORTED_TYPES,
...]
--config-template-additional=[description=DESCRIPTION],
[enumOptions=ENUMOPTIONS],[id=ID],
[multiSelectOptions=MULTISELECTOPTIONS],[required=REQUIRED],
[validationRegex=VALIDATIONREGEX],[valueType=VALUETYPE]]
[--enum-values=[description=DESCRIPTION],
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
| --json-values=[JSON_VALUES,...]
| --string-values=[STRING_VALUES,...]
| --uri-values=[URI_VALUES,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a plugin
Note: The positional argument for Plugin ID is currently not supported.
Please use the --plugin flag to specify the Plugin ID.
EXAMPLES
To create a plugin with the ID my-plugin, run:
$ gcloud alpha apihub plugins create --plugin=my-plugin \
--display-name="My Plugin" --type=apigee --project=my-project \
--location=us-central1
POSITIONAL ARGUMENTS
Plugin resource - Identifier. The name of the plugin. Format:
projects/{project}/locations/{location}/plugins/{plugin} The arguments in
this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
◆ provide the argument plugin on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
PLUGIN
ID of the plugin or fully qualified identifier for the plugin.
To set the plugin attribute:
▸ provide the argument plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the plugin resource.
To set the location attribute:
▸ provide the argument plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
--display-name=DISPLAY_NAME
The display name of the plugin. Max length is 50 characters (Unicode
code points).
OPTIONAL FLAGS
--actions-config=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[triggerMode=TRIGGERMODE]
The configuration of actions supported by the plugin. **REQUIRED**:
This field must be provided when creating or updating a Plugin. The
server will reject requests if this field is missing.
description
The description of the operation performed by the action.
displayName
The display name of the action.
id
The id of the action.
triggerMode
The trigger mode supported by the action.
Shorthand Example:
--actions-config=description=string,displayName=string,id=string,triggerMode=string --actions-config=description=string,displayName=string,id=string,triggerMode=string
JSON Example:
--actions-config='[{"description": "string", "displayName": "string", "id": "string", "triggerMode": "string"}]'
File Example:
--actions-config=path_to_file.(yaml|json)
--description=DESCRIPTION
The plugin description. Max length is 2000 characters (Unicode code
points).
Documentation details.
--documentation-external-uri=DOCUMENTATION_EXTERNAL_URI
The uri of the externally hosted documentation.
--gateway-type=GATEWAY_TYPE
The type of the gateway. GATEWAY_TYPE must be one of:
api-discovery
The gateway type is API Discovery.
apigee-edge-private-cloud
The gateway type is Apigee Edge Private Cloud.
apigee-edge-public-cloud
The gateway type is Apigee Edge Public Cloud.
apigee-x-and-hybrid
The gateway type is Apigee X and Hybrid.
cloud-api-gateway
The gateway type is Cloud API Gateway.
cloud-endpoints
The gateway type is Cloud Endpoints.
others
The gateway type for any other types of gateways.
The information related to the service implemented by the plugin
developer, used to invoke the plugin's functionality.
--hosting-service-uri=HOSTING_SERVICE_URI
The URI of the service implemented by the plugin developer, used to
invoke the plugin's functionality. This information is only required
for user defined plugins.
--plugin-category=PLUGIN_CATEGORY
The category of the plugin, identifying its primary category or
purpose. This field is required for all plugins. PLUGIN_CATEGORY must
be one of:
api-gateway
API_GATEWAY plugins represent plugins built for API Gateways like
Apigee.
api-producer
API_PRODUCER plugins represent plugins built for API Producers like
Cloud Run, Application Integration etc.
ConfigTemplate represents the configuration template for a plugin.
AuthConfigTemplate represents the authentication template for a plugin.
--auth-config-template-supported-types=[AUTH_CONFIG_TEMPLATE_SUPPORTED_TYPES,...]
The list of authentication types supported by the plugin.
AUTH_CONFIG_TEMPLATE_SUPPORTED_TYPES must be one of:
api-key
API Key authentication.
google-service-account
Google service account authentication.
no-auth
No authentication.
oauth2-client-credentials
Oauth 2.0 client credentials grant authentication.
user-password
Username and password authentication.
--config-template-additional=[description=DESCRIPTION],[enumOptions=ENUMOPTIONS],[id=ID],[multiSelectOptions=MULTISELECTOPTIONS],[required=REQUIRED],[validationRegex=VALIDATIONREGEX],[valueType=VALUETYPE]
The list of additional configuration variables for the plugin's
configuration.
description
Description.
enumOptions
Enum options. To be populated if ValueType is ENUM.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
id
ID of the config variable. Must be unique within the configuration.
multiSelectOptions
Multi select options. To be populated if ValueType is MULTI_SELECT.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
required
Flag represents that this ConfigVariable must be provided for a
PluginInstance.
validationRegex
Regular expression in RE2 syntax used for validating the value of a
ConfigVariable.
valueType
Type of the parameter: string, int, bool etc.
Shorthand Example:
--config-template-additional=description=string,enumOptions=[{description=string,displayName=string,id=string}],id=string,multiSelectOptions=[{description=string,displayName=string,id=string}],required=boolean,validationRegex=string,valueType=string --config-template-additional=description=string,enumOptions=[{description=string,displayName=string,id=string}],id=string,multiSelectOptions=[{description=string,displayName=string,id=string}],required=boolean,validationRegex=string,valueType=string
JSON Example:
--config-template-additional='[{"description": "string", "enumOptions": [{"description": "string", "displayName": "string", "id": "string"}], "id": "string", "multiSelectOptions": [{"description": "string", "displayName": "string", "id": "string"}], "required": boolean, "validationRegex": "string", "valueType": "string"}]'
File Example:
--config-template-additional=path_to_file.(yaml|json)
The attribute values associated with resource.
Arguments for the Value.
At most one of these can be specified:
The attribute values of data type enum.
--enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
Required, 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:
--enum-values=description=string,displayName=string,id=string,immutable=boolean --enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:
--enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:
--enum-values=path_to_file.(yaml|json)
The attribute values of data type string or JSON.
--json-values=[JSON_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--string-values=[STRING_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--uri-values=[URI_VALUES,...]
The attribute values in case attribute data type is string or 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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins create

74
gcloud/alpha/apihub/plugins/delete Normal file
View file

@ -0,0 +1,74 @@
NAME
gcloud alpha apihub plugins delete - delete a Plugin
SYNOPSIS
gcloud alpha apihub plugins delete (PLUGIN : --location=LOCATION) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a plugin
EXAMPLES
To delete a plugin with the ID my-plugin, run:
$ gcloud alpha apihub plugins delete my-plugin \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Plugin resource - The name of the Plugin resource to delete. Format:
projects/{project}/locations/{location}/plugins/{plugin} The arguments in
this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
◆ provide the argument plugin on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
PLUGIN
ID of the plugin or fully qualified identifier for the plugin.
To set the plugin attribute:
▸ provide the argument plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the plugin resource.
To set the location attribute:
▸ provide the argument plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins delete

69
gcloud/alpha/apihub/plugins/describe Normal file
View file

@ -0,0 +1,69 @@
NAME
gcloud alpha apihub plugins describe - describe a Plugin
SYNOPSIS
gcloud alpha apihub plugins describe (PLUGIN : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a plugin
EXAMPLES
To describe a plugin with the ID my-plugin, run:
$ gcloud alpha apihub plugins describe my-plugin \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Plugin resource - The name of the plugin to retrieve. Format:
projects/{project}/locations/{location}/plugins/{plugin}. The arguments in
this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
◆ provide the argument plugin on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
PLUGIN
ID of the plugin or fully qualified identifier for the plugin.
To set the plugin attribute:
▸ provide the argument plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the plugin resource.
To set the location attribute:
▸ provide the argument plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins describe

69
gcloud/alpha/apihub/plugins/disable Normal file
View file

@ -0,0 +1,69 @@
NAME
gcloud alpha apihub plugins disable - disable a Plugin
SYNOPSIS
gcloud alpha apihub plugins disable (PLUGIN : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Disable a plugin
EXAMPLES
To disable a plugin with the ID my-plugin, run:
$ gcloud alpha apihub plugins disable my-plugin \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Plugin resource - The name of the plugin to disable. Format:
projects/{project}/locations/{location}/plugins/{plugin}. The arguments in
this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
◆ provide the argument plugin on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
PLUGIN
ID of the plugin or fully qualified identifier for the plugin.
To set the plugin attribute:
▸ provide the argument plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the plugin resource.
To set the location attribute:
▸ provide the argument plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins disable

69
gcloud/alpha/apihub/plugins/enable Normal file
View file

@ -0,0 +1,69 @@
NAME
gcloud alpha apihub plugins enable - enable a Plugin
SYNOPSIS
gcloud alpha apihub plugins enable (PLUGIN : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Enable a plugin
EXAMPLES
To enable a plugin with the ID my-plugin, run:
$ gcloud alpha apihub plugins enable my-plugin \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Plugin resource - The name of the plugin to enable. Format:
projects/{project}/locations/{location}/plugins/{plugin}. The arguments in
this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
◆ provide the argument plugin on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
PLUGIN
ID of the plugin or fully qualified identifier for the plugin.
To set the plugin attribute:
▸ provide the argument plugin on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the plugin resource.
To set the location attribute:
▸ provide the argument plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins enable

49
gcloud/alpha/apihub/plugins/help Normal file
View file

@ -0,0 +1,49 @@
NAME
gcloud alpha apihub plugins - manage Plugin resources
SYNOPSIS
gcloud alpha apihub plugins GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Plugin resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
instances
(ALPHA) Manage Plugin Instance resources.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) Create a Plugin.
delete
(ALPHA) Delete a Plugin.
describe
(ALPHA) Describe a Plugin.
disable
(ALPHA) Disable a Plugin.
enable
(ALPHA) Enable a Plugin.
list
(ALPHA) List Plugins.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins

376
gcloud/alpha/apihub/plugins/instances/create Normal file
View file

@ -0,0 +1,376 @@
NAME
gcloud alpha apihub plugins instances create - create a Plugin Instance
SYNOPSIS
gcloud alpha apihub plugins instances create
(INSTANCE : --location=LOCATION --plugin=PLUGIN)
--actions=[actionId=ACTIONID],[curationConfig=CURATIONCONFIG],
[scheduleCronExpression=SCHEDULECRONEXPRESSION],
[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]
--display-name=DISPLAY_NAME
[--additional-config=[ADDITIONAL_CONFIG,...]] [--async]
[--source-environments-config=[SOURCE_ENVIRONMENTS_CONFIG,...]]
[--source-project-id=SOURCE_PROJECT_ID]
[--auth-config-type=AUTH_CONFIG_TYPE
: --api-key-config-http-element-location=API_KEY_CONFIG_HTTP_ELEMENT_LOCATION --api-key-config-name=API_KEY_CONFIG_NAME --api-key-config-secret-version=API_KEY_CONFIG_SECRET_VERSION | --oauth2-client-credentials-config-id=OAUTH2_CLIENT_CREDENTIALS_CONFIG_ID --oauth2-client-credentials-config-secret-version=OAUTH2_CLIENT_CREDENTIALS_CONFIG_SECRET_VERSION | --user-password-config-secret-version=USER_PASSWORD_CONFIG_SECRET_VERSION --user-password-config-username=USER_PASSWORD_CONFIG_USERNAME]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a plugin instance
Note: The positional argument for Plugin Instance ID is currently not
supported. Please use the --plugin-instance flag to specify the Plugin
Instance ID.
EXAMPLES
To create a plugin instance with the ID my-instance for plugin my-plugin,
run:
$ gcloud alpha apihub plugins instances create \
--plugin-instance=my-instance --plugin=my-plugin \
--display-name="My Instance" --project=my-project \
--location=us-central1
POSITIONAL ARGUMENTS
Instance resource - Identifier. The unique name of the plugin instance
resource. Format:
projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument instance on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--plugin=PLUGIN
The plugin id of the instance resource.
To set the plugin attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --plugin on the command line.
REQUIRED FLAGS
--actions=[actionId=ACTIONID],[curationConfig=CURATIONCONFIG],[scheduleCronExpression=SCHEDULECRONEXPRESSION],[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]
Required, The action status for the plugin instance.
actionId
This should map to one of the [action
id][google.cloud.apihub.v1.PluginActionConfig.id] specified in
[actions_config][google.cloud.apihub.v1.Plugin.actions_config] in
the plugin.
curationConfig
This configuration should be provided if the plugin action is
publishing data to API hub curate layer.
curationType
The curation type for this plugin instance.
customCuration
Custom curation information for this plugin instance.
curation
The unique name of the curation resource. This will be the
name of the curation resource in the format:
projects/{project}/locations/{location}/curations/{curation}.
scheduleCronExpression
The schedule for this plugin instance action. This can only be set
if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this
action.
scheduleTimeZone
The time zone for the schedule cron expression. If not provided,
UTC will be used.
serviceAccount
The service account used to publish data. Note, the service account
will only be accepted for non-Google Cloud plugins like OPDK.
Shorthand Example:
--actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string --actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string
JSON Example:
--actions='[{"actionId": "string", "curationConfig": {"curationType": "string", "customCuration": {"curation": "string"}}, "scheduleCronExpression": "string", "scheduleTimeZone": "string", "serviceAccount": "string"}]'
File Example:
--actions=path_to_file.(yaml|json)
--display-name=DISPLAY_NAME
The display name for this plugin instance. Max length is 255
characters.
OPTIONAL FLAGS
--additional-config=[ADDITIONAL_CONFIG,...]
The additional information for this plugin instance corresponding to
the additional config template of the plugin. This information will be
sent to plugin hosting service on each call to plugin hosted service.
The key will be the config_variable_template.display_name to uniquely
identify the config variable.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
boolValue
The config variable value in case of config variable of type
boolean.
enumValue
The config variable value in case of config variable of type
enum.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
intValue
The config variable value in case of config variable of type
integer.
multiIntValues
The config variable value in case of config variable of type
multi integer.
values
The config variable value of data type multi int.
multiSelectValues
The config variable value in case of config variable of type
multi select.
values
The config variable value of data type multi select.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
multiStringValues
The config variable value in case of config variable of type
multi string.
values
The config variable value of data type multi string.
secretValue
The config variable value in case of config variable of type
secret.
secretVersion
The resource name of the secret version in the format,
format as: projects/*/secrets/*/versions/*.
stringValue
The config variable value in case of config variable of type
string.
Shorthand Example:
--additional-config=string={boolValue=boolean,enumValue={description=string,displayName=string,id=string},intValue=int,multiIntValues={values=[int]},multiSelectValues={values=[{description=string,displayName=string,id=string}]},multiStringValues={values=[string]},secretValue={secretVersion=string},stringValue=string}
JSON Example:
--additional-config='{"string": {"boolValue": boolean, "enumValue": {"description": "string", "displayName": "string", "id": "string"}, "intValue": int, "multiIntValues": {"values": [int]}, "multiSelectValues": {"values": [{"description": "string", "displayName": "string", "id": "string"}]}, "multiStringValues": {"values": ["string"]}, "secretValue": {"secretVersion": "string"}, "stringValue": "string"}}'
File Example:
--additional-config=path_to_file.(yaml|json)
--async
Return immediately, without waiting for the operation in progress to
complete.
--source-environments-config=[SOURCE_ENVIRONMENTS_CONFIG,...]
The source environment's config present in the gateway instance linked
to the plugin instance. The key is the source_environment name from the
SourceEnvironment message.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
createTime
The time at which the environment was created at the source.
sourceEnvironment
The name of the environment at the source. This should map to
[Deployment][google.cloud.apihub.v1.SourceEnvironment.source_environment].
sourceEnvironmentUri
The location where additional information about source
environments can be found. The location should be relative path
of the environment manifest with respect to a plugin instance.
updateTime
The time at which the environment was last updated at the
source.
Shorthand Example:
--source-environments-config=string={createTime=string,sourceEnvironment=string,sourceEnvironmentUri=string,updateTime=string}
JSON Example:
--source-environments-config='{"string": {"createTime": "string", "sourceEnvironment": "string", "sourceEnvironmentUri": "string", "updateTime": "string"}}'
File Example:
--source-environments-config=path_to_file.(yaml|json)
--source-project-id=SOURCE_PROJECT_ID
The source project id of the plugin instance. This will be the id of
runtime project in case of Google Cloud based plugins and org id in
case of non-Google Cloud based plugins. This field will be a required
field for Google provided on-ramp plugins.
AuthConfig represents the authentication information.
--auth-config-type=AUTH_CONFIG_TYPE
The authentication type. AUTH_CONFIG_TYPE must be one of:
api-key
API Key authentication.
google-service-account
Google service account authentication.
no-auth
No authentication.
oauth2-client-credentials
Oauth 2.0 client credentials grant authentication.
user-password
Username and password authentication.
This flag argument must be specified if any of the other arguments in
this group are specified.
Arguments for the config.
At most one of these can be specified:
Config for authentication with API key.
--api-key-config-http-element-location=API_KEY_CONFIG_HTTP_ELEMENT_LOCATION
The location of the API key. The default value is QUERY.
API_KEY_CONFIG_HTTP_ELEMENT_LOCATION must be one of:
body
Element is in the HTTP request body.
cookie
Element is in the HTTP request cookie.
header
Element is in the HTTP request header.
path
Element is in the HTTP request path.
query
Element is in the HTTP request query.
This flag argument must be specified if any of the other arguments in
this group are specified.
--api-key-config-name=API_KEY_CONFIG_NAME
The parameter name of the API key. E.g. If the API request is
"https://example.com/act?api_key=<API KEY>", "api_key" would be the
parameter name.
This flag argument must be specified if any of the other arguments in
this group are specified.
Secret provides a reference to entries in Secret Manager.
This must be specified.
--api-key-config-secret-version=API_KEY_CONFIG_SECRET_VERSION
The resource name of the secret version in the format, format as:
projects/*/secrets/*/versions/*.
Parameters to support Oauth 2.0 client credentials grant authentication.
See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
--oauth2-client-credentials-config-id=OAUTH2_CLIENT_CREDENTIALS_CONFIG_ID
The client identifier.
This flag argument must be specified if any of the other arguments in
this group are specified.
Secret provides a reference to entries in Secret Manager.
This must be specified.
--oauth2-client-credentials-config-secret-version=OAUTH2_CLIENT_CREDENTIALS_CONFIG_SECRET_VERSION
The resource name of the secret version in the format, format as:
projects/*/secrets/*/versions/*.
Parameters to support Username and Password Authentication.
Secret provides a reference to entries in Secret Manager.
This must be specified.
--user-password-config-secret-version=USER_PASSWORD_CONFIG_SECRET_VERSION
The resource name of the secret version in the format, format as:
projects/*/secrets/*/versions/*.
--user-password-config-username=USER_PASSWORD_CONFIG_USERNAME
Username.
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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins instances create

84
gcloud/alpha/apihub/plugins/instances/delete Normal file
View file

@ -0,0 +1,84 @@
NAME
gcloud alpha apihub plugins instances delete - delete a Plugin Instance
SYNOPSIS
gcloud alpha apihub plugins instances delete
(INSTANCE : --location=LOCATION --plugin=PLUGIN) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a plugin instance
EXAMPLES
To delete a plugin instance with the ID my-instance for plugin my-plugin,
run:
$ gcloud alpha apihub plugins instances delete my-instance \
--plugin=my-plugin --project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Instance resource - The name of the plugin instance to delete. Format:
projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}.
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument instance on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--plugin=PLUGIN
The plugin id of the instance resource.
To set the plugin attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --plugin on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins instances delete

78
gcloud/alpha/apihub/plugins/instances/describe Normal file
View file

@ -0,0 +1,78 @@
NAME
gcloud alpha apihub plugins instances describe - describe a Plugin Instance
SYNOPSIS
gcloud alpha apihub plugins instances describe
(INSTANCE : --location=LOCATION --plugin=PLUGIN) [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe a plugin instance
EXAMPLES
To describe a plugin instance with the ID my-instance for plugin my-plugin,
run:
$ gcloud alpha apihub plugins instances describe my-instance \
--plugin=my-plugin --project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Instance resource - The name of the plugin instance to retrieve. Format:
projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument instance on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--plugin=PLUGIN
The plugin id of the instance resource.
To set the plugin attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --plugin on the command line.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins instances describe

43
gcloud/alpha/apihub/plugins/instances/help Normal file
View file

@ -0,0 +1,43 @@
NAME
gcloud alpha apihub plugins instances - manage Plugin Instance resources
SYNOPSIS
gcloud alpha apihub plugins instances COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Plugin Instance resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) Create a Plugin Instance.
delete
(ALPHA) Delete a Plugin Instance.
describe
(ALPHA) Describe a Plugin Instance.
list
(ALPHA) List Plugin Instances.
manage-source-data
(ALPHA) manage pluginInstances.
update
(ALPHA) Update a Plugin Instance.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins instances

104
gcloud/alpha/apihub/plugins/instances/list Normal file
View file

@ -0,0 +1,104 @@
NAME
gcloud alpha apihub plugins instances list - list Plugin Instances
SYNOPSIS
gcloud alpha apihub plugins instances list
(--plugin=PLUGIN : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List plugin instances
EXAMPLES
To list all plugin instances for plugin my-plugin, run:
$ gcloud alpha apihub plugins instances list --plugin=my-plugin \
--project=my-project --location=us-central1
REQUIRED FLAGS
Plugin resource - The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}/plugins/{plugin}. To list
plugin instances for multiple plugins, use the - character instead of the
plugin ID. The arguments in this group can be used to specify the
attributes of this resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.
To set the project attribute:
◆ provide the argument --plugin on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
--plugin=PLUGIN
ID of the plugin or fully qualified identifier for the plugin.
To set the plugin attribute:
▸ provide the argument --plugin on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location id of the plugin resource.
To set the location attribute:
▸ provide the argument --plugin on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins instances list

107
gcloud/alpha/apihub/plugins/instances/manage-source-data Normal file
View file

@ -0,0 +1,107 @@
NAME
gcloud alpha apihub plugins instances manage-source-data - manage
pluginInstances
SYNOPSIS
gcloud alpha apihub plugins instances manage-source-data
(INSTANCE : --location=LOCATION --plugin=PLUGIN) --action=ACTION
--data=DATA --data-type=DATA_TYPE --relative-path=RELATIVE_PATH
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) manage pluginInstances
EXAMPLES
To manage all pluginInstances, run:
$ gcloud alpha apihub plugins instances manage-source-data
POSITIONAL ARGUMENTS
Instance resource - The name of the plugin instance for which data needs
to be managed. Format:
projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument instance on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--plugin=PLUGIN
The plugin id of the instance resource.
To set the plugin attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --plugin on the command line.
REQUIRED FLAGS
--action=ACTION
Action to be performed. ACTION must be one of:
delete
Delete data.
upload
Upload or upsert data.
--data=DATA
Data to be managed.
--data-type=DATA_TYPE
Type of data to be managed. DATA_TYPE must be one of:
environment-manifest
Environment manifest.
proxy-bundle
Proxy bundle.
proxy-deployment-manifest
Proxy deployment manifest.
shared-flow-bundle
Shared flow bundle.
--relative-path=RELATIVE_PATH
Relative path of data being managed for a given plugin instance.
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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins instances manage-source-data

668
gcloud/alpha/apihub/plugins/instances/update Normal file
View file

@ -0,0 +1,668 @@
NAME
gcloud alpha apihub plugins instances update - update a Plugin Instance
SYNOPSIS
gcloud alpha apihub plugins instances update
(INSTANCE : --location=LOCATION --plugin=PLUGIN)
[--display-name=DISPLAY_NAME] [--source-project-id=SOURCE_PROJECT_ID]
[--actions=[actionId=ACTIONID],[curationConfig=CURATIONCONFIG],
[scheduleCronExpression=SCHEDULECRONEXPRESSION],
[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]
| --add-actions=[actionId=ACTIONID],[curationConfig=CURATIONCONFIG],
[scheduleCronExpression=SCHEDULECRONEXPRESSION],
[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]
--clear-actions
| --remove-actions=[actionId=ACTIONID],
[curationConfig=CURATIONCONFIG],
[scheduleCronExpression=SCHEDULECRONEXPRESSION],
[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]]
[--additional-config=[ADDITIONAL_CONFIG,...]
| --update-additional-config=[UPDATE_ADDITIONAL_CONFIG,...]
--clear-additional-config
| --remove-additional-config=REMOVE_ADDITIONAL_CONFIG]
[--auth-config-type=AUTH_CONFIG_TYPE --clear-auth-config
--api-key-config-http-element-location=API_KEY_CONFIG_HTTP_ELEMENT_LOCATION --api-key-config-name=API_KEY_CONFIG_NAME --api-key-config-secret-version=API_KEY_CONFIG_SECRET_VERSION | --oauth2-client-credentials-config-id=OAUTH2_CLIENT_CREDENTIALS_CONFIG_ID --oauth2-client-credentials-config-secret-version=OAUTH2_CLIENT_CREDENTIALS_CONFIG_SECRET_VERSION | --user-password-config-secret-version=USER_PASSWORD_CONFIG_SECRET_VERSION --user-password-config-username=USER_PASSWORD_CONFIG_USERNAME]
[--source-environments-config=[SOURCE_ENVIRONMENTS_CONFIG,...]
| --update-source-environments-config=[UPDATE_SOURCE_ENVIRONMENTS_CONFIG,
...] --clear-source-environments-config
| --remove-source-environments-config=REMOVE_SOURCE_ENVIRONMENTS_CONFIG]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update a plugin instance
EXAMPLES
To update the display name of a plugin instance with the ID my-instance,
run:
$ gcloud alpha apihub plugins instances update my-instance \
--plugin=my-plugin --display-name="New Instance Name" \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Instance resource - Identifier. The unique name of the plugin instance
resource. Format:
projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument instance on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the instance attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the instance resource.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--plugin=PLUGIN
The plugin id of the instance resource.
To set the plugin attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --plugin on the command line.
FLAGS
--display-name=DISPLAY_NAME
The display name for this plugin instance. Max length is 255
characters.
--source-project-id=SOURCE_PROJECT_ID
The source project id of the plugin instance. This will be the id of
runtime project in case of Google Cloud based plugins and org id in
case of non-Google Cloud based plugins. This field will be a required
field for Google provided on-ramp plugins.
Update actions.
At most one of these can be specified:
--actions=[actionId=ACTIONID],[curationConfig=CURATIONCONFIG],[scheduleCronExpression=SCHEDULECRONEXPRESSION],[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]
Set actions to new value. The action status for the plugin instance.
actionId
This should map to one of the [action
id][google.cloud.apihub.v1.PluginActionConfig.id] specified in
[actions_config][google.cloud.apihub.v1.Plugin.actions_config] in
the plugin.
curationConfig
This configuration should be provided if the plugin action is
publishing data to API hub curate layer.
curationType
The curation type for this plugin instance.
customCuration
Custom curation information for this plugin instance.
curation
The unique name of the curation resource. This will be
the name of the curation resource in the format:
projects/{project}/locations/{location}/curations/{curation}.
scheduleCronExpression
The schedule for this plugin instance action. This can only be
set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this
action.
scheduleTimeZone
The time zone for the schedule cron expression. If not provided,
UTC will be used.
serviceAccount
The service account used to publish data. Note, the service
account will only be accepted for non-Google Cloud plugins like
OPDK.
Shorthand Example:
--actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string --actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string
JSON Example:
--actions='[{"actionId": "string", "curationConfig": {"curationType": "string", "customCuration": {"curation": "string"}}, "scheduleCronExpression": "string", "scheduleTimeZone": "string", "serviceAccount": "string"}]'
File Example:
--actions=path_to_file.(yaml|json)
Or at least one of these can be specified:
--add-actions=[actionId=ACTIONID],[curationConfig=CURATIONCONFIG],[scheduleCronExpression=SCHEDULECRONEXPRESSION],[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]
Add new value to actions list. The action status for the plugin
instance.
actionId
This should map to one of the [action
id][google.cloud.apihub.v1.PluginActionConfig.id] specified in
[actions_config][google.cloud.apihub.v1.Plugin.actions_config]
in the plugin.
curationConfig
This configuration should be provided if the plugin action is
publishing data to API hub curate layer.
curationType
The curation type for this plugin instance.
customCuration
Custom curation information for this plugin instance.
curation
The unique name of the curation resource. This will be
the name of the curation resource in the format:
projects/{project}/locations/{location}/curations/{curation}.
scheduleCronExpression
The schedule for this plugin instance action. This can only be
set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for
this action.
scheduleTimeZone
The time zone for the schedule cron expression. If not
provided, UTC will be used.
serviceAccount
The service account used to publish data. Note, the service
account will only be accepted for non-Google Cloud plugins like
OPDK.
Shorthand Example:
--add-actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string --add-actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string
JSON Example:
--add-actions='[{"actionId": "string", "curationConfig": {"curationType": "string", "customCuration": {"curation": "string"}}, "scheduleCronExpression": "string", "scheduleTimeZone": "string", "serviceAccount": "string"}]'
File Example:
--add-actions=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-actions
Clear actions value and set to empty list.
--remove-actions=[actionId=ACTIONID],[curationConfig=CURATIONCONFIG],[scheduleCronExpression=SCHEDULECRONEXPRESSION],[scheduleTimeZone=SCHEDULETIMEZONE],[serviceAccount=SERVICEACCOUNT]
Remove existing value from actions list. The action status for
the plugin instance.
actionId
This should map to one of the [action
id][google.cloud.apihub.v1.PluginActionConfig.id] specified
in
[actions_config][google.cloud.apihub.v1.Plugin.actions_config]
in the plugin.
curationConfig
This configuration should be provided if the plugin action is
publishing data to API hub curate layer.
curationType
The curation type for this plugin instance.
customCuration
Custom curation information for this plugin instance.
curation
The unique name of the curation resource. This will
be the name of the curation resource in the format:
projects/{project}/locations/{location}/curations/{curation}.
scheduleCronExpression
The schedule for this plugin instance action. This can only
be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode
for this action.
scheduleTimeZone
The time zone for the schedule cron expression. If not
provided, UTC will be used.
serviceAccount
The service account used to publish data. Note, the service
account will only be accepted for non-Google Cloud plugins
like OPDK.
Shorthand Example:
--remove-actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string --remove-actions=actionId=string,curationConfig={curationType=string,customCuration={curation=string}},scheduleCronExpression=string,scheduleTimeZone=string,serviceAccount=string
JSON Example:
--remove-actions='[{"actionId": "string", "curationConfig": {"curationType": "string", "customCuration": {"curation": "string"}}, "scheduleCronExpression": "string", "scheduleTimeZone": "string", "serviceAccount": "string"}]'
File Example:
--remove-actions=path_to_file.(yaml|json)
Update additional_config.
At most one of these can be specified:
--additional-config=[ADDITIONAL_CONFIG,...]
Set additional_config to new value. The additional information for
this plugin instance corresponding to the additional config template
of the plugin. This information will be sent to plugin hosting
service on each call to plugin hosted service. The key will be the
config_variable_template.display_name to uniquely identify the config
variable.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
boolValue
The config variable value in case of config variable of type
boolean.
enumValue
The config variable value in case of config variable of type
enum.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
intValue
The config variable value in case of config variable of type
integer.
multiIntValues
The config variable value in case of config variable of type
multi integer.
values
The config variable value of data type multi int.
multiSelectValues
The config variable value in case of config variable of type
multi select.
values
The config variable value of data type multi select.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
multiStringValues
The config variable value in case of config variable of type
multi string.
values
The config variable value of data type multi string.
secretValue
The config variable value in case of config variable of type
secret.
secretVersion
The resource name of the secret version in the format,
format as: projects/*/secrets/*/versions/*.
stringValue
The config variable value in case of config variable of type
string.
Shorthand Example:
--additional-config=string={boolValue=boolean,enumValue={description=string,displayName=string,id=string},intValue=int,multiIntValues={values=[int]},multiSelectValues={values=[{description=string,displayName=string,id=string}]},multiStringValues={values=[string]},secretValue={secretVersion=string},stringValue=string}
JSON Example:
--additional-config='{"string": {"boolValue": boolean, "enumValue": {"description": "string", "displayName": "string", "id": "string"}, "intValue": int, "multiIntValues": {"values": [int]}, "multiSelectValues": {"values": [{"description": "string", "displayName": "string", "id": "string"}]}, "multiStringValues": {"values": ["string"]}, "secretValue": {"secretVersion": "string"}, "stringValue": "string"}}'
File Example:
--additional-config=path_to_file.(yaml|json)
Or at least one of these can be specified:
--update-additional-config=[UPDATE_ADDITIONAL_CONFIG,...]
Update additional_config value or add key value pair. The
additional information for this plugin instance corresponding to
the additional config template of the plugin. This information will
be sent to plugin hosting service on each call to plugin hosted
service. The key will be the config_variable_template.display_name
to uniquely identify the config variable.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
boolValue
The config variable value in case of config variable of
type boolean.
enumValue
The config variable value in case of config variable of
type enum.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
intValue
The config variable value in case of config variable of
type integer.
multiIntValues
The config variable value in case of config variable of
type multi integer.
values
The config variable value of data type multi int.
multiSelectValues
The config variable value in case of config variable of
type multi select.
values
The config variable value of data type multi select.
description
Description of the option.
displayName
Display name of the option.
id
Id of the option.
multiStringValues
The config variable value in case of config variable of
type multi string.
values
The config variable value of data type multi string.
secretValue
The config variable value in case of config variable of
type secret.
secretVersion
The resource name of the secret version in the format,
format as: projects/*/secrets/*/versions/*.
stringValue
The config variable value in case of config variable of
type string.
Shorthand Example:
--update-additional-config=string={boolValue=boolean,enumValue={description=string,displayName=string,id=string},intValue=int,multiIntValues={values=[int]},multiSelectValues={values=[{description=string,displayName=string,id=string}]},multiStringValues={values=[string]},secretValue={secretVersion=string},stringValue=string}
JSON Example:
--update-additional-config='{"string": {"boolValue": boolean, "enumValue": {"description": "string", "displayName": "string", "id": "string"}, "intValue": int, "multiIntValues": {"values": [int]}, "multiSelectValues": {"values": [{"description": "string", "displayName": "string", "id": "string"}]}, "multiStringValues": {"values": ["string"]}, "secretValue": {"secretVersion": "string"}, "stringValue": "string"}}'
File Example:
--update-additional-config=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-additional-config
Clear additional_config value and set to empty map.
--remove-additional-config=REMOVE_ADDITIONAL_CONFIG
Remove existing value from map additional_config. Sets
remove_additional_config value.
Shorthand Example:
--remove-additional-config=string,string
JSON Example:
--remove-additional-config=["string"]
File Example:
--remove-additional-config=path_to_file.(yaml|json)
AuthConfig represents the authentication information.
--auth-config-type=AUTH_CONFIG_TYPE
The authentication type. AUTH_CONFIG_TYPE must be one of:
api-key
API Key authentication.
google-service-account
Google service account authentication.
no-auth
No authentication.
oauth2-client-credentials
Oauth 2.0 client credentials grant authentication.
user-password
Username and password authentication.
--clear-auth-config
Set googleCloudApihubV1PluginInstance.authConfig back to default value.
Arguments for the config.
At most one of these can be specified:
Config for authentication with API key.
--api-key-config-http-element-location=API_KEY_CONFIG_HTTP_ELEMENT_LOCATION
The location of the API key. The default value is QUERY.
API_KEY_CONFIG_HTTP_ELEMENT_LOCATION must be one of:
body
Element is in the HTTP request body.
cookie
Element is in the HTTP request cookie.
header
Element is in the HTTP request header.
path
Element is in the HTTP request path.
query
Element is in the HTTP request query.
--api-key-config-name=API_KEY_CONFIG_NAME
The parameter name of the API key. E.g. If the API request is
"https://example.com/act?api_key=<API KEY>", "api_key" would be the
parameter name.
Secret provides a reference to entries in Secret Manager.
--api-key-config-secret-version=API_KEY_CONFIG_SECRET_VERSION
The resource name of the secret version in the format, format as:
projects/*/secrets/*/versions/*.
Parameters to support Oauth 2.0 client credentials grant authentication.
See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
--oauth2-client-credentials-config-id=OAUTH2_CLIENT_CREDENTIALS_CONFIG_ID
The client identifier.
Secret provides a reference to entries in Secret Manager.
--oauth2-client-credentials-config-secret-version=OAUTH2_CLIENT_CREDENTIALS_CONFIG_SECRET_VERSION
The resource name of the secret version in the format, format as:
projects/*/secrets/*/versions/*.
Parameters to support Username and Password Authentication.
Secret provides a reference to entries in Secret Manager.
--user-password-config-secret-version=USER_PASSWORD_CONFIG_SECRET_VERSION
The resource name of the secret version in the format, format as:
projects/*/secrets/*/versions/*.
--user-password-config-username=USER_PASSWORD_CONFIG_USERNAME
Username.
Update source_environments_config.
At most one of these can be specified:
--source-environments-config=[SOURCE_ENVIRONMENTS_CONFIG,...]
Set source_environments_config to new value. The source environment's
config present in the gateway instance linked to the plugin instance.
The key is the source_environment name from the SourceEnvironment
message.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
createTime
The time at which the environment was created at the source.
sourceEnvironment
The name of the environment at the source. This should map to
[Deployment][google.cloud.apihub.v1.SourceEnvironment.source_environment].
sourceEnvironmentUri
The location where additional information about source
environments can be found. The location should be relative
path of the environment manifest with respect to a plugin
instance.
updateTime
The time at which the environment was last updated at the
source.
Shorthand Example:
--source-environments-config=string={createTime=string,sourceEnvironment=string,sourceEnvironmentUri=string,updateTime=string}
JSON Example:
--source-environments-config='{"string": {"createTime": "string", "sourceEnvironment": "string", "sourceEnvironmentUri": "string", "updateTime": "string"}}'
File Example:
--source-environments-config=path_to_file.(yaml|json)
Or at least one of these can be specified:
--update-source-environments-config=[UPDATE_SOURCE_ENVIRONMENTS_CONFIG,...]
Update source_environments_config value or add key value pair. The
source environment's config present in the gateway instance linked
to the plugin instance. The key is the source_environment name from
the SourceEnvironment message.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
createTime
The time at which the environment was created at the
source.
sourceEnvironment
The name of the environment at the source. This should map
to
[Deployment][google.cloud.apihub.v1.SourceEnvironment.source_environment].
sourceEnvironmentUri
The location where additional information about source
environments can be found. The location should be relative
path of the environment manifest with respect to a plugin
instance.
updateTime
The time at which the environment was last updated at the
source.
Shorthand Example:
--update-source-environments-config=string={createTime=string,sourceEnvironment=string,sourceEnvironmentUri=string,updateTime=string}
JSON Example:
--update-source-environments-config='{"string": {"createTime": "string", "sourceEnvironment": "string", "sourceEnvironmentUri": "string", "updateTime": "string"}}'
File Example:
--update-source-environments-config=path_to_file.(yaml|json)
At most one of these can be specified:
--clear-source-environments-config
Clear source_environments_config value and set to empty map.
--remove-source-environments-config=REMOVE_SOURCE_ENVIRONMENTS_CONFIG
Remove existing value from map source_environments_config. Sets
remove_source_environments_config value.
Shorthand Example:
--remove-source-environments-config=string,string
JSON Example:
--remove-source-environments-config=["string"]
File Example:
--remove-source-environments-config=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 command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins instances update

90
gcloud/alpha/apihub/plugins/list Normal file
View file

@ -0,0 +1,90 @@
NAME
gcloud alpha apihub plugins list - list Plugins
SYNOPSIS
gcloud alpha apihub plugins list --location=LOCATION [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List plugins
EXAMPLES
To list all plugins in project my-project and location us-central1, run:
$ gcloud alpha apihub plugins list --project=my-project \
--location=us-central1
REQUIRED FLAGS
Location resource - The parent resource where this plugin will be created.
Format: projects/{project}/locations/{location}. This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument --location on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud apihub plugins list