{ "fullyEncodeReservedExpansion": true, "kind": "discovery#restDescription", "resources": { "billingAccounts": { "methods": { "setIamPolicy": { "httpMethod": "POST", "flatPath": "v1/billingAccounts/{billingAccountsId}:setIamPolicy", "parameters": { "resource": { "location": "path", "required": true, "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^billingAccounts/[^/]+$", "type": "string" } }, "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access).", "response": { "$ref": "Policy" }, "id": "cloudbilling.billingAccounts.setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" } }, "create": { "flatPath": "v1/billingAccounts", "path": "v1/billingAccounts", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [], "httpMethod": "POST", "response": { "$ref": "BillingAccount" }, "request": { "$ref": "BillingAccount" }, "parameters": { "parent": { "location": "query", "description": "Optional. The parent to create a billing account from. Format: - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`", "type": "string" } }, "description": "This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.", "id": "cloudbilling.billingAccounts.create" }, "testIamPermissions": { "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "pattern": "^billingAccounts/[^/]+$", "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "required": true, "location": "path", "type": "string" } }, "description": "Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.", "flatPath": "v1/billingAccounts/{billingAccountsId}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "httpMethod": "POST", "path": "v1/{+resource}:testIamPermissions", "parameterOrder": [ "resource" ], "id": "cloudbilling.billingAccounts.testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" } }, "get": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a billing account. The current authenticated user must be a [viewer of the billing account](https://cloud.google.com/billing/docs/how-to/billing-access).", "path": "v1/{+name}", "parameters": { "name": { "pattern": "^billingAccounts/[^/]+$", "type": "string", "required": true, "description": "Required. The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`.", "location": "path" } }, "flatPath": "v1/billingAccounts/{billingAccountsId}", "parameterOrder": [ "name" ], "response": { "$ref": "BillingAccount" }, "id": "cloudbilling.billingAccounts.get" }, "move": { "path": "v1/{+name}:move", "description": "Changes which parent organization a billing account belongs to.", "flatPath": "v1/billingAccounts/{billingAccountsId}:move", "id": "cloudbilling.billingAccounts.move", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the billing account to move. Must be of the form `billingAccounts/{billing_account_id}`. The specified billing account cannot be a subaccount, since a subaccount always belongs to the same organization as its parent account.", "required": true, "type": "string", "location": "path", "pattern": "^billingAccounts/[^/]+$" } }, "httpMethod": "POST", "request": { "$ref": "MoveBillingAccountRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "BillingAccount" } }, "getIamPolicy": { "id": "cloudbilling.billingAccounts.getIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/billingAccounts/{billingAccountsId}:getIamPolicy", "parameters": { "options.requestedPolicyVersion": { "type": "integer", "location": "query", "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "format": "int32" }, "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "type": "string", "location": "path", "required": true, "pattern": "^billingAccounts/[^/]+$" } }, "response": { "$ref": "Policy" }, "httpMethod": "GET", "description": "Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access).", "parameterOrder": [ "resource" ], "path": "v1/{+resource}:getIamPolicy" }, "patch": { "flatPath": "v1/billingAccounts/{billingAccountsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "request": { "$ref": "BillingAccount" }, "id": "cloudbilling.billingAccounts.patch", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the billing account resource to be updated.", "type": "string", "pattern": "^billingAccounts/[^/]+$", "location": "path", "required": true }, "updateMask": { "description": "The update mask applied to the resource. Only \"display_name\" is currently supported.", "location": "query", "format": "google-fieldmask", "type": "string" } }, "response": { "$ref": "BillingAccount" }, "parameterOrder": [ "name" ], "description": "Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account." }, "list": { "response": { "$ref": "ListBillingAccountsResponse" }, "id": "cloudbilling.billingAccounts.list", "parameterOrder": [], "flatPath": "v1/billingAccounts", "httpMethod": "GET", "description": "Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.", "type": "string", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (for example, `master_billing_account=billingAccounts/012345-678901-ABCDEF`). Boolean algebra and other fields are not currently supported." }, "parent": { "location": "query", "type": "string", "description": "Optional. The parent resource to list billing accounts from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`" }, "pageSize": { "type": "integer", "format": "int32", "description": "Requested page size. The maximum page size is 100; this is also the default.", "location": "query" } }, "path": "v1/billingAccounts" } }, "resources": { "subAccounts": { "methods": { "create": { "path": "v1/{+parent}/subAccounts", "parameterOrder": [ "parent" ], "description": "This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.", "httpMethod": "POST", "response": { "$ref": "BillingAccount" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "pattern": "^billingAccounts/[^/]+$", "required": true, "type": "string", "description": "Optional. The parent to create a billing account from. Format: - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`" } }, "id": "cloudbilling.billingAccounts.subAccounts.create", "request": { "$ref": "BillingAccount" }, "flatPath": "v1/billingAccounts/{billingAccountsId}/subAccounts" }, "list": { "parameterOrder": [ "parent" ], "description": "Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).", "path": "v1/{+parent}/subAccounts", "flatPath": "v1/billingAccounts/{billingAccountsId}/subAccounts", "id": "cloudbilling.billingAccounts.subAccounts.list", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "location": "query", "description": "Requested page size. The maximum page size is 100; this is also the default.", "type": "integer", "format": "int32" }, "filter": { "location": "query", "type": "string", "description": "Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (for example, `master_billing_account=billingAccounts/012345-678901-ABCDEF`). Boolean algebra and other fields are not currently supported." }, "pageToken": { "type": "string", "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.", "location": "query" }, "parent": { "required": true, "location": "path", "type": "string", "pattern": "^billingAccounts/[^/]+$", "description": "Optional. The parent resource to list billing accounts from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`" } }, "response": { "$ref": "ListBillingAccountsResponse" }, "httpMethod": "GET" } } }, "projects": { "methods": { "list": { "path": "v1/{+name}/projects", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "Requested page size. The maximum page size is 100; this is also the default.", "location": "query" }, "name": { "type": "string", "description": "Required. The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`.", "pattern": "^billingAccounts/[^/]+$", "required": true, "location": "path" }, "pageToken": { "location": "query", "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned.", "type": "string" } }, "flatPath": "v1/billingAccounts/{billingAccountsId}/projects", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "id": "cloudbilling.billingAccounts.projects.list", "httpMethod": "GET", "response": { "$ref": "ListProjectBillingInfoResponse" }, "description": "Lists the projects associated with a billing account. The current authenticated user must have the `billing.resourceAssociations.list` IAM permission, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how-to/billing-access).", "parameterOrder": [ "name" ] } } } } }, "message": { "methods": { "send": { "flatPath": "v1/message:send", "httpMethod": "POST", "path": "v1/message:send", "parameters": {}, "request": { "$ref": "SendMessageRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [], "response": { "$ref": "SendMessageResponse" }, "description": "Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.", "id": "cloudbilling.message.send" }, "stream": { "request": { "$ref": "SendMessageRequest" }, "flatPath": "v1/message:stream", "id": "cloudbilling.message.stream", "parameterOrder": [], "parameters": {}, "path": "v1/message:stream", "response": { "$ref": "StreamResponse" }, "description": "SendStreamingMessage is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ] } } }, "organizations": { "resources": { "billingAccounts": { "methods": { "list": { "path": "v1/{+parent}/billingAccounts", "parameterOrder": [ "parent" ], "flatPath": "v1/organizations/{organizationsId}/billingAccounts", "httpMethod": "GET", "description": "Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).", "id": "cloudbilling.organizations.billingAccounts.list", "response": { "$ref": "ListBillingAccountsResponse" }, "parameters": { "pageToken": { "type": "string", "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.", "location": "query" }, "parent": { "location": "path", "type": "string", "required": true, "description": "Optional. The parent resource to list billing accounts from. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`", "pattern": "^organizations/[^/]+$" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "Requested page size. The maximum page size is 100; this is also the default." }, "filter": { "description": "Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (for example, `master_billing_account=billingAccounts/012345-678901-ABCDEF`). Boolean algebra and other fields are not currently supported.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ] }, "move": { "flatPath": "v1/organizations/{organizationsId}/billingAccounts/{billingAccountsId}:move", "httpMethod": "GET", "description": "Changes which parent organization a billing account belongs to.", "parameters": { "name": { "location": "path", "required": true, "description": "Required. The resource name of the billing account to move. Must be of the form `billingAccounts/{billing_account_id}`. The specified billing account cannot be a subaccount, since a subaccount always belongs to the same organization as its parent account.", "pattern": "^billingAccounts/[^/]+$", "type": "string" }, "destinationParent": { "pattern": "^organizations/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. The resource name of the Organization to move the billing account under. Must be of the form `organizations/{organization_id}`." } }, "path": "v1/{+destinationParent}/{+name}:move", "id": "cloudbilling.organizations.billingAccounts.move", "response": { "$ref": "BillingAccount" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "destinationParent", "name" ] }, "create": { "request": { "$ref": "BillingAccount" }, "response": { "$ref": "BillingAccount" }, "description": "This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.", "id": "cloudbilling.organizations.billingAccounts.create", "parameters": { "parent": { "pattern": "^organizations/[^/]+$", "description": "Optional. The parent to create a billing account from. Format: - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`", "location": "path", "required": true, "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/billingAccounts", "parameterOrder": [ "parent" ], "httpMethod": "POST", "flatPath": "v1/organizations/{organizationsId}/billingAccounts" } } } } }, "v1": { "methods": { "getCard": { "id": "cloudbilling.getCard", "response": { "$ref": "AgentCard" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "description": "GetAgentCard returns the agent card for the agent.", "flatPath": "v1/card", "path": "v1/card", "parameters": { "tenant": { "location": "query", "type": "string", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release." } }, "parameterOrder": [], "httpMethod": "GET" } } }, "tasks": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get the current state of a task from the agent.", "response": { "$ref": "Task" }, "parameterOrder": [ "name" ], "id": "cloudbilling.tasks.get", "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/tasks/{tasksId}", "parameters": { "historyLength": { "type": "integer", "description": "The number of most recent messages from the task's history to retrieve.", "format": "int32", "location": "query" }, "tenant": { "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "query", "type": "string" }, "name": { "location": "path", "required": true, "type": "string", "pattern": "^tasks/[^/]+$", "description": "Required. The resource name of the task. Format: tasks/{task_id}" } } }, "subscribe": { "path": "v1/{+name}:subscribe", "flatPath": "v1/tasks/{tasksId}:subscribe", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.", "id": "cloudbilling.tasks.subscribe", "parameters": { "tenant": { "type": "string", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "query" }, "name": { "type": "string", "location": "path", "description": "The resource name of the task to subscribe to. Format: tasks/{task_id}", "pattern": "^tasks/[^/]+$", "required": true } }, "response": { "$ref": "StreamResponse" } }, "cancel": { "flatPath": "v1/tasks/{tasksId}:cancel", "httpMethod": "POST", "request": { "$ref": "CancelTaskRequest" }, "description": "Cancel a task from the agent. If supported one should expect no more task updates for the task.", "id": "cloudbilling.tasks.cancel", "parameters": { "name": { "pattern": "^tasks/[^/]+$", "required": true, "location": "path", "description": "The resource name of the task to cancel. Format: tasks/{task_id}", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Task" }, "path": "v1/{+name}:cancel", "parameterOrder": [ "name" ] } }, "resources": { "pushNotificationConfigs": { "methods": { "delete": { "flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "parameters": { "name": { "type": "string", "required": true, "description": "The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}", "location": "path", "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$" }, "tenant": { "type": "string", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "query" } }, "httpMethod": "DELETE", "id": "cloudbilling.tasks.pushNotificationConfigs.delete", "path": "v1/{+name}", "description": "Delete a push notification config for a task.", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "parameters": { "tenant": { "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "query", "type": "string" }, "name": { "type": "string", "description": "The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}", "pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "httpMethod": "GET", "response": { "$ref": "TaskPushNotificationConfig" }, "description": "Get a push notification config for a task.", "id": "cloudbilling.tasks.pushNotificationConfigs.get", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}" }, "list": { "flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "id": "cloudbilling.tasks.pushNotificationConfigs.list", "parameterOrder": [ "parent" ], "description": "Get a list of push notifications configured for a task.", "path": "v1/{+parent}/pushNotificationConfigs", "response": { "$ref": "ListTaskPushNotificationConfigResponse" }, "parameters": { "tenant": { "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "description": "For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.", "format": "int32", "type": "integer" }, "pageToken": { "type": "string", "location": "query", "description": "A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token." }, "parent": { "description": "The parent task resource. Format: tasks/{task_id}", "type": "string", "location": "path", "required": true, "pattern": "^tasks/[^/]+$" } }, "httpMethod": "GET" }, "create": { "parameterOrder": [ "parent" ], "parameters": { "configId": { "type": "string", "description": "Required. The ID for the new config.", "location": "query" }, "tenant": { "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "location": "query", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent task resource for this config. Format: tasks/{task_id}", "location": "path", "pattern": "^tasks/[^/]+/pushNotificationConfigs$", "required": true } }, "description": "Set a push notification config for a task.", "request": { "$ref": "TaskPushNotificationConfig" }, "id": "cloudbilling.tasks.pushNotificationConfigs.create", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "TaskPushNotificationConfig" }, "path": "v1/{+parent}", "flatPath": "v1/tasks/{tasksId}/pushNotificationConfigs" } } } } }, "projects": { "methods": { "getBillingInfo": { "response": { "$ref": "ProjectBillingInfo" }, "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`.", "pattern": "^projects/[^/]+$" } }, "id": "cloudbilling.projects.getBillingInfo", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/billingInfo", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the billing information for a project. The current authenticated user must have the `resourcemanager.projects.get` permission for the project, which can be granted by assigning the [Project Viewer](https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) role.", "path": "v1/{+name}/billingInfo" }, "updateBillingInfo": { "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+$", "description": "Required. The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`.", "required": true, "location": "path" } }, "request": { "$ref": "ProjectBillingInfo" }, "flatPath": "v1/projects/{projectsId}/billingInfo", "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ProjectBillingInfo" }, "description": "Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Cloud Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://cloud.google.com/billing/docs/how-to/billing-access). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.", "id": "cloudbilling.projects.updateBillingInfo", "path": "v1/{+name}/billingInfo", "parameterOrder": [ "name" ] } } }, "services": { "resources": { "skus": { "methods": { "list": { "response": { "$ref": "ListSkusResponse" }, "description": "Lists all publicly available SKUs for a given cloud service.", "httpMethod": "GET", "id": "cloudbilling.services.skus.list", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "description": "Required. The name of the service. Example: \"services/6F81-5844-456A\"", "pattern": "^services/[^/]+$", "location": "path", "required": true }, "currencyCode": { "type": "string", "description": "The ISO 4217 currency code for the pricing info in the response proto. Will use the conversion rate as of start_time. Optional. If not specified USD will be used.", "location": "query" }, "endTime": { "location": "query", "type": "string", "format": "google-datetime", "description": "Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most)." }, "pageToken": { "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListSkus` call. If unspecified, the first page of results is returned.", "type": "string", "location": "query" }, "startTime": { "description": "Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).", "location": "query", "type": "string", "format": "google-datetime" }, "pageSize": { "format": "int32", "location": "query", "description": "Requested page size. Defaults to 5000.", "type": "integer" } }, "path": "v1/{+parent}/skus", "parameterOrder": [ "parent" ], "flatPath": "v1/services/{servicesId}/skus" } } } }, "methods": { "list": { "description": "Lists all public cloud services.", "path": "v1/services", "scopes": [ "https://www.googleapis.com/auth/cloud-billing", "https://www.googleapis.com/auth/cloud-billing.readonly", "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListServicesResponse" }, "parameters": { "pageSize": { "location": "query", "description": "Requested page size. Defaults to 5000.", "type": "integer", "format": "int32" }, "pageToken": { "type": "string", "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListServices` call. If unspecified, the first page of results is returned.", "location": "query" } }, "parameterOrder": [], "id": "cloudbilling.services.list", "httpMethod": "GET", "flatPath": "v1/services" } } } }, "protocol": "rest", "parameters": { "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "prettyPrint": { "type": "boolean", "location": "query", "default": "true", "description": "Returns response with indentations and line breaks." }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "alt": { "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "default": "json", "type": "string" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "key": { "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" } }, "mtlsRootUrl": "https://cloudbilling.mtls.googleapis.com/", "name": "cloudbilling", "batchPath": "batch", "title": "Cloud Billing API", "id": "cloudbilling:v1", "baseUrl": "https://cloudbilling.googleapis.com/", "ownerDomain": "google.com", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/cloud-billing.readonly": { "description": "View your Google Cloud Platform billing accounts" }, "https://www.googleapis.com/auth/cloud-billing": { "description": "View and manage your Google Cloud Platform billing accounts" } } } }, "canonicalName": "Cloudbilling", "rootUrl": "https://cloudbilling.googleapis.com/", "description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.", "discoveryVersion": "v1", "version": "v1", "documentationLink": "https://cloud.google.com/billing/docs/apis", "ownerName": "Google", "revision": "20261002", "servicePath": "", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "basePath": "", "schemas": { "TestIamPermissionsResponse": { "id": "TestIamPermissionsResponse", "type": "object", "description": "Response message for `TestIamPermissions` method.", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed." } } }, "FilePart": { "type": "object", "id": "FilePart", "properties": { "name": { "type": "string" }, "fileWithBytes": { "type": "string", "format": "byte" }, "fileWithUri": { "type": "string" }, "mimeType": { "type": "string" } }, "description": "FilePart represents the different ways files can be provided. If files are small, directly feeding the bytes is supported via file_with_bytes. If the file is large, the agent should read the content as appropriate directly from the file_with_uri source." }, "TierRate": { "id": "TierRate", "description": "The price rate indicating starting usage and its corresponding price.", "properties": { "startUsageAmount": { "description": "Usage is priced at this rate only after this amount. Example: start_usage_amount of 10 indicates that the usage will be priced at the unit_price after the first 10 usage_units.", "type": "number", "format": "double" }, "unitPrice": { "description": "The price per unit of usage. Example: unit_price of amount $10 indicates that each unit will cost $10.", "$ref": "Money" } }, "type": "object" }, "HTTPAuthSecurityScheme": { "type": "object", "properties": { "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes." }, "scheme": { "description": "The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235.", "type": "string" }, "description": { "type": "string", "description": "Description of this security scheme." } }, "id": "HTTPAuthSecurityScheme" }, "Expr": { "properties": { "expression": { "type": "string", "description": "Textual representation of an expression in Common Expression Language syntax." }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" } }, "type": "object", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr" }, "Artifact": { "id": "Artifact", "properties": { "artifactId": { "type": "string", "description": "Unique identifier (e.g. UUID) for the artifact. It must be at least unique within a task." }, "description": { "description": "A human readable description of the artifact, optional.", "type": "string" }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Artifact.", "items": { "type": "string" }, "type": "array" }, "parts": { "items": { "$ref": "Part" }, "description": "The content of the artifact.", "type": "array" }, "metadata": { "type": "object", "description": "Optional metadata included with the artifact.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "name": { "description": "A human readable name for the artifact.", "type": "string" } }, "description": "Artifacts are the container for task completed results. These are similar to Messages but are intended to be the product of a task, as opposed to point-to-point communication.", "type": "object" }, "ClientCredentialsOAuthFlow": { "properties": { "scopes": { "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "additionalProperties": { "type": "string" }, "type": "object" }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS." }, "tokenUrl": { "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" } }, "id": "ClientCredentialsOAuthFlow", "type": "object" }, "SetIamPolicyRequest": { "id": "SetIamPolicyRequest", "type": "object", "properties": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`" }, "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "Policy" } }, "description": "Request message for `SetIamPolicy` method." }, "AgentCapabilities": { "properties": { "streaming": { "description": "If the agent will support streaming responses", "type": "boolean" }, "extensions": { "type": "array", "description": "Extensions supported by this agent.", "items": { "$ref": "AgentExtension" } }, "pushNotifications": { "description": "If the agent can send push notifications to the clients webhook", "type": "boolean" } }, "type": "object", "id": "AgentCapabilities", "description": "Defines the A2A feature set supported by the agent" }, "AggregationInfo": { "type": "object", "properties": { "aggregationInterval": { "enumDescriptions": [ "", "", "" ], "enum": [ "AGGREGATION_INTERVAL_UNSPECIFIED", "DAILY", "MONTHLY" ], "type": "string" }, "aggregationCount": { "format": "int32", "type": "integer", "description": "The number of intervals to aggregate over. Example: If aggregation_level is \"DAILY\" and aggregation_count is 14, aggregation will be over 14 days." }, "aggregationLevel": { "enum": [ "AGGREGATION_LEVEL_UNSPECIFIED", "ACCOUNT", "PROJECT" ], "enumDescriptions": [ "", "", "" ], "type": "string" } }, "id": "AggregationInfo", "description": "Represents the aggregation level and interval for pricing of a single SKU." }, "Message": { "id": "Message", "description": "Message is one unit of communication between client and server. It is associated with a context and optionally a task. Since the server is responsible for the context definition, it must always provide a context_id in its messages. The client can optionally provide the context_id if it knows the context to associate the message to. Similarly for task_id, except the server decides if a task is created and whether to include the task_id.", "type": "object", "properties": { "taskId": { "type": "string", "description": "The task id of the message. This is optional and if set, the message will be associated with the given task." }, "role": { "description": "A role for the message.", "enumDescriptions": [ "", "USER role refers to communication from the client to the server.", "AGENT role refers to communication from the server to the client." ], "type": "string", "enum": [ "ROLE_UNSPECIFIED", "ROLE_USER", "ROLE_AGENT" ] }, "metadata": { "type": "object", "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED Any optional metadata to provide along with the message.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "messageId": { "description": "The unique identifier (e.g. UUID)of the message. This is required and created by the message creator.", "type": "string" }, "contextId": { "type": "string", "description": "The context id of the message. This is optional and if set, the message will be associated with the given context." }, "content": { "type": "array", "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Content is the container of the message content.", "items": { "$ref": "Part" } }, "extensions": { "description": "The URIs of extensions that are present or contributed to this Message.", "items": { "type": "string" }, "type": "array" } } }, "OpenIdConnectSecurityScheme": { "id": "OpenIdConnectSecurityScheme", "type": "object", "properties": { "openIdConnectUrl": { "type": "string", "description": "Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata." }, "description": { "description": "Description of this security scheme.", "type": "string" } } }, "SendMessageResponse": { "id": "SendMessageResponse", "description": "////// Response Messages ///////////", "type": "object", "properties": { "task": { "$ref": "Task" }, "message": { "$ref": "Message" } } }, "AuthorizationCodeOAuthFlow": { "type": "object", "properties": { "refreshUrl": { "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS." }, "authorizationUrl": { "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS", "type": "string" }, "scopes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty." } }, "id": "AuthorizationCodeOAuthFlow" }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "properties": { "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "Expr" }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array", "items": { "type": "string" } } }, "type": "object", "id": "Binding" }, "SendMessageRequest": { "properties": { "configuration": { "$ref": "SendMessageConfiguration", "description": "Configuration for the send request." }, "tenant": { "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.", "type": "string" }, "message": { "$ref": "Message", "description": "Required. The message to send to the agent." }, "metadata": { "description": "Optional metadata for the request.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "SendMessageRequest", "description": "/////////// Request Messages ///////////", "type": "object" }, "Service": { "properties": { "name": { "type": "string", "description": "The resource name for the service. Example: \"services/6F81-5844-456A\"" }, "businessEntityName": { "type": "string", "description": "The business under which the service is offered. Ex. \"businessEntities/GCP\", \"businessEntities/Maps\"" }, "displayName": { "type": "string", "description": "A human readable display name for this service." }, "serviceId": { "description": "The identifier for the service. Example: \"6F81-5844-456A\"", "type": "string" } }, "id": "Service", "type": "object", "description": "Encapsulates a single service in Google Cloud Platform." }, "OAuth2SecurityScheme": { "id": "OAuth2SecurityScheme", "type": "object", "properties": { "oauth2MetadataUrl": { "description": "URL to the oauth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.", "type": "string" }, "description": { "type": "string", "description": "Description of this security scheme." }, "flows": { "description": "An object containing configuration information for the flow types supported", "$ref": "OAuthFlows" } } }, "Policy": { "properties": { "auditConfigs": { "items": { "$ref": "AuditConfig" }, "description": "Specifies cloud audit logging configuration for this policy.", "type": "array" }, "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" }, "bindings": { "type": "array", "items": { "$ref": "Binding" }, "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`." }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "format": "byte", "type": "string" } }, "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "type": "object", "id": "Policy" }, "ListProjectBillingInfoResponse": { "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.", "type": "string" }, "projectBillingInfo": { "type": "array", "items": { "$ref": "ProjectBillingInfo" }, "description": "A list of `ProjectBillingInfo` resources representing the projects associated with the billing account." } }, "description": "Request message for `ListProjectBillingInfoResponse`.", "type": "object", "id": "ListProjectBillingInfoResponse" }, "ListTaskPushNotificationConfigResponse": { "id": "ListTaskPushNotificationConfigResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "configs": { "description": "The list of push notification configurations.", "type": "array", "items": { "$ref": "TaskPushNotificationConfig" } } }, "type": "object" }, "ListServicesResponse": { "description": "Response message for `ListServices`.", "id": "ListServicesResponse", "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "Service" }, "description": "A list of services." }, "nextPageToken": { "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListServices` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.", "type": "string" } } }, "ProjectBillingInfo": { "description": "Encapsulation of billing information for a Google Cloud Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).", "id": "ProjectBillingInfo", "properties": { "billingEnabled": { "description": "Output only. True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services.", "readOnly": true, "type": "boolean" }, "billingAccountName": { "type": "string", "description": "The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`." }, "projectId": { "type": "string", "readOnly": true, "description": "Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID." }, "name": { "description": "Output only. The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`.", "readOnly": true, "type": "string" } }, "type": "object" }, "TaskArtifactUpdateEvent": { "properties": { "artifact": { "$ref": "Artifact", "description": "The artifact itself" }, "metadata": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional metadata associated with the artifact update.", "type": "object" }, "append": { "type": "boolean", "description": "Whether this should be appended to a prior one produced" }, "contextId": { "description": "The id of the context that this task belongs too", "type": "string" }, "lastChunk": { "description": "Whether this represents the last part of an artifact", "type": "boolean" }, "taskId": { "description": "The id of the task for this artifact", "type": "string" } }, "description": "TaskArtifactUpdateEvent represents a task delta where an artifact has been generated.", "id": "TaskArtifactUpdateEvent", "type": "object" }, "TestIamPermissionsRequest": { "properties": { "permissions": { "type": "array", "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "items": { "type": "string" } } }, "type": "object", "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest" }, "MoveBillingAccountRequest": { "description": "Request message for `MoveBillingAccount` RPC.", "id": "MoveBillingAccountRequest", "properties": { "destinationParent": { "description": "Required. The resource name of the Organization to move the billing account under. Must be of the form `organizations/{organization_id}`.", "type": "string" } }, "type": "object" }, "AuthenticationInfo": { "properties": { "schemes": { "items": { "type": "string" }, "description": "Supported authentication schemes - e.g. Basic, Bearer, etc", "type": "array" }, "credentials": { "description": "Optional credentials", "type": "string" } }, "id": "AuthenticationInfo", "description": "Defines authentication details, used for push notifications.", "type": "object" }, "AuditConfig": { "id": "AuditConfig", "properties": { "auditLogConfigs": { "type": "array", "items": { "$ref": "AuditLogConfig" }, "description": "The configuration for logging of each type of permission." }, "service": { "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" } }, "type": "object", "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging." }, "PushNotificationConfig": { "id": "PushNotificationConfig", "description": "Configuration for setting up push notifications for task updates.", "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier (e.g. UUID) for this push notification." }, "token": { "type": "string", "description": "Token unique for this task/session" }, "authentication": { "description": "Information about the authentication to sent with the notification", "$ref": "AuthenticationInfo" }, "url": { "description": "Url to send the notification too", "type": "string" } } }, "SecurityScheme": { "properties": { "oauth2SecurityScheme": { "$ref": "OAuth2SecurityScheme" }, "apiKeySecurityScheme": { "$ref": "APIKeySecurityScheme" }, "mtlsSecurityScheme": { "$ref": "MutualTlsSecurityScheme" }, "openIdConnectSecurityScheme": { "$ref": "OpenIdConnectSecurityScheme" }, "httpAuthSecurityScheme": { "$ref": "HTTPAuthSecurityScheme" } }, "id": "SecurityScheme", "type": "object" }, "AuditLogConfig": { "id": "AuditLogConfig", "properties": { "logType": { "description": "The log type that this config enables.", "type": "string", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ] }, "exemptedMembers": { "type": "array", "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" } } }, "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "type": "object" }, "AgentExtension": { "properties": { "description": { "type": "string", "description": "A description of how this agent uses this extension. Example: \"Google OAuth 2.0 authentication\"" }, "params": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional configuration for the extension.", "type": "object" }, "required": { "description": "Whether the client must follow specific requirements of the extension. Example: false", "type": "boolean" }, "uri": { "type": "string", "description": "The URI of the extension. Example: \"https://developers.google.com/identity/protocols/oauth2\"" } }, "id": "AgentExtension", "type": "object", "description": "A declaration of an extension supported by an Agent." }, "AgentInterface": { "properties": { "tenant": { "description": "Tenant to be set in the request when calling the agent. Experimental, might still change for 1.0 release.", "type": "string" }, "transport": { "type": "string", "description": "The transport supported this url. This is an open form string, to be easily extended for many transport protocols. The core ones officially supported are JSONRPC, GRPC and HTTP+JSON." }, "url": { "description": "The url this interface is found at.", "type": "string" } }, "id": "AgentInterface", "type": "object", "description": "Defines additional transport information for the agent." }, "TaskStatus": { "description": "A container for the status of a task", "type": "object", "properties": { "timestamp": { "description": "Timestamp when the status was recorded. Example: \"2023-10-27T10:00:00Z\"", "format": "google-datetime", "type": "string" }, "state": { "enumDescriptions": [ "", "Represents the status that acknowledges a task is created", "Represents the status that a task is actively being processed", "Represents the status a task is finished. This is a terminal state", "Represents the status a task is done but failed. This is a terminal state", "Represents the status a task was cancelled before it finished. This is a terminal state.", "Represents the status that the task requires information to complete. This is an interrupted state.", "Represents the status that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Represents the state that some authentication is needed from the upstream client. Authentication is expected to come out-of-band thus this is not an interrupted or terminal state." ], "type": "string", "enum": [ "TASK_STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", "TASK_STATE_WORKING", "TASK_STATE_COMPLETED", "TASK_STATE_FAILED", "TASK_STATE_CANCELLED", "TASK_STATE_INPUT_REQUIRED", "TASK_STATE_REJECTED", "TASK_STATE_AUTH_REQUIRED" ], "description": "The current state of this task" }, "message": { "$ref": "Message", "description": "A message associated with the status." } }, "id": "TaskStatus" }, "APIKeySecurityScheme": { "properties": { "location": { "description": "Location of the API key, valid values are \"query\", \"header\", or \"cookie\"", "type": "string" }, "name": { "type": "string", "description": "Name of the header, query or cookie parameter to be used." }, "description": { "description": "Description of this security scheme.", "type": "string" } }, "id": "APIKeySecurityScheme", "type": "object" }, "Sku": { "properties": { "serviceProviderName": { "type": "string", "description": "Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform." }, "name": { "description": "The resource name for the SKU. Example: \"services/6F81-5844-456A/skus/D041-B8A1-6E0B\"", "type": "string" }, "skuId": { "type": "string", "description": "The identifier for the SKU. Example: \"D041-B8A1-6E0B\"" }, "geoTaxonomy": { "description": "The geographic taxonomy for this sku.", "$ref": "GeoTaxonomy" }, "serviceRegions": { "type": "array", "items": { "type": "string" }, "description": "List of service regions this SKU is offered at. Example: \"asia-east1\" Service regions can be found at https://cloud.google.com/about/locations/" }, "pricingInfo": { "items": { "$ref": "PricingInfo" }, "description": "A timeline of pricing info for this SKU in chronological order.", "type": "array" }, "category": { "description": "The category hierarchy of this SKU, purely for organizational purpose.", "$ref": "Category" }, "description": { "description": "A human readable description of the SKU, has a maximum length of 256 characters.", "type": "string" } }, "id": "Sku", "type": "object", "description": "Encapsulates a single SKU in Google Cloud" }, "ImplicitOAuthFlow": { "properties": { "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS." }, "scopes": { "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.", "additionalProperties": { "type": "string" }, "type": "object" }, "authorizationUrl": { "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS", "type": "string" } }, "type": "object", "id": "ImplicitOAuthFlow" }, "GeoTaxonomy": { "properties": { "type": { "enumDescriptions": [ "The type is not specified.", "The sku is global in nature, e.g. a license sku. Global skus are available in all regions, and so have an empty region list.", "The sku is available in a specific region, e.g. \"us-west2\".", "The sku is associated with multiple regions, e.g. \"us-west2\" and \"us-east1\"." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "GLOBAL", "REGIONAL", "MULTI_REGIONAL" ], "description": "The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL." }, "regions": { "description": "The list of regions associated with a sku. Empty for Global skus, which are associated with all Google Cloud regions.", "type": "array", "items": { "type": "string" } } }, "type": "object", "description": "Encapsulates the geographic taxonomy data for a sku.", "id": "GeoTaxonomy" }, "PasswordOAuthFlow": { "id": "PasswordOAuthFlow", "properties": { "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS." }, "scopes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty." }, "tokenUrl": { "description": "The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.", "type": "string" } }, "type": "object" }, "BillingAccount": { "type": "object", "properties": { "currencyCode": { "description": "Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as `USD`. Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.", "type": "string" }, "name": { "description": "Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.", "readOnly": true, "type": "string" }, "open": { "readOnly": true, "type": "boolean", "description": "Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it are unable to use paid services." }, "displayName": { "description": "The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console.", "type": "string" }, "masterBillingAccount": { "description": "If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.", "type": "string" }, "parent": { "type": "string", "readOnly": true, "description": "Output only. The billing account's parent resource identifier. Use the `MoveBillingAccount` method to update the account's parent resource if it is a organization. Format: - `organizations/{organization_id}`, for example, `organizations/12345678` - `billingAccounts/{billing_account_id}`, for example, `billingAccounts/012345-567890-ABCDEF`" } }, "id": "BillingAccount", "description": "A billing account in the [Google Cloud Console](https://console.cloud.google.com/). You can assign a billing account to one or more projects." }, "PricingExpression": { "type": "object", "description": "Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` `tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` `[start_usage_amount: 100, unit_price: $5]` The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage.", "properties": { "tieredRates": { "items": { "$ref": "TierRate" }, "type": "array", "description": "The list of tiered rates for this pricing. The total cost is computed by applying each of the tiered rates on usage. This repeated list is sorted by ascending order of start_usage_amount." }, "usageUnitDescription": { "description": "The unit of usage in human readable form. Example: \"gibi byte\".", "type": "string" }, "displayQuantity": { "description": "The recommended quantity of units for displaying pricing info. When displaying pricing info it is recommended to display: (unit_price * display_quantity) per display_quantity usage_unit. This field does not affect the pricing formula and is for display purposes only. Example: If the unit_price is \"0.0001 USD\", the usage_unit is \"GB\" and the display_quantity is \"1000\" then the recommended way of displaying the pricing info is \"0.10 USD per 1000 GB\"", "type": "number", "format": "double" }, "baseUnit": { "description": "The base unit for the SKU which is the unit used in usage exports. Example: \"By\"", "type": "string" }, "baseUnitDescription": { "description": "The base unit in human readable form. Example: \"byte\".", "type": "string" }, "baseUnitConversionFactor": { "type": "number", "format": "double", "description": "Conversion factor for converting from price per usage_unit to price per base_unit, and start_usage_amount to start_usage_amount in base_unit. unit_price / base_unit_conversion_factor = price per base_unit. start_usage_amount * base_unit_conversion_factor = start_usage_amount in base_unit." }, "usageUnit": { "description": "The short hand for unit of usage this pricing is specified in. Example: usage_unit of \"GiBy\" means that usage is specified in \"Gibi Byte\".", "type": "string" } }, "id": "PricingExpression" }, "Part": { "type": "object", "description": "Part represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON).", "properties": { "file": { "$ref": "FilePart" }, "metadata": { "type": "object", "description": "Optional metadata associated with this part.", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "text": { "type": "string" }, "data": { "$ref": "DataPart" } }, "id": "Part" }, "DataPart": { "id": "DataPart", "properties": { "data": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "type": "object", "description": "DataPart represents a structured blob. This is most commonly a JSON payload." }, "TaskStatusUpdateEvent": { "id": "TaskStatusUpdateEvent", "properties": { "metadata": { "description": "Optional metadata to associate with the task update.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "final": { "description": "Whether this is the last status update expected for this task.", "type": "boolean" }, "contextId": { "description": "The id of the context that the task belongs to", "type": "string" }, "taskId": { "description": "The id of the task that is changed", "type": "string" }, "status": { "$ref": "TaskStatus", "description": "The new status of the task." } }, "type": "object", "description": "TaskStatusUpdateEvent is a delta even on a task indicating that a task has changed." }, "ListSkusResponse": { "description": "Response message for `ListSkus`.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListSkus` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve." }, "skus": { "items": { "$ref": "Sku" }, "type": "array", "description": "The list of public SKUs of the given service." } }, "id": "ListSkusResponse" }, "OAuthFlows": { "properties": { "implicit": { "$ref": "ImplicitOAuthFlow" }, "password": { "$ref": "PasswordOAuthFlow" }, "authorizationCode": { "$ref": "AuthorizationCodeOAuthFlow" }, "clientCredentials": { "$ref": "ClientCredentialsOAuthFlow" } }, "id": "OAuthFlows", "type": "object" }, "StringList": { "properties": { "list": { "type": "array", "items": { "type": "string" } } }, "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED", "type": "object", "id": "StringList" }, "CancelTaskRequest": { "type": "object", "id": "CancelTaskRequest", "properties": { "tenant": { "type": "string", "description": "Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release." } } }, "ListBillingAccountsResponse": { "description": "Response message for `ListBillingAccounts`.", "id": "ListBillingAccountsResponse", "properties": { "billingAccounts": { "type": "array", "items": { "$ref": "BillingAccount" }, "description": "A list of billing accounts." }, "nextPageToken": { "type": "string", "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve." } }, "type": "object" }, "MutualTlsSecurityScheme": { "properties": { "description": { "type": "string", "description": "Description of this security scheme." } }, "type": "object", "id": "MutualTlsSecurityScheme" }, "SendMessageConfiguration": { "type": "object", "id": "SendMessageConfiguration", "description": "Configuration of a send message request.", "properties": { "pushNotification": { "$ref": "PushNotificationConfig", "description": "A configuration of a webhook that can be used to receive updates" }, "historyLength": { "description": "The maximum number of messages to include in the history. if 0, the history will be unlimited.", "format": "int32", "type": "integer" }, "acceptedOutputModes": { "type": "array", "items": { "type": "string" }, "description": "The output modes that the agent is expected to respond with." }, "blocking": { "type": "boolean", "description": "If true, the message will be blocking until the task is completed. If false, the message will be non-blocking and the task will be returned immediately. It is the caller's responsibility to check for any task updates." } } }, "Money": { "description": "Represents an amount of money with its currency type.", "id": "Money", "type": "object", "properties": { "units": { "type": "string", "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", "format": "int64" }, "currencyCode": { "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { "type": "integer", "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32" } } }, "TaskPushNotificationConfig": { "type": "object", "id": "TaskPushNotificationConfig", "properties": { "name": { "description": "The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}", "type": "string" }, "pushNotificationConfig": { "description": "The push notification configuration details.", "$ref": "PushNotificationConfig" } } }, "PricingInfo": { "properties": { "aggregationInfo": { "description": "Aggregation Info. This can be left unspecified if the pricing expression doesn't require aggregation.", "$ref": "AggregationInfo" }, "pricingExpression": { "description": "Expresses the pricing formula. See `PricingExpression` for an example.", "$ref": "PricingExpression" }, "effectiveTime": { "type": "string", "format": "google-datetime", "description": "The timestamp from which this pricing was effective within the requested time range. This is guaranteed to be greater than or equal to the start_time field in the request and less than the end_time field in the request. If a time range was not specified in the request this field will be equivalent to a time within the last 12 hours, indicating the latest pricing info." }, "currencyConversionRate": { "format": "double", "description": "Conversion rate used for currency conversion, from USD to the currency specified in the request. This includes any surcharge collected for billing in non USD currency. If a currency is not specified in the request this defaults to 1.0. Example: USD * currency_conversion_rate = JPY", "type": "number" }, "summary": { "description": "An optional human readable summary of the pricing information, has a maximum length of 256 characters.", "type": "string" } }, "id": "PricingInfo", "description": "Represents the pricing information for a SKU at a single point of time.", "type": "object" }, "AgentSkill": { "description": "AgentSkill represents a unit of action/solution that the agent can perform. One can think of this as a type of highly reliable solution that an agent can be tasked to provide. Agents have the autonomy to choose how and when to use specific skills, but clients should have confidence that if the skill is defined that unit of action can be reliably performed.", "id": "AgentSkill", "type": "object", "properties": { "name": { "description": "A human readable name for the skill.", "type": "string" }, "outputModes": { "description": "Possible output modalities produced", "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "type": "string" }, "description": "A set of tags for the skill to enhance categorization/utilization. Example: [\"cooking\", \"customer support\", \"billing\"]", "type": "array" }, "inputModes": { "description": "Possible input modalities supported.", "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "description": "Unique identifier of the skill within this agent." }, "description": { "description": "A human (or llm) readable description of the skill details and behaviors.", "type": "string" }, "examples": { "type": "array", "description": "A set of example queries that this skill is designed to address. These examples should help the caller to understand how to craft requests to the agent to achieve specific goals. Example: [\"I need a recipe for bread\"]", "items": { "type": "string" } }, "security": { "type": "array", "items": { "$ref": "Security" }, "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security schemes necessary for the agent to leverage this skill. As in the overall AgentCard.security, this list represents a logical OR of security requirement objects. Each object is a set of security schemes that must be used together (a logical AND). protolint:enable REPEATED_FIELD_NAMES_PLURALIZED" } } }, "AgentCardSignature": { "type": "object", "id": "AgentCardSignature", "description": "AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).", "properties": { "protected": { "description": "Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object. Required.", "type": "string" }, "header": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "The unprotected JWS header values.", "type": "object" }, "signature": { "description": "Required. The computed signature, base64url-encoded. Required.", "type": "string" } } }, "AgentCard": { "type": "object", "id": "AgentCard", "description": "AgentCard conveys key information: - Overall details (version, name, description, uses) - Skills; a set of actions/solutions the agent can perform - Default modalities/content types supported by the agent. - Authentication requirements Next ID: 19", "properties": { "additionalInterfaces": { "items": { "$ref": "AgentInterface" }, "description": "Announcement of additional supported transports. Client can use any of the supported transports.", "type": "array" }, "iconUrl": { "description": "An optional URL to an icon for the agent.", "type": "string" }, "capabilities": { "$ref": "AgentCapabilities", "description": "A2A Capability set supported by the agent." }, "documentationUrl": { "description": "A url to provide additional documentation about the agent.", "type": "string" }, "signatures": { "type": "array", "description": "JSON Web Signatures computed for this AgentCard.", "items": { "$ref": "AgentCardSignature" } }, "provider": { "$ref": "AgentProvider", "description": "The service provider of the agent." }, "description": { "description": "A description of the agent's domain of action/solution space. Example: \"Agent that helps users with recipes and cooking.\"", "type": "string" }, "version": { "description": "The version of the agent. Example: \"1.0.0\"", "type": "string" }, "preferredTransport": { "description": "The transport of the preferred endpoint. If empty, defaults to JSONRPC.", "type": "string" }, "defaultInputModes": { "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as mime types.", "type": "array", "items": { "type": "string" } }, "protocolVersion": { "type": "string", "description": "The version of the A2A protocol this agent supports." }, "security": { "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for contacting the agent. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, \"callers must either use OAuth OR an API Key AND mTLS.\" Example: security { schemes { key: \"oauth\" value { list: [\"read\"] } } } security { schemes { key: \"api-key\" } schemes { key: \"mtls\" } }", "items": { "$ref": "Security" }, "type": "array" }, "skills": { "description": "Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.", "items": { "$ref": "AgentSkill" }, "type": "array" }, "supportsAuthenticatedExtendedCard": { "description": "Whether the agent supports providing an extended agent card when the user is authenticated, i.e. is the card from .well-known different than the card from GetAgentCard.", "type": "boolean" }, "url": { "description": "A URL to the address the agent is hosted at. This represents the preferred endpoint as declared by the agent.", "type": "string" }, "securitySchemes": { "additionalProperties": { "$ref": "SecurityScheme" }, "description": "The security scheme details used for authenticating with this agent.", "type": "object" }, "name": { "description": "A human readable name for the agent. Example: \"Recipe Agent\"", "type": "string" }, "defaultOutputModes": { "type": "array", "items": { "type": "string" }, "description": "The mime types supported as outputs from this agent." } } }, "AgentProvider": { "id": "AgentProvider", "type": "object", "description": "Represents information about the service provider of an agent.", "properties": { "organization": { "type": "string", "description": "The providers organization name Example: \"Google\"" }, "url": { "description": "The providers reference url Example: \"https://ai.google.dev\"", "type": "string" } } }, "Security": { "properties": { "schemes": { "additionalProperties": { "$ref": "StringList" }, "type": "object" } }, "id": "Security", "type": "object" }, "StreamResponse": { "properties": { "task": { "$ref": "Task" }, "statusUpdate": { "$ref": "TaskStatusUpdateEvent" }, "message": { "$ref": "Message" }, "artifactUpdate": { "$ref": "TaskArtifactUpdateEvent" } }, "id": "StreamResponse", "description": "The stream response for a message. The stream should be one of the following sequences: If the response is a message, the stream should contain one, and only one, message and then close If the response is a task lifecycle, the first response should be a Task object followed by zero or more TaskStatusUpdateEvents and TaskArtifactUpdateEvents. The stream should complete when the Task if in an interrupted or terminal state. A stream that ends before these conditions are met are", "type": "object" }, "Empty": { "type": "object", "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty" }, "Task": { "properties": { "status": { "$ref": "TaskStatus", "description": "The current status of a Task, including state and a message." }, "metadata": { "description": "protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "history": { "description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a task.", "type": "array", "items": { "$ref": "Message" } }, "contextId": { "description": "Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). Created by the A2A server.", "type": "string" }, "artifacts": { "description": "A set of output artifacts for a Task.", "type": "array", "items": { "$ref": "Artifact" } }, "id": { "description": "Unique identifier (e.g. UUID) for the task, generated by the server for a new task.", "type": "string" } }, "description": "Task is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history.", "id": "Task", "type": "object" }, "Category": { "properties": { "resourceFamily": { "description": "The type of product the SKU refers to. Example: \"Compute\", \"Storage\", \"Network\", \"ApplicationServices\" etc.", "type": "string" }, "usageType": { "type": "string", "description": "Represents how the SKU is consumed. Example: \"OnDemand\", \"Preemptible\", \"Commit1Mo\", \"Commit1Yr\" etc." }, "resourceGroup": { "description": "A group classification for related SKUs. Example: \"RAM\", \"GPU\", \"Prediction\", \"Ops\", \"GoogleEgress\" etc.", "type": "string" }, "serviceDisplayName": { "description": "The display name of the service this SKU belongs to.", "type": "string" } }, "description": "Represents the category hierarchy of a SKU.", "id": "Category", "type": "object" } } }