|
2608 | 2608 | "scopes": [
|
2609 | 2609 | "https://www.googleapis.com/auth/cloud-platform"
|
2610 | 2610 | ]
|
| 2611 | + }, |
| 2612 | + "patch": { |
| 2613 | + "description": "Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently: * display_name * schedule_cron_expression The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.", |
| 2614 | + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}", |
| 2615 | + "httpMethod": "PATCH", |
| 2616 | + "id": "apihub.projects.locations.plugins.instances.patch", |
| 2617 | + "parameterOrder": [ |
| 2618 | + "name" |
| 2619 | + ], |
| 2620 | + "parameters": { |
| 2621 | + "name": { |
| 2622 | + "description": "Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`", |
| 2623 | + "location": "path", |
| 2624 | + "pattern": "^projects/[^/]+/locations/[^/]+/plugins/[^/]+/instances/[^/]+$", |
| 2625 | + "required": true, |
| 2626 | + "type": "string" |
| 2627 | + }, |
| 2628 | + "updateMask": { |
| 2629 | + "description": "Optional. The list of fields to update.", |
| 2630 | + "format": "google-fieldmask", |
| 2631 | + "location": "query", |
| 2632 | + "type": "string" |
| 2633 | + } |
| 2634 | + }, |
| 2635 | + "path": "v1/{+name}", |
| 2636 | + "request": { |
| 2637 | + "$ref": "GoogleCloudApihubV1PluginInstance" |
| 2638 | + }, |
| 2639 | + "response": { |
| 2640 | + "$ref": "GoogleCloudApihubV1PluginInstance" |
| 2641 | + }, |
| 2642 | + "scopes": [ |
| 2643 | + "https://www.googleapis.com/auth/cloud-platform" |
| 2644 | + ] |
2611 | 2645 | }
|
2612 | 2646 | }
|
2613 | 2647 | },
|
|
2780 | 2814 | }
|
2781 | 2815 | }
|
2782 | 2816 | },
|
2783 |
| - "revision": "20250611", |
| 2817 | + "revision": "20250701", |
2784 | 2818 | "rootUrl": "https://apihub.googleapis.com/",
|
2785 | 2819 | "schemas": {
|
2786 | 2820 | "Empty": {
|
|
3941 | 3975 | "$ref": "GoogleCloudApihubV1AttributeValues",
|
3942 | 3976 | "description": "Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute."
|
3943 | 3977 | },
|
| 3978 | + "managementUrl": { |
| 3979 | + "$ref": "GoogleCloudApihubV1AttributeValues", |
| 3980 | + "description": "Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API." |
| 3981 | + }, |
3944 | 3982 | "name": {
|
3945 | 3983 | "description": "Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`",
|
3946 | 3984 | "type": "string"
|
|
3953 | 3991 | "$ref": "GoogleCloudApihubV1AttributeValues",
|
3954 | 3992 | "description": "Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute."
|
3955 | 3993 | },
|
| 3994 | + "sourceEnvironment": { |
| 3995 | + "description": "Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.", |
| 3996 | + "type": "string" |
| 3997 | + }, |
3956 | 3998 | "sourceMetadata": {
|
3957 | 3999 | "description": "Output only. The list of sources and metadata from the sources of the deployment.",
|
3958 | 4000 | "items": {
|
|
3961 | 4003 | "readOnly": true,
|
3962 | 4004 | "type": "array"
|
3963 | 4005 | },
|
| 4006 | + "sourceProject": { |
| 4007 | + "description": "Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.", |
| 4008 | + "type": "string" |
| 4009 | + }, |
| 4010 | + "sourceUri": { |
| 4011 | + "$ref": "GoogleCloudApihubV1AttributeValues", |
| 4012 | + "description": "Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API." |
| 4013 | + }, |
3964 | 4014 | "updateTime": {
|
3965 | 4015 | "description": "Output only. The time at which the deployment was last updated.",
|
3966 | 4016 | "format": "google-datetime",
|
|
4864 | 4914 | "$ref": "GoogleCloudApihubV1Documentation",
|
4865 | 4915 | "description": "Optional. The documentation of the plugin, that explains how to set up and use the plugin."
|
4866 | 4916 | },
|
| 4917 | + "gatewayType": { |
| 4918 | + "description": "Optional. The type of the gateway.", |
| 4919 | + "enum": [ |
| 4920 | + "GATEWAY_TYPE_UNSPECIFIED", |
| 4921 | + "APIGEE_X_AND_HYBRID", |
| 4922 | + "APIGEE_EDGE_PUBLIC_CLOUD", |
| 4923 | + "APIGEE_EDGE_PRIVATE_CLOUD", |
| 4924 | + "CLOUD_API_GATEWAY", |
| 4925 | + "CLOUD_ENDPOINTS", |
| 4926 | + "API_DISCOVERY", |
| 4927 | + "OTHERS" |
| 4928 | + ], |
| 4929 | + "enumDescriptions": [ |
| 4930 | + "The gateway type is not specified.", |
| 4931 | + "The gateway type is Apigee X and Hybrid.", |
| 4932 | + "The gateway type is Apigee Edge Public Cloud.", |
| 4933 | + "The gateway type is Apigee Edge Private Cloud.", |
| 4934 | + "The gateway type is Cloud API Gateway.", |
| 4935 | + "The gateway type is Cloud Endpoints.", |
| 4936 | + "The gateway type is API Discovery.", |
| 4937 | + "The gateway type for any other types of gateways." |
| 4938 | + ], |
| 4939 | + "type": "string" |
| 4940 | + }, |
4867 | 4941 | "hostingService": {
|
4868 | 4942 | "$ref": "GoogleCloudApihubV1HostingService",
|
4869 | 4943 | "description": "Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI."
|
|
5005 | 5079 | "description": "Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`",
|
5006 | 5080 | "type": "string"
|
5007 | 5081 | },
|
| 5082 | + "sourceProjectId": { |
| 5083 | + "description": "Optional. The source project id of the plugin instance. This will be the id of runtime project in case of gcp based plugins and org id in case of non gcp based plugins. This is a required field.", |
| 5084 | + "type": "string" |
| 5085 | + }, |
5008 | 5086 | "state": {
|
5009 | 5087 | "description": "Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).",
|
5010 | 5088 | "enum": [
|
|
5053 | 5131 | "$ref": "GoogleCloudApihubV1ExecutionStatus",
|
5054 | 5132 | "description": "Optional. The execution information for the plugin instance action done corresponding to an API hub instance."
|
5055 | 5133 | },
|
| 5134 | + "resourceConfig": { |
| 5135 | + "$ref": "GoogleCloudApihubV1ResourceConfig", |
| 5136 | + "description": "Output only. The configuration of resources created for a given plugin instance action. Note these will be returned only in case of Non-GCP plugins like OPDK.", |
| 5137 | + "readOnly": true |
| 5138 | + }, |
5056 | 5139 | "scheduleCronExpression": {
|
5057 | 5140 | "description": "Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.",
|
5058 | 5141 | "type": "string"
|
|
5061 | 5144 | "description": "Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.",
|
5062 | 5145 | "type": "string"
|
5063 | 5146 | },
|
| 5147 | + "serviceAccount": { |
| 5148 | + "description": "Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.", |
| 5149 | + "type": "string" |
| 5150 | + }, |
5064 | 5151 | "state": {
|
5065 | 5152 | "description": "Output only. The current state of the plugin action in the plugin instance.",
|
5066 | 5153 | "enum": [
|
|
5151 | 5238 | },
|
5152 | 5239 | "type": "object"
|
5153 | 5240 | },
|
| 5241 | + "GoogleCloudApihubV1ResourceConfig": { |
| 5242 | + "description": "The configuration of resources created for a given plugin instance action.", |
| 5243 | + "id": "GoogleCloudApihubV1ResourceConfig", |
| 5244 | + "properties": { |
| 5245 | + "actionType": { |
| 5246 | + "description": "Output only. The type of the action.", |
| 5247 | + "enum": [ |
| 5248 | + "ACTION_TYPE_UNSPECIFIED", |
| 5249 | + "SYNC_METADATA", |
| 5250 | + "SYNC_RUNTIME_DATA" |
| 5251 | + ], |
| 5252 | + "enumDescriptions": [ |
| 5253 | + "Default unspecified action type.", |
| 5254 | + "Action type for sync metadata.", |
| 5255 | + "Action type for sync runtime data." |
| 5256 | + ], |
| 5257 | + "readOnly": true, |
| 5258 | + "type": "string" |
| 5259 | + }, |
| 5260 | + "pubsubTopic": { |
| 5261 | + "description": "Output only. The pubsub topic to publish the data to. Format is projects/{project}/topics/{topic}", |
| 5262 | + "readOnly": true, |
| 5263 | + "type": "string" |
| 5264 | + } |
| 5265 | + }, |
| 5266 | + "type": "object" |
| 5267 | + }, |
5154 | 5268 | "GoogleCloudApihubV1RuntimeProjectAttachment": {
|
5155 | 5269 | "description": "Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.",
|
5156 | 5270 | "id": "GoogleCloudApihubV1RuntimeProjectAttachment",
|
|
0 commit comments