Download discovery documents for APIs
diff --git a/discovery/googleapis/abusiveexperiencereport__v1.json b/discovery/googleapis/abusiveexperiencereport__v1.json index 90a603a..331058e 100644 --- a/discovery/googleapis/abusiveexperiencereport__v1.json +++ b/discovery/googleapis/abusiveexperiencereport__v1.json
@@ -135,7 +135,7 @@ } } }, - "revision": "20201003", + "revision": "20210131", "rootUrl": "https://abusiveexperiencereport.googleapis.com/", "schemas": { "SiteSummaryResponse": {
diff --git a/discovery/googleapis/acceleratedmobilepageurl__v1.json b/discovery/googleapis/acceleratedmobilepageurl__v1.json index 58fb840..046ce7d 100644 --- a/discovery/googleapis/acceleratedmobilepageurl__v1.json +++ b/discovery/googleapis/acceleratedmobilepageurl__v1.json
@@ -113,7 +113,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": {
diff --git a/discovery/googleapis/accessapproval__v1.json b/discovery/googleapis/accessapproval__v1.json index 7fe4ff3..9d039eb 100644 --- a/discovery/googleapis/accessapproval__v1.json +++ b/discovery/googleapis/accessapproval__v1.json
@@ -277,7 +277,7 @@ ], "parameters": { "filter": { - "description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only dismissed (including expired) requests. * HISTORY: Active and dismissed (including expired) requests.", + "description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that . are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.", "location": "query", "type": "string" }, @@ -486,7 +486,7 @@ ], "parameters": { "filter": { - "description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only dismissed (including expired) requests. * HISTORY: Active and dismissed (including expired) requests.", + "description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that . are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.", "location": "query", "type": "string" }, @@ -695,7 +695,7 @@ ], "parameters": { "filter": { - "description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only dismissed (including expired) requests. * HISTORY: Active and dismissed (including expired) requests.", + "description": "A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that . are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.", "location": "query", "type": "string" }, @@ -731,7 +731,7 @@ } } }, - "revision": "20200930", + "revision": "20210119", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalSettings": { @@ -912,7 +912,7 @@ "id": "EnrolledService", "properties": { "cloudProduct": { - "description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * BigQuery * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Dataflow * Cloud Identity and Access Management * Cloud Pub/Sub * Cloud Storage * Persistent Disk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * cloudkms.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * iam.googleapis.com * pubsub.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all', 'ga-only', or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'GA', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. 'ga-only'/'GA' will only enroll the resource in products supported at 'GA' level. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services", + "description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * App Engine * BigQuery * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Dataflow * Cloud Identity and Access Management * Cloud Pub/Sub * Cloud Storage * Persistent Disk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * appengine.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * cloudkms.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * iam.googleapis.com * pubsub.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services", "type": "string" }, "enrollmentLevel": {
diff --git a/discovery/googleapis/accesscontextmanager__v1.json b/discovery/googleapis/accesscontextmanager__v1.json index b79f739..3ab034e 100644 --- a/discovery/googleapis/accesscontextmanager__v1.json +++ b/discovery/googleapis/accesscontextmanager__v1.json
@@ -914,7 +914,7 @@ } } }, - "revision": "20200927", + "revision": "20210131", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessLevel": { @@ -967,6 +967,24 @@ }, "type": "object" }, + "ApiOperation": { + "description": "Identification for an API Operation.", + "id": "ApiOperation", + "properties": { + "methodSelectors": { + "description": "API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`.", + "items": { + "$ref": "MethodSelector" + }, + "type": "array" + }, + "serviceName": { + "description": "The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services.", + "type": "string" + } + }, + "type": "object" + }, "BasicLevel": { "description": "`BasicLevel` is an `AccessLevel` using a set of recommended features.", "id": "BasicLevel", @@ -1142,6 +1160,72 @@ }, "type": "object" }, + "EgressFrom": { + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "id": "EgressFrom", + "properties": { + "identities": { + "description": "A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "identityType": { + "description": "Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.", + "enum": [ + "IDENTITY_TYPE_UNSPECIFIED", + "ANY_IDENTITY", + "ANY_USER_ACCOUNT", + "ANY_SERVICE_ACCOUNT" + ], + "enumDescriptions": [ + "No blanket identity group specified.", + "Authorize access from all identities outside the perimeter.", + "Authorize access from all human users outside the perimeter.", + "Authorize access from all service accounts outside the perimeter." + ], + "type": "string" + } + }, + "type": "object" + }, + "EgressPolicy": { + "description": "Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo.", + "id": "EgressPolicy", + "properties": { + "egressFrom": { + "$ref": "EgressFrom", + "description": "Defines conditions on the source of a request causing this EgressPolicy to apply." + }, + "egressTo": { + "$ref": "EgressTo", + "description": "Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply." + } + }, + "type": "object" + }, + "EgressTo": { + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "id": "EgressTo", + "properties": { + "operations": { + "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "items": { + "$ref": "ApiOperation" + }, + "type": "array" + }, + "resources": { + "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Empty": { "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); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", @@ -1193,6 +1277,94 @@ }, "type": "object" }, + "IngressFrom": { + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "id": "IngressFrom", + "properties": { + "identities": { + "description": "A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "identityType": { + "description": "Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.", + "enum": [ + "IDENTITY_TYPE_UNSPECIFIED", + "ANY_IDENTITY", + "ANY_USER_ACCOUNT", + "ANY_SERVICE_ACCOUNT" + ], + "enumDescriptions": [ + "No blanket identity group specified.", + "Authorize access from all identities outside the perimeter.", + "Authorize access from all human users outside the perimeter.", + "Authorize access from all service accounts outside the perimeter." + ], + "type": "string" + }, + "sources": { + "description": "Sources that this IngressPolicy authorizes access from.", + "items": { + "$ref": "IngressSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "IngressPolicy": { + "description": "Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field.", + "id": "IngressPolicy", + "properties": { + "ingressFrom": { + "$ref": "IngressFrom", + "description": "Defines the conditions on the source of a request causing this IngressPolicy to apply." + }, + "ingressTo": { + "$ref": "IngressTo", + "description": "Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply." + } + }, + "type": "object" + }, + "IngressSource": { + "description": "The source that IngressPolicy authorizes access from.", + "id": "IngressSource", + "properties": { + "accessLevel": { + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "type": "string" + }, + "resource": { + "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", + "type": "string" + } + }, + "type": "object" + }, + "IngressTo": { + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "id": "IngressTo", + "properties": { + "operations": { + "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "$ref": "ApiOperation" + }, + "type": "array" + }, + "resources": { + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListAccessLevelsResponse": { "description": "A response to `ListAccessLevelsRequest`.", "id": "ListAccessLevelsResponse", @@ -1283,6 +1455,21 @@ }, "type": "object" }, + "MethodSelector": { + "description": "An allowed method or permission of a service specified in ApiOperation.", + "id": "MethodSelector", + "properties": { + "method": { + "description": "Value for `method` should be a valid method name for the corresponding `service_name` in ApiOperation. If `*` used as value for `method`, then ALL methods and permissions are allowed.", + "type": "string" + }, + "permission": { + "description": "Value for `permission` should be a valid Cloud IAM permission for the corresponding `service_name` in ApiOperation.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -1473,6 +1660,20 @@ }, "type": "array" }, + "egressPolicies": { + "description": "List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge.", + "items": { + "$ref": "EgressPolicy" + }, + "type": "array" + }, + "ingressPolicies": { + "description": "List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge.", + "items": { + "$ref": "IngressPolicy" + }, + "type": "array" + }, "resources": { "description": "A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}`", "items": {
diff --git a/discovery/googleapis/adexchangebuyer__v1.3.json b/discovery/googleapis/adexchangebuyer__v1.3.json index 9f4a825..e0247be 100644 --- a/discovery/googleapis/adexchangebuyer__v1.3.json +++ b/discovery/googleapis/adexchangebuyer__v1.3.json
@@ -15,7 +15,7 @@ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest", - "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/uHYNxktxMST_hZbGLNGIPNJJQl0\"", + "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/ggFxKzOl0d-LemCq9f3CWy5sUP4\"", "icons": { "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" @@ -699,7 +699,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": {
diff --git a/discovery/googleapis/adexchangebuyer__v1.4.json b/discovery/googleapis/adexchangebuyer__v1.4.json index 36aaf1b..12a7660 100644 --- a/discovery/googleapis/adexchangebuyer__v1.4.json +++ b/discovery/googleapis/adexchangebuyer__v1.4.json
@@ -15,7 +15,7 @@ "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest", - "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/h6Apc3nEjQ5fAGNkbBTsXR02ZtA\"", + "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/LK2RMkpEujF1vjmYNPt9OvCz9fw\"", "icons": { "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" @@ -1255,7 +1255,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://www.googleapis.com/", "schemas": { "Account": {
diff --git a/discovery/googleapis/adexperiencereport__v1.json b/discovery/googleapis/adexperiencereport__v1.json index cd64f42..38b6deb 100644 --- a/discovery/googleapis/adexperiencereport__v1.json +++ b/discovery/googleapis/adexperiencereport__v1.json
@@ -135,7 +135,7 @@ } } }, - "revision": "20201003", + "revision": "20210131", "rootUrl": "https://adexperiencereport.googleapis.com/", "schemas": { "PlatformSummary": {
diff --git a/discovery/googleapis/admin__datatransfer_v1.json b/discovery/googleapis/admin__datatransfer_v1.json index 4bff8ad..76fb149 100644 --- a/discovery/googleapis/admin__datatransfer_v1.json +++ b/discovery/googleapis/admin__datatransfer_v1.json
@@ -12,8 +12,8 @@ } }, "basePath": "", - "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch/admin/datatransfer_v1", + "baseUrl": "https://admin.googleapis.com/", + "batchPath": "batch", "canonicalName": "DataTransfer", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryVersion": "v1", @@ -141,7 +141,7 @@ "parameterOrder": [], "parameters": { "customerId": { - "description": "Immutable ID of the Google Apps account.", + "description": "Immutable ID of the Google Workspace account.", "location": "query", "type": "string" }, @@ -220,7 +220,7 @@ "parameterOrder": [], "parameters": { "customerId": { - "description": "Immutable ID of the Google Apps account.", + "description": "Immutable ID of the Google Workspace account.", "location": "query", "type": "string" }, @@ -265,11 +265,11 @@ } } }, - "revision": "20201006", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210202", + "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { - "description": "The JSON template for an Application resource. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "Applications resources represent applications installed on the domain that support transferring ownership of user data.", "id": "Application", "properties": { "etag": { @@ -342,7 +342,7 @@ "type": "object" }, "ApplicationsListResponse": { - "description": "Template for a collection of Applications. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "Template for a collection of Applications.", "id": "ApplicationsListResponse", "properties": { "applications": { @@ -369,7 +369,7 @@ "type": "object" }, "DataTransfer": { - "description": "The JSON template for a DataTransfer resource. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "A Transfer resource represents the transfer of the ownership of user data between users.", "id": "DataTransfer", "properties": { "applicationDataTransfers": { @@ -413,7 +413,7 @@ "type": "object" }, "DataTransfersListResponse": { - "description": "Template for a collection of DataTransfer resources. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "Template for a collection of DataTransfer resources.", "id": "DataTransfersListResponse", "properties": { "dataTransfers": { @@ -441,6 +441,6 @@ } }, "servicePath": "", - "title": "Admin SDK", + "title": "Admin SDK API", "version": "datatransfer_v1" } \ No newline at end of file
diff --git a/discovery/googleapis/admin__directory_v1.json b/discovery/googleapis/admin__directory_v1.json index 15a9357..8204872 100644 --- a/discovery/googleapis/admin__directory_v1.json +++ b/discovery/googleapis/admin__directory_v1.json
@@ -87,8 +87,8 @@ } }, "basePath": "", - "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch/admin/directory_v1", + "baseUrl": "https://admin.googleapis.com/", + "batchPath": "batch", "canonicalName": "directory", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryVersion": "v1", @@ -293,7 +293,7 @@ "chromeosdevices": { "methods": { "action": { - "description": "Take action on Chrome OS Device", + "description": "Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).", "httpMethod": "POST", "id": "directory.chromeosdevices.action", "parameterOrder": [ @@ -302,13 +302,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "resourceId": { - "description": "Immutable ID of Chrome OS Device", + "description": "The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method.", "location": "path", "required": true, "type": "string" @@ -323,7 +323,7 @@ ] }, "get": { - "description": "Retrieve Chrome OS Device", + "description": "Retrieves a Chrome OS device's properties.", "httpMethod": "GET", "id": "directory.chromeosdevices.get", "parameterOrder": [ @@ -332,19 +332,19 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "deviceId": { - "description": "Immutable ID of Chrome OS Device", + "description": "The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method.", "location": "path", "required": true, "type": "string" }, "projection": { - "description": "Restrict information returned to a set of selected fields.", + "description": "Determines whether the response contains the full list of properties or only a subset.", "enum": [ "PROJECTION_UNDEFINED", "BASIC", @@ -369,7 +369,7 @@ ] }, "list": { - "description": "Retrieve all Chrome OS Devices of a customer (paginated)", + "description": "Retrieves a paginated list of Chrome OS devices within an account.", "httpMethod": "GET", "id": "directory.chromeosdevices.list", "parameterOrder": [ @@ -377,7 +377,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" @@ -391,7 +391,7 @@ "type": "integer" }, "orderBy": { - "description": "Column to use for sorting results", + "description": "Device property to use for sorting results.", "enum": [ "orderByUndefined", "annotatedLocation", @@ -404,24 +404,24 @@ ], "enumDescriptions": [ "", - "Chromebook location as annotated by the administrator.", + "Chrome device location as annotated by the administrator.", "Chromebook user as annotated by administrator.", - "Chromebook last sync.", - "Chromebook notes as annotated by the administrator.", - "Chromebook Serial Number.", - "Chromebook status.", - "Chromebook support end date." + "The date and time the Chrome device was last synchronized with the policy settings in the Admin console.", + "Chrome device notes as annotated by the administrator.", + "The Chrome device serial number entered when the device was enabled.", + "Chrome device status. For more information, see the <a [chromeosdevices](/admin-sdk/directory/v1/reference/chromeosdevices.html).", + "Chrome device support end date. This is applicable only for devices purchased directly from Google." ], "location": "query", "type": "string" }, "orgUnitPath": { - "description": "Full path of the organizational unit or its ID", + "description": "The full path of the organizational unit or its unique ID.", "location": "query", "type": "string" }, "pageToken": { - "description": "Token to specify next page in the list", + "description": "The `pageToken` query parameter is used to request the next page of query results. The follow-on request's `pageToken` query parameter is the `nextPageToken` from your previous response.", "location": "query", "type": "string" }, @@ -446,7 +446,7 @@ "type": "string" }, "sortOrder": { - "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used", + "description": "Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.", "enum": [ "SORT_ORDER_UNDEFINED", "ASCENDING", @@ -471,7 +471,7 @@ ] }, "moveDevicesToOu": { - "description": "Move or insert multiple Chrome OS Devices to organizational unit", + "description": "Move or insert multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.", "httpMethod": "POST", "id": "directory.chromeosdevices.moveDevicesToOu", "parameterOrder": [ @@ -480,7 +480,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "Immutable ID of the Google Workspace account", "location": "path", "required": true, "type": "string" @@ -501,7 +501,7 @@ ] }, "patch": { - "description": "Patch Chrome OS Device", + "description": "Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).", "httpMethod": "PATCH", "id": "directory.chromeosdevices.patch", "parameterOrder": [ @@ -510,13 +510,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "deviceId": { - "description": "Immutable ID of Chrome OS Device", + "description": "The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method.", "location": "path", "required": true, "type": "string" @@ -549,7 +549,7 @@ ] }, "update": { - "description": "Update Chrome OS Device", + "description": "Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.", "httpMethod": "PUT", "id": "directory.chromeosdevices.update", "parameterOrder": [ @@ -558,13 +558,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "deviceId": { - "description": "Immutable ID of Chrome OS Device", + "description": "The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list) method.", "location": "path", "required": true, "type": "string" @@ -598,6 +598,96 @@ } } }, + "customer": { + "resources": { + "devices": { + "resources": { + "chromeos": { + "methods": { + "issueCommand": { + "description": "Issues a command for the device to execute.", + "httpMethod": "POST", + "id": "admin.customer.devices.chromeos.issueCommand", + "parameterOrder": [ + "customerId", + "deviceId" + ], + "parameters": { + "customerId": { + "description": "Immutable. Immutable ID of the Google Workspace account.", + "location": "path", + "required": true, + "type": "string" + }, + "deviceId": { + "description": "Immutable. Immutable ID of Chrome OS Device.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand", + "request": { + "$ref": "DirectoryChromeosdevicesIssueCommandRequest" + }, + "response": { + "$ref": "DirectoryChromeosdevicesIssueCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/admin.directory.device.chromeos" + ] + } + }, + "resources": { + "commands": { + "methods": { + "get": { + "description": "Gets command data a specific command issued to the device.", + "httpMethod": "GET", + "id": "admin.customer.devices.chromeos.commands.get", + "parameterOrder": [ + "customerId", + "deviceId", + "commandId" + ], + "parameters": { + "commandId": { + "description": "Immutable. Immutable ID of Chrome OS Device Command.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "customerId": { + "description": "Immutable. Immutable ID of the Google Workspace account.", + "location": "path", + "required": true, + "type": "string" + }, + "deviceId": { + "description": "Immutable. Immutable ID of Chrome OS Device.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}", + "response": { + "$ref": "DirectoryChromeosdevicesCommand" + }, + "scopes": [ + "https://www.googleapis.com/auth/admin.directory.device.chromeos", + "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly" + ] + } + } + } + } + } + } + } + } + }, "customers": { "methods": { "get": { @@ -690,7 +780,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -717,7 +807,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -747,7 +837,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -773,7 +863,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -807,7 +897,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -834,7 +924,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -864,7 +954,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -890,7 +980,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -910,7 +1000,7 @@ "groups": { "methods": { "delete": { - "description": "Delete Group", + "description": "Deletes a group.", "httpMethod": "DELETE", "id": "directory.groups.delete", "parameterOrder": [ @@ -918,7 +1008,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -930,7 +1020,7 @@ ] }, "get": { - "description": "Retrieve Group", + "description": "Retrieves a group's properties.", "httpMethod": "GET", "id": "directory.groups.get", "parameterOrder": [ @@ -938,7 +1028,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -954,7 +1044,7 @@ ] }, "insert": { - "description": "Create Group", + "description": "Creates a group.", "httpMethod": "POST", "id": "directory.groups.insert", "parameterOrder": [], @@ -977,12 +1067,12 @@ "parameterOrder": [], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.", + "description": "The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users)", "location": "query", "type": "string" }, "domain": { - "description": "Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.", + "description": "The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.", "location": "query", "type": "string" }, @@ -1048,7 +1138,7 @@ ] }, "patch": { - "description": "Patch Groups via Apiary Patch Orchestration", + "description": "Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).", "httpMethod": "PATCH", "id": "directory.groups.patch", "parameterOrder": [ @@ -1056,7 +1146,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group. If ID, it should match with id of group object", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -1074,7 +1164,7 @@ ] }, "update": { - "description": "Update Group", + "description": "Updates a group's properties.", "httpMethod": "PUT", "id": "directory.groups.update", "parameterOrder": [ @@ -1082,7 +1172,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group. If ID, it should match with id of group object", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -1104,7 +1194,7 @@ "aliases": { "methods": { "delete": { - "description": "Remove a alias for the group", + "description": "Removes an alias.", "httpMethod": "DELETE", "id": "directory.groups.aliases.delete", "parameterOrder": [ @@ -1119,7 +1209,7 @@ "type": "string" }, "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -1131,7 +1221,7 @@ ] }, "insert": { - "description": "Add a alias for the group", + "description": "Adds an alias for the group.", "httpMethod": "POST", "id": "directory.groups.aliases.insert", "parameterOrder": [ @@ -1139,7 +1229,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -1157,7 +1247,7 @@ ] }, "list": { - "description": "List all aliases for a group", + "description": "Lists all aliases for a group.", "httpMethod": "GET", "id": "directory.groups.aliases.list", "parameterOrder": [ @@ -1165,7 +1255,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -1187,7 +1277,7 @@ "members": { "methods": { "delete": { - "description": "Remove membership.", + "description": "Removes a member from a group.", "httpMethod": "DELETE", "id": "directory.members.delete", "parameterOrder": [ @@ -1196,13 +1286,13 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" }, "memberKey": { - "description": "Email or immutable ID of the member", + "description": "Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.", "location": "path", "required": true, "type": "string" @@ -1215,7 +1305,7 @@ ] }, "get": { - "description": "Retrieve Group Member", + "description": "Retrieves a group member's properties.", "httpMethod": "GET", "id": "directory.members.get", "parameterOrder": [ @@ -1224,13 +1314,13 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" }, "memberKey": { - "description": "Email or immutable ID of the member", + "description": "Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.", "location": "path", "required": true, "type": "string" @@ -1281,7 +1371,7 @@ ] }, "insert": { - "description": "Add user to the specified group.", + "description": "Adds a user to the specified group.", "httpMethod": "POST", "id": "directory.members.insert", "parameterOrder": [ @@ -1289,7 +1379,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -1308,7 +1398,7 @@ ] }, "list": { - "description": "Retrieve all members in a group (paginated)", + "description": "Retrieves a paginated list of all members in a group.", "httpMethod": "GET", "id": "directory.members.list", "parameterOrder": [ @@ -1316,7 +1406,7 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" @@ -1335,12 +1425,12 @@ "type": "integer" }, "pageToken": { - "description": "Token to specify next page in the list", + "description": "Token to specify next page in the list.", "location": "query", "type": "string" }, "roles": { - "description": "Comma separated role values to filter list results on.", + "description": "The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.", "location": "query", "type": "string" } @@ -1357,7 +1447,7 @@ ] }, "patch": { - "description": "Patch Member via Apiary Patch Orchestration", + "description": "Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).", "httpMethod": "PATCH", "id": "directory.members.patch", "parameterOrder": [ @@ -1366,13 +1456,13 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group. If ID, it should match with id of group object", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" }, "memberKey": { - "description": "Email or immutable ID of the user. If ID, it should match with id of member object", + "description": "Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.", "location": "path", "required": true, "type": "string" @@ -1391,7 +1481,7 @@ ] }, "update": { - "description": "Update membership of a user in the specified group.", + "description": "Updates the membership of a user in the specified group.", "httpMethod": "PUT", "id": "directory.members.update", "parameterOrder": [ @@ -1400,13 +1490,13 @@ ], "parameters": { "groupKey": { - "description": "Email or immutable ID of the group. If ID, it should match with id of group object", + "description": "Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.", "location": "path", "required": true, "type": "string" }, "memberKey": { - "description": "Email or immutable ID of the user. If ID, it should match with id of member object", + "description": "Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.", "location": "path", "required": true, "type": "string" @@ -1429,7 +1519,7 @@ "mobiledevices": { "methods": { "action": { - "description": "Take action on Mobile Device", + "description": "Takes an action that affects a mobile device. For example, remotely wiping a device.", "httpMethod": "POST", "id": "directory.mobiledevices.action", "parameterOrder": [ @@ -1438,13 +1528,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "resourceId": { - "description": "Immutable ID of Mobile Device", + "description": "The unique ID the API service uses to identify the mobile device.", "location": "path", "required": true, "type": "string" @@ -1460,7 +1550,7 @@ ] }, "delete": { - "description": "Delete Mobile Device", + "description": "Removes a mobile device.", "httpMethod": "DELETE", "id": "directory.mobiledevices.delete", "parameterOrder": [ @@ -1469,13 +1559,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "resourceId": { - "description": "Immutable ID of Mobile Device", + "description": "The unique ID the API service uses to identify the mobile device.", "location": "path", "required": true, "type": "string" @@ -1487,7 +1577,7 @@ ] }, "get": { - "description": "Retrieve Mobile Device", + "description": "Retrieves a mobile device's properties.", "httpMethod": "GET", "id": "directory.mobiledevices.get", "parameterOrder": [ @@ -1496,7 +1586,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" @@ -1517,7 +1607,7 @@ "type": "string" }, "resourceId": { - "description": "Immutable ID of Mobile Device", + "description": "The unique ID the API service uses to identify the mobile device.", "location": "path", "required": true, "type": "string" @@ -1534,7 +1624,7 @@ ] }, "list": { - "description": "Retrieve all Mobile Devices of a customer (paginated)", + "description": "Retrieves a paginated list of all mobile devices for an account.", "httpMethod": "GET", "id": "directory.mobiledevices.list", "parameterOrder": [ @@ -1542,7 +1632,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" @@ -1557,7 +1647,7 @@ "type": "integer" }, "orderBy": { - "description": "Column to use for sorting results", + "description": "Device property to use for sorting results.", "enum": [ "orderByUndefined", "deviceId", @@ -1571,13 +1661,13 @@ ], "enumDescriptions": [ "", - "Mobile Device serial number.", - "Owner user email.", + "The serial number for a Google Sync mobile device. For Android devices, this is a software generated unique identifier.", + "The device owner's email address.", "Last policy settings sync date time of the device.", - "Mobile Device model.", - "Owner user name.", - "Mobile operating system.", - "Status of the device.", + "The mobile device's model.", + "The device owner's user name.", + "The device's operating system.", + "The device status.", "Type of the device." ], "location": "query", @@ -1604,12 +1694,12 @@ "type": "string" }, "query": { - "description": "Search string in the format given at http://support.google.com/a/bin/answer.py?answer=1408863#search", + "description": "Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/search-operators", "location": "query", "type": "string" }, "sortOrder": { - "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used", + "description": "Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.", "enum": [ "SORT_ORDER_UNDEFINED", "ASCENDING", @@ -1639,7 +1729,7 @@ "orgunits": { "methods": { "delete": { - "description": "Remove organizational unit", + "description": "Removes an organizational unit.", "httpMethod": "DELETE", "id": "directory.orgunits.delete", "parameterOrder": [ @@ -1648,13 +1738,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "orgUnitPath": { - "description": "Full path of the organizational unit or its ID", + "description": "The full path of the organizational unit or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -1667,7 +1757,7 @@ ] }, "get": { - "description": "Retrieve organizational unit", + "description": "Retrieves an organizational unit.", "httpMethod": "GET", "id": "directory.orgunits.get", "parameterOrder": [ @@ -1676,13 +1766,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "orgUnitPath": { - "description": "Full path of the organizational unit or its ID", + "description": "The full path of the organizational unit or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -1699,7 +1789,7 @@ ] }, "insert": { - "description": "Add organizational unit", + "description": "Adds an organizational unit.", "httpMethod": "POST", "id": "directory.orgunits.insert", "parameterOrder": [ @@ -1707,7 +1797,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" @@ -1725,7 +1815,7 @@ ] }, "list": { - "description": "Retrieve all organizational units", + "description": "Retrieves a list of all organizational units for an account.", "httpMethod": "GET", "id": "directory.orgunits.list", "parameterOrder": [ @@ -1733,19 +1823,19 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "orgUnitPath": { "default": "", - "description": "the URL-encoded organizational unit's path or its ID", + "description": "The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.", "location": "query", "type": "string" }, "type": { - "description": "Whether to return all sub-organizations or just immediate children", + "description": "Whether to return all sub-organizations or just immediate children.", "enum": [ "typeUndefined", "all", @@ -1770,7 +1860,7 @@ ] }, "patch": { - "description": "Patch organization unit via Apiary Patch Orchestration", + "description": "Updates an organizational unit. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch)", "httpMethod": "PATCH", "id": "directory.orgunits.patch", "parameterOrder": [ @@ -1779,13 +1869,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "orgUnitPath": { - "description": "Full path of the organizational unit or its ID", + "description": "The full path of the organizational unit or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -1804,7 +1894,7 @@ ] }, "update": { - "description": "Update organizational unit", + "description": "Updates an organizational unit.", "httpMethod": "PUT", "id": "directory.orgunits.update", "parameterOrder": [ @@ -1813,13 +1903,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users).", "location": "path", "required": true, "type": "string" }, "orgUnitPath": { - "description": "Full path of the organizational unit or its ID", + "description": "The full path of the organizational unit or its unique ID.", "location": "path", "pattern": "^.*$", "required": true, @@ -1850,7 +1940,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -1887,7 +1977,7 @@ "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -1914,7 +2004,7 @@ "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -1950,13 +2040,13 @@ "", "Building.coordinates are set to the coordinates included in the request.", "Building.coordinates are automatically populated based on the postal address.", - "Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided." + "Defaults to `RESOLVED_FROM_ADDRESS` if postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` if coordinates are provided." ], "location": "query", "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -1982,7 +2072,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2038,13 +2128,13 @@ "", "Building.coordinates are set to the coordinates included in the request.", "Building.coordinates are automatically populated based on the postal address.", - "Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided." + "Defaults to `RESOLVED_FROM_ADDRESS` if postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` if coordinates are provided." ], "location": "query", "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2089,13 +2179,13 @@ "", "Building.coordinates are set to the coordinates included in the request.", "Building.coordinates are automatically populated based on the postal address.", - "Defaults to RESOLVED_FROM_ADDRESS if postal address is provided. Otherwise, defaults to CLIENT_SPECIFIED if coordinates are provided." + "Defaults to `RESOLVED_FROM_ADDRESS` if postal address is provided. Otherwise, defaults to `CLIENT_SPECIFIED` if coordinates are provided." ], "location": "query", "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2132,7 +2222,7 @@ "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2159,7 +2249,7 @@ "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2183,7 +2273,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2209,7 +2299,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2223,7 +2313,7 @@ "type": "integer" }, "orderBy": { - "description": "Field(s) to sort results by in either ascending or descending order. Supported fields include resourceId, resourceName, capacity, buildingId, and floorName. If no order is specified, defaults to ascending. Should be of the form \"field [asc|desc], field [asc|desc], ...\". For example buildingId, capacity desc would return results sorted first by buildingId in ascending order then by capacity in descending order.", + "description": "Field(s) to sort results by in either ascending or descending order. Supported fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `floorName`. If no order is specified, defaults to ascending. Should be of the form \"field [asc|desc], field [asc|desc], ...\". For example `buildingId, capacity desc` would return results sorted first by `buildingId` in ascending order then by `capacity` in descending order.", "location": "query", "type": "string" }, @@ -2233,7 +2323,7 @@ "type": "string" }, "query": { - "description": "String query used to filter results. Should be of the form \"field operator value\" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include generatedResourceName, name, buildingId, floor_name, capacity, featureInstances.feature.name. For example buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone.", + "description": "String query used to filter results. Should be of the form \"field operator value\" where field can be any of supported fields and operators can be any of supported operations. Operators include '=' for exact match, '!=' for mismatch and ':' for prefix match or HAS match where applicable. For prefix match, the value should always be followed by a *. Logical operators NOT and AND are supported (in this order of precedence). Supported fields include `generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.", "location": "query", "type": "string" } @@ -2263,7 +2353,7 @@ "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2296,7 +2386,7 @@ "type": "string" }, "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2327,7 +2417,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2354,7 +2444,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2384,7 +2474,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2410,7 +2500,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2448,7 +2538,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2481,7 +2571,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2511,7 +2601,7 @@ ], "parameters": { "customer": { - "description": "The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID.", + "description": "The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's customer ID.", "location": "path", "required": true, "type": "string" @@ -2550,7 +2640,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2577,7 +2667,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2607,7 +2697,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2633,7 +2723,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2685,7 +2775,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2712,7 +2802,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2742,7 +2832,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2768,7 +2858,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2806,7 +2896,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2839,7 +2929,7 @@ ], "parameters": { "customer": { - "description": "Immutable ID of the G Suite account.", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2876,13 +2966,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" }, "schemaKey": { - "description": "Name or immutable ID of the schema", + "description": "Name or immutable ID of the schema.", "location": "path", "required": true, "type": "string" @@ -2903,13 +2993,13 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" }, "schemaKey": { - "description": "Name or immutable ID of the schema", + "description": "Name or immutable ID of the schema.", "location": "path", "required": true, "type": "string" @@ -2933,7 +3023,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2959,7 +3049,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -2984,7 +3074,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -3017,7 +3107,7 @@ ], "parameters": { "customerId": { - "description": "Immutable ID of the G Suite account", + "description": "Immutable ID of the Google Workspace account.", "location": "path", "required": true, "type": "string" @@ -3153,7 +3243,7 @@ "users": { "methods": { "delete": { - "description": "Delete user", + "description": "Deletes a user.", "httpMethod": "DELETE", "id": "directory.users.delete", "parameterOrder": [ @@ -3161,7 +3251,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3173,7 +3263,7 @@ ] }, "get": { - "description": "retrieve user", + "description": "Retrieves a user.", "httpMethod": "GET", "id": "directory.users.get", "parameterOrder": [ @@ -3181,7 +3271,7 @@ ], "parameters": { "customFieldMask": { - "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.", + "description": "A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.", "location": "query", "type": "string" }, @@ -3197,21 +3287,21 @@ "enumDescriptions": [ "", "Do not include any custom fields for the user.", - "Include custom fields from schemas mentioned in customFieldMask.", + "Include custom fields from schemas requested in `customFieldMask`.", "Include all fields associated with this user." ], "location": "query", "type": "string" }, "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" }, "viewType": { "default": "admin_view", - "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.", + "description": "Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin).", "enum": [ "view_type_undefined", "admin_view", @@ -3219,8 +3309,8 @@ ], "enumDescriptions": [ "", - "Fetches the ADMIN_VIEW of the user.", - "Fetches the DOMAIN_PUBLIC view of the user." + "Results include both administrator-only and domain-public fields for the user.", + "Results only include fields for the user that are publicly visible to other users in the domain." ], "location": "query", "type": "string" @@ -3236,7 +3326,7 @@ ] }, "insert": { - "description": "create user.", + "description": "Creates a user.", "httpMethod": "POST", "id": "directory.users.insert", "parameterOrder": [], @@ -3253,23 +3343,23 @@ ] }, "list": { - "description": "Retrieve either deleted users or all users in a domain (paginated)", + "description": "Retrieves a paginated list of either deleted users or all users in a domain.", "httpMethod": "GET", "id": "directory.users.list", "parameterOrder": [], "parameters": { "customFieldMask": { - "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.", + "description": "A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`.", "location": "query", "type": "string" }, "customer": { - "description": "Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.", + "description": "The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain` parameter must be provided.", "location": "query", "type": "string" }, "domain": { - "description": "Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.", + "description": "The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. Either the `customer` or the `domain` parameter must be provided.", "location": "query", "type": "string" }, @@ -3283,7 +3373,7 @@ "type": "integer" }, "orderBy": { - "description": "Column to use for sorting results", + "description": "Property to use for sorting results.", "enum": [ "orderByUndefined", "email", @@ -3316,19 +3406,19 @@ "enumDescriptions": [ "", "Do not include any custom fields for the user.", - "Include custom fields from schemas mentioned in customFieldMask.", + "Include custom fields from schemas requested in `customFieldMask`.", "Include all fields associated with this user." ], "location": "query", "type": "string" }, "query": { - "description": "Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users", + "description": "Query string for searching user fields. For more information on constructing user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search-users).", "location": "query", "type": "string" }, "showDeleted": { - "description": "If set to true, retrieves the list of deleted users. (Default: false)", + "description": "If set to `true`, retrieves the list of deleted users. (Default: `false`)", "location": "query", "type": "string" }, @@ -3349,7 +3439,7 @@ }, "viewType": { "default": "admin_view", - "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.", + "description": "Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin).", "enum": [ "view_type_undefined", "admin_view", @@ -3357,8 +3447,8 @@ ], "enumDescriptions": [ "", - "Fetches the ADMIN_VIEW of the user.", - "Fetches the DOMAIN_PUBLIC view of the user." + "Results include both administrator-only and domain-public fields for the user.", + "Results only include fields for the user that are publicly visible to other users in the domain." ], "location": "query", "type": "string" @@ -3375,7 +3465,7 @@ ] }, "makeAdmin": { - "description": "change admin status of a user", + "description": "Makes a user a super administrator.", "httpMethod": "POST", "id": "directory.users.makeAdmin", "parameterOrder": [ @@ -3383,7 +3473,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user as admin", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3398,7 +3488,7 @@ ] }, "patch": { - "description": "Patch Users via Apiary Patch Orchestration", + "description": "Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.", "httpMethod": "PATCH", "id": "directory.users.patch", "parameterOrder": [ @@ -3406,7 +3496,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user. If ID, it should match with id of user object", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3444,7 +3534,7 @@ ] }, "undelete": { - "description": "Undelete a deleted user", + "description": "Undeletes a deleted user.", "httpMethod": "POST", "id": "directory.users.undelete", "parameterOrder": [ @@ -3467,7 +3557,7 @@ ] }, "update": { - "description": "update user", + "description": "Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared.", "httpMethod": "PUT", "id": "directory.users.update", "parameterOrder": [ @@ -3475,7 +3565,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user. If ID, it should match with id of user object", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3504,7 +3594,7 @@ "type": "string" }, "customer": { - "description": "Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.", + "description": "Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.", "location": "query", "type": "string" }, @@ -3514,7 +3604,7 @@ "type": "string" }, "event": { - "description": "Event on which subscription is intended", + "description": "Events to watch for.", "enum": [ "eventTypeUnspecified", "add", @@ -3610,14 +3700,14 @@ }, "viewType": { "default": "admin_view", - "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.", + "description": "Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin).", "enum": [ "admin_view", "domain_public" ], "enumDescriptions": [ - "Fetches the ADMIN_VIEW of the user.", - "Fetches the DOMAIN_PUBLIC view of the user." + "Results include both administrator-only and domain-public fields.", + "Results only include fields for the user that are publicly visible to other users in the domain." ], "location": "query", "type": "string" @@ -3641,7 +3731,7 @@ "aliases": { "methods": { "delete": { - "description": "Remove a alias for the user", + "description": "Removes an alias.", "httpMethod": "DELETE", "id": "directory.users.aliases.delete", "parameterOrder": [ @@ -3650,13 +3740,13 @@ ], "parameters": { "alias": { - "description": "The alias to be removed", + "description": "The alias to be removed.", "location": "path", "required": true, "type": "string" }, "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3669,7 +3759,7 @@ ] }, "insert": { - "description": "Add a alias for the user", + "description": "Adds an alias.", "httpMethod": "POST", "id": "directory.users.aliases.insert", "parameterOrder": [ @@ -3677,7 +3767,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3696,7 +3786,7 @@ ] }, "list": { - "description": "List all aliases for a user", + "description": "Lists all aliases for a user.", "httpMethod": "GET", "id": "directory.users.aliases.list", "parameterOrder": [ @@ -3704,7 +3794,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3722,7 +3812,7 @@ ] }, "watch": { - "description": "Watch for changes in users list", + "description": "Watch for changes in users list.", "httpMethod": "POST", "id": "directory.users.aliases.watch", "parameterOrder": [ @@ -3730,7 +3820,7 @@ ], "parameters": { "event": { - "description": "Event on which subscription is intended (if subscribing)", + "description": "Events to watch for.", "enum": [ "eventUndefined", "add", @@ -3770,7 +3860,7 @@ "photos": { "methods": { "delete": { - "description": "Remove photos for the user", + "description": "Removes the user's photo.", "httpMethod": "DELETE", "id": "directory.users.photos.delete", "parameterOrder": [ @@ -3778,7 +3868,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3790,7 +3880,7 @@ ] }, "get": { - "description": "Retrieve photo of a user", + "description": "Retrieves the user's photo.", "httpMethod": "GET", "id": "directory.users.photos.get", "parameterOrder": [ @@ -3798,7 +3888,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3814,7 +3904,7 @@ ] }, "patch": { - "description": "Patch Photo via Apiary Patch Orchestration", + "description": "Adds a photo for the user. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).", "httpMethod": "PATCH", "id": "directory.users.photos.patch", "parameterOrder": [ @@ -3822,7 +3912,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3840,7 +3930,7 @@ ] }, "update": { - "description": "Add a photo for the user", + "description": "Adds a photo for the user.", "httpMethod": "PUT", "id": "directory.users.photos.update", "parameterOrder": [ @@ -3848,7 +3938,7 @@ ], "parameters": { "userKey": { - "description": "Email or immutable ID of the user", + "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.", "location": "path", "required": true, "type": "string" @@ -3937,8 +4027,8 @@ } } }, - "revision": "20201006", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210202", + "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { "description": "JSON template for Alias object in Directory API.", @@ -3984,7 +4074,7 @@ "type": "object" }, "Asp": { - "description": "The template that returns individual ASP (Access Code) data. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "An application-specific password (ASP) is used with applications that do not accept a verification code when logging into the application on certain devices. The ASP access code is used instead of the login and password you commonly use when accessing an application through a browser. For more information about ASPs and how to create one, see the [help center](//http://support.google.com/a/bin/answer.py?amp;answer=1032419).", "id": "Asp", "properties": { "codeId": { @@ -3993,7 +4083,7 @@ "type": "integer" }, "creationTime": { - "description": "The time when the ASP was created. Expressed in Unix time format.", + "description": "The time when the ASP was created. Expressed in [Unix time](http://en.wikipedia.org/wiki/Epoch_time) format.", "format": "int64", "type": "string" }, @@ -4003,16 +4093,16 @@ }, "kind": { "default": "admin#directory#asp", - "description": "The type of the API resource. This is always admin#directory#asp.", + "description": "The type of the API resource. This is always `admin#directory#asp`.", "type": "string" }, "lastTimeUsed": { - "description": "The time when the ASP was last used. Expressed in Unix time format.", + "description": "The time when the ASP was last used. Expressed in [Unix time](http://en.wikipedia.org/wiki/Epoch_time) format.", "format": "int64", "type": "string" }, "name": { - "description": "The name of the application that the user, represented by their userId, entered when the ASP was created.", + "description": "The name of the application that the user, represented by their `userId`, entered when the ASP was created.", "type": "string" }, "userKey": { @@ -4023,7 +4113,6 @@ "type": "object" }, "Asps": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", "id": "Asps", "properties": { "etag": { @@ -4039,7 +4128,7 @@ }, "kind": { "default": "admin#directory#aspList", - "description": "The type of the API resource. This is always admin#directory#aspList.", + "description": "The type of the API resource. This is always `admin#directory#aspList`.", "type": "string" } }, @@ -4051,7 +4140,7 @@ "properties": { "address": { "$ref": "BuildingAddress", - "description": "The postal address of the building. See PostalAddress for details. Note that only a single address line and region code are required." + "description": "The postal address of the building. See [`PostalAddress`](/my-business/reference/rest/v4/PostalAddress) for details. Note that only a single address line and region code are required." }, "buildingId": { "description": "Unique identifier for the building. The maximum length is 100 characters.", @@ -4205,7 +4294,7 @@ }, "kind": { "default": "admin#directory#resources#calendars#CalendarResource", - "description": "The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.", + "description": "The type of the resource. For calendar resources, the value is `admin#directory#resources#calendars#CalendarResource`.", "type": "string" }, "resourceCategory": { @@ -4266,7 +4355,7 @@ }, "kind": { "default": "admin#directory#resources#calendars#calendarResourcesList", - "description": "Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.", + "description": "Identifies this as a collection of CalendarResources. This is always `admin#directory#resources#calendars#calendarResourcesList`.", "type": "string" }, "nextPageToken": { @@ -4295,7 +4384,7 @@ }, "kind": { "default": "api#channel", - "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", + "description": "Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.", "type": "string" }, "params": { @@ -4329,15 +4418,15 @@ "type": "object" }, "ChromeOsDevice": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "Google Chrome devices run on the [Chrome OS](http://support.google.com/chromeos). For more information about common API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices).", "id": "ChromeOsDevice", "properties": { "activeTimeRanges": { - "description": "List of active time ranges (Read-only)", + "description": "List of active time ranges (Read-only).", "items": { "properties": { "activeTime": { - "description": "Duration in milliseconds", + "description": "Duration of usage in milliseconds.", "format": "int32", "type": "integer" }, @@ -4352,15 +4441,15 @@ "type": "array" }, "annotatedAssetId": { - "description": "AssetId specified during enrollment or through later annotation", + "description": "The asset identifier as noted by an administrator or specified during enrollment.", "type": "string" }, "annotatedLocation": { - "description": "Address or location of the device as noted by the administrator", + "description": "The address or location of the device as noted by the administrator. Maximum length is `200` characters. Empty values are allowed.", "type": "string" }, "annotatedUser": { - "description": "User of the device", + "description": "The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.", "type": "string" }, "autoUpdateExpiration": { @@ -4369,7 +4458,7 @@ "type": "string" }, "bootMode": { - "description": "Chromebook boot mode (Read-only)", + "description": "The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](http://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).", "type": "string" }, "cpuStatusReports": { @@ -4438,7 +4527,7 @@ "type": "array" }, "deviceId": { - "description": "Unique identifier of Chrome OS Device (Read-only)", + "description": "The unique ID of the Chrome device.", "type": "string" }, "diskVolumeReports": { @@ -4482,7 +4571,7 @@ "type": "string" }, "ethernetMacAddress": { - "description": "Chromebook Mac Address on ethernet network interface (Read-only)", + "description": "The device's MAC address on the ethernet network interface.", "type": "string" }, "ethernetMacAddress0": { @@ -4490,12 +4579,12 @@ "type": "string" }, "firmwareVersion": { - "description": "Chromebook firmware version (Read-only)", + "description": "The Chrome device's firmware version.", "type": "string" }, "kind": { "default": "admin#directory#chromeosdevice", - "description": "Kind of resource this is.", + "description": "The type of resource. For the Chromeosdevices resource, the value is `admin#directory#chromeosdevice`.", "type": "string" }, "lastEnrollmentTime": { @@ -4527,7 +4616,7 @@ "type": "string" }, "macAddress": { - "description": "Chromebook Mac Address on wifi network interface (Read-only)", + "description": "The device's wireless MAC address. If the device does not have this information, it is not included in the response.", "type": "string" }, "manufactureDate": { @@ -4535,56 +4624,46 @@ "type": "string" }, "meid": { - "description": "Contains either the Mobile Equipment identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in the Chromebook (Read-only)", + "description": "The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-chrome-devices.html#export_meid).", "type": "string" }, "model": { - "description": "Chromebook Model (Read-only)", + "description": "The device's model information. If the device does not have this information, this property is not included in the response.", "type": "string" }, "notes": { - "description": "Notes added by the administrator", + "description": "Notes about this device added by the administrator. This property can be [searched](http://support.google.com/chromeos/a/bin/answer.py?answer=1698333) with the [list](/admin-sdk/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed.", "type": "string" }, "orderNumber": { - "description": "Chromebook order number (Read-only)", + "description": "The device's order number. Only devices directly purchased from Google have an order number.", "type": "string" }, "orgUnitPath": { - "description": "OrgUnit of the device", + "description": "The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin-sdk/directory/v1/guides/manage-chrome-devices#update_chrome_device) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=182433).", "type": "string" }, "osVersion": { - "description": "Chromebook Os Version (Read-only)", + "description": "The Chrome device's operating system version.", "type": "string" }, "platformVersion": { - "description": "Chromebook platform version (Read-only)", + "description": "The Chrome device's platform version.", "type": "string" }, "recentUsers": { - "description": "List of recent device users, in descending order by last login time (Read-only)", + "description": "List of recent device users, in descending order, by last login time.", "items": { - "properties": { - "email": { - "description": "Email address of the user. Present only if the user type is managed", - "type": "string" - }, - "type": { - "description": "The type of the user", - "type": "string" - } - }, - "type": "object" + "$ref": "RecentUsers" }, "type": "array" }, "serialNumber": { - "description": "Chromebook serial number (Read-only)", + "description": "The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's *Serial Number* in the *Chrome OS Devices* tab.", "type": "string" }, "status": { - "description": "status of the device (Read-only)", + "description": "The status of the device.", "type": "string" }, "supportEndDate": { @@ -4622,7 +4701,7 @@ "description": "Trusted Platform Module (TPM) (Read-only)", "properties": { "family": { - "description": "TPM family.", + "description": "TPM family. We use the TPM 2.0 style encoding, e.g.: TPM 1.2: \"1.2\" -> 312e3200 TPM 2.0: \"2.0\" -> 322e3000", "type": "string" }, "firmwareVersion": { @@ -4634,7 +4713,7 @@ "type": "string" }, "specLevel": { - "description": "TPM specification level.", + "description": "TPM specification level. See Library Specification for TPM 2.0 and Main Specification for TPM 1.2.", "type": "string" }, "tpmModel": { @@ -4649,7 +4728,7 @@ "type": "object" }, "willAutoRenew": { - "description": "Will Chromebook auto renew after support end date (Read-only)", + "description": "Determines if the device will auto renew its support after the support end date. This is a read-only property.", "type": "boolean" } }, @@ -4664,17 +4743,17 @@ "directory.chromeosdevices.action" ] }, - "description": "Action to be taken on the ChromeOs Device", + "description": "Action to be taken on the Chrome OS device.", "type": "string" }, "deprovisionReason": { + "description": "Only used when the action is `deprovision`. With the `deprovision` action, this field is required. *Note*: The deprovision reason is audited because it might have implications on licenses for perpetual subscription customers.", "type": "string" } }, "type": "object" }, "ChromeOsDevices": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", "id": "ChromeOsDevices", "properties": { "chromeosdevices": { @@ -4694,7 +4773,7 @@ "type": "string" }, "nextPageToken": { - "description": "Token used to access next page of this result.", + "description": "Token used to access the next page of this result. To access the next page, use this token's value in the `pageToken` query string of this request.", "type": "string" } }, @@ -4709,7 +4788,7 @@ "directory.chromeosdevices.moveDevicesToOu" ] }, - "description": "ChromeOs Devices to be moved to OU", + "description": "Chrome OS devices to be moved to OU", "items": { "type": "string" }, @@ -4719,11 +4798,10 @@ "type": "object" }, "Customer": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", "id": "Customer", "properties": { "alternateEmail": { - "description": "The customer's secondary contact email address. This email address cannot be on the same domain as the customerDomain", + "description": "The customer's secondary contact email address. This email address cannot be on the same domain as the `customerDomain`", "type": "string" }, "customerCreationTime": { @@ -4732,7 +4810,7 @@ "type": "string" }, "customerDomain": { - "description": "The customer's primary domain name string. Do not include the www prefix when creating a new customer.", + "description": "The customer's primary domain name string. Do not include the `www` prefix when creating a new customer.", "type": "string" }, "etag": { @@ -4740,20 +4818,20 @@ "type": "string" }, "id": { - "description": "The unique ID for the customer's G Suite account. (Readonly)", + "description": "The unique ID for the customer's Google Workspace account. (Readonly)", "type": "string" }, "kind": { "default": "admin#directory#customer", - "description": "Identifies the resource as a customer. Value: admin#directory#customer", + "description": "Identifies the resource as a customer. Value: `admin#directory#customer`", "type": "string" }, "language": { - "description": "The customer's ISO 639-2 language code. The default value is en-US", + "description": "The customer's ISO 639-2 language code. See the [Language Codes](/admin-sdk/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`.", "type": "string" }, "phoneNumber": { - "description": "The customer's contact phone number in E.164 format.", + "description": "The customer's contact phone number in [E.164](http://en.wikipedia.org/wiki/E.164) format.", "type": "string" }, "postalAddress": { @@ -4764,7 +4842,6 @@ "type": "object" }, "CustomerPostalAddress": { - "description": "STEPLADDER: Generated unstable field number for field 'address_line2' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'address_line3' to avoid collision. (See http://go/stepladder-help#fieldNumber)", "id": "CustomerPostalAddress", "properties": { "addressLine1": { @@ -4784,11 +4861,11 @@ "type": "string" }, "countryCode": { - "description": "This is a required property. For countryCode information see the ISO 3166 country code elements.", + "description": "This is a required property. For `countryCode` information see the [ISO 3166 country code elements](http://www.iso.org/iso/country_codes.htm).", "type": "string" }, "locality": { - "description": "Name of the locality. An example of a locality value is the city of San Francisco.", + "description": "Name of the locality. An example of a locality value is the city of `San Francisco`.", "type": "string" }, "organizationName": { @@ -4796,11 +4873,158 @@ "type": "string" }, "postalCode": { - "description": "The postal code. A postalCode example is a postal zip code such as 10009. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.", + "description": "The postal code. A postalCode example is a postal zip code such as `10009`. This is in accordance with - http: //portablecontacts.net/draft-spec.html#address_element.", "type": "string" }, "region": { - "description": "Name of the region. An example of a region value is NY for the state of New York.", + "description": "Name of the region. An example of a region value is `NY` for the state of New York.", + "type": "string" + } + }, + "type": "object" + }, + "DirectoryChromeosdevicesCommand": { + "description": "Information regarding a command that was issued to a device.", + "id": "DirectoryChromeosdevicesCommand", + "properties": { + "commandExpireTime": { + "description": "The time at which the command will expire. If the device doesn't execute the command within this time the command will become expired.", + "format": "google-datetime", + "type": "string" + }, + "commandId": { + "description": "Unique ID of a device command.", + "format": "int64", + "type": "string" + }, + "commandResult": { + "$ref": "DirectoryChromeosdevicesCommandResult", + "description": "The result of the command execution." + }, + "issueTime": { + "description": "The timestamp when the command was issued by the admin.", + "format": "google-datetime", + "type": "string" + }, + "payload": { + "description": "The payload that the command specified, if any.", + "type": "string" + }, + "state": { + "description": "Indicates the command state.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "EXPIRED", + "CANCELLED", + "SENT_TO_CLIENT", + "ACKED_BY_CLIENT", + "EXECUTED_BY_CLIENT" + ], + "enumDescriptions": [ + "The command status was unspecified.", + "An unexpired command not yet sent to the client.", + "The command didn't get executed by the client within the expected time.", + "The command is cancelled by admin while in PENDING.", + "The command has been sent to the client.", + "The client has responded that it received the command.", + "The client has (un)successfully executed the command." + ], + "type": "string" + }, + "type": { + "description": "The type of the command.", + "enum": [ + "COMMAND_TYPE_UNSPECIFIED", + "REBOOT", + "TAKE_A_SCREENSHOT", + "SET_VOLUME", + "WIPE_USERS", + "REMOTE_POWERWASH" + ], + "enumDescriptions": [ + "The command type was unspecified.", + "Reboot the device. Can only be issued to Kiosk and managed guest session devices.", + "Take a screenshot of the device. Only available if the device is in Kiosk Mode.", + "Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.", + "Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.", + "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!" + ], + "type": "string" + } + }, + "type": "object" + }, + "DirectoryChromeosdevicesCommandResult": { + "description": "The result of executing a command.", + "id": "DirectoryChromeosdevicesCommandResult", + "properties": { + "errorMessage": { + "description": "The error message with a short explanation as to why the command failed. Only present if the command failed.", + "type": "string" + }, + "executeTime": { + "description": "The time at which the command was executed or failed to execute.", + "format": "google-datetime", + "type": "string" + }, + "result": { + "description": "The result of the command.", + "enum": [ + "COMMAND_RESULT_TYPE_UNSPECIFIED", + "IGNORED", + "FAILURE", + "SUCCESS" + ], + "enumDescriptions": [ + "The command result was unspecified.", + "The command was ignored as obsolete.", + "The command could not be executed successfully.", + "The command was successfully executed." + ], + "type": "string" + } + }, + "type": "object" + }, + "DirectoryChromeosdevicesIssueCommandRequest": { + "description": "A request for issuing a command.", + "id": "DirectoryChromeosdevicesIssueCommandRequest", + "properties": { + "commandType": { + "description": "The type of command.", + "enum": [ + "COMMAND_TYPE_UNSPECIFIED", + "REBOOT", + "TAKE_A_SCREENSHOT", + "SET_VOLUME", + "WIPE_USERS", + "REMOTE_POWERWASH" + ], + "enumDescriptions": [ + "The command type was unspecified.", + "Reboot the device. Can only be issued to Kiosk and managed guest session devices.", + "Take a screenshot of the device. Only available if the device is in Kiosk Mode.", + "Set the volume of the device. Can only be issued to Kiosk and managed guest session devices.", + "Wipe all the users off of the device. Executing this command in the device will remove all user profile data, but it will keep device policy and enrollment.", + "Wipes the device by performing a power wash. Executing this command in the device will remove all data including user policies, device policies and enrollment policies. Warning: This will revert the device back to a factory state with no enrollment unless the device is subject to forced or auto enrollment. Use with caution, as this is an irreversible action!" + ], + "type": "string" + }, + "payload": { + "description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: - SET_VOLUME: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100].", + "type": "string" + } + }, + "type": "object" + }, + "DirectoryChromeosdevicesIssueCommandResponse": { + "description": "A response for issuing a command.", + "id": "DirectoryChromeosdevicesIssueCommandResponse", + "properties": { + "commandId": { + "description": "The unique ID of the issued command, used to retrieve the command status.", + "format": "int64", "type": "string" } }, @@ -4869,7 +5093,7 @@ "id": "Domains", "properties": { "creationTime": { - "description": "Creation time of the domain. (Read-only).", + "description": "Creation time of the domain. Expressed in [Unix time](http://en.wikipedia.org/wiki/Epoch_time) format. (Read-only).", "format": "int64", "type": "string" }, @@ -5010,26 +5234,26 @@ "type": "object" }, "Group": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).", "id": "Group", "properties": { "adminCreated": { - "description": "Is the group created by admin (Read-only) *", + "description": "Value is `true` if this group was created by an administrator rather than a user.", "type": "boolean" }, "aliases": { - "description": "List of aliases (Read-only)", + "description": "List of a group's alias email addresses.", "items": { "type": "string" }, "type": "array" }, "description": { - "description": "Description of the group", + "description": "An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.", "type": "string" }, "directMembersCount": { - "description": "Group direct members count", + "description": "The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.", "format": "int64", "type": "string" }, @@ -5039,7 +5263,7 @@ "directory.groups.insert" ] }, - "description": "Email of Group", + "description": "The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=33386) for the details.", "type": "string" }, "etag": { @@ -5047,20 +5271,20 @@ "type": "string" }, "id": { - "description": "Unique identifier of Group (Read-only)", + "description": "The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.", "type": "string" }, "kind": { "default": "admin#directory#group", - "description": "Kind of resource this is.", + "description": "The type of the API resource. For Groups resources, the value is `admin#directory#group`.", "type": "string" }, "name": { - "description": "Group name", + "description": "The group's display name.", "type": "string" }, "nonEditableAliases": { - "description": "List of non editable aliases (Read-only)", + "description": "List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.", "items": { "type": "string" }, @@ -5070,7 +5294,6 @@ "type": "object" }, "Groups": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", "id": "Groups", "properties": { "etag": { @@ -5097,14 +5320,15 @@ "type": "object" }, "Member": { + "description": "A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).", "id": "Member", "properties": { "delivery_settings": { - "description": "Delivery settings of member", + "description": "Defines mail delivery preferences of member. This is only supported by create/update/get.", "type": "string" }, "email": { - "description": "Email of member (Read-only)", + "description": "The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.", "type": "string" }, "etag": { @@ -5112,16 +5336,16 @@ "type": "string" }, "id": { - "description": "Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.", + "description": "The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.", "type": "string" }, "kind": { "default": "admin#directory#member", - "description": "Kind of resource this is.", + "description": "The type of the API resource. For Members resources, the value is `admin#directory#member`.", "type": "string" }, "role": { - "description": "Role of member", + "description": "The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).", "type": "string" }, "status": { @@ -5129,7 +5353,7 @@ "type": "string" }, "type": { - "description": "Type of member (Immutable)", + "description": "The type of group member.", "type": "string" } }, @@ -5174,6 +5398,7 @@ "type": "object" }, "MobileDevice": { + "description": "Google Workspace Mobile Management includes Android, [Google Sync](http://support.google.com/a/bin/answer.py?answer=135937), and iOS devices. For more information about common group mobile device API tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices.html).", "id": "MobileDevice", "properties": { "adbStatus": { @@ -5181,31 +5406,31 @@ "type": "boolean" }, "applications": { - "description": "List of applications installed on Mobile Device", + "description": "The list of applications installed on an Android mobile device. It is not applicable to Google Sync and iOS devices. The list includes any Android applications that access Google Workspace data. When updating an applications list, it is important to note that updates replace the existing list. If the Android device has two existing applications and the API updates the list with five applications, the is now the updated list of five applications.", "items": { "properties": { "displayName": { - "description": "Display name of application", + "description": "The application's display name. An example is `Browser`.", "type": "string" }, "packageName": { - "description": "Package name of application", + "description": "The application's package name. An example is `com.android.browser`.", "type": "string" }, "permission": { - "description": "List of Permissions for application", + "description": "The list of permissions of this application. These can be either a standard Android permission or one defined by the application, and are found in an application's [Android manifest](http://developer.android.com/guide/topics/manifest/uses-permission-element.html). Examples of a Calendar application's permissions are `READ_CALENDAR`, or `MANAGE_ACCOUNTS`.", "items": { "type": "string" }, "type": "array" }, "versionCode": { - "description": "Version code of application", + "description": "The application's version code. An example is `13`.", "format": "int32", "type": "integer" }, "versionName": { - "description": "Version name of application", + "description": "The application's version name. An example is `3.2-140714`.", "type": "string" } }, @@ -5214,7 +5439,7 @@ "type": "array" }, "basebandVersion": { - "description": "Mobile Device Baseband version (Read-only)", + "description": "The device's baseband version.", "type": "string" }, "bootloaderVersion": { @@ -5226,11 +5451,11 @@ "type": "string" }, "buildNumber": { - "description": "Mobile Device Build number (Read-only)", + "description": "The device's operating system build number.", "type": "string" }, "defaultLanguage": { - "description": "The default locale used on the Mobile Device (Read-only)", + "description": "The default locale used on the device.", "type": "string" }, "developerOptionsStatus": { @@ -5238,11 +5463,11 @@ "type": "boolean" }, "deviceCompromisedStatus": { - "description": "Mobile Device compromised status (Read-only)", + "description": "The compromised device status.", "type": "string" }, "deviceId": { - "description": "Mobile Device serial number (Read-only)", + "description": "The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.", "type": "string" }, "devicePasswordStatus": { @@ -5250,7 +5475,7 @@ "type": "string" }, "email": { - "description": "List of owner user's email addresses (Read-only)", + "description": "List of owner's email addresses. If your application needs the current list of user emails, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](/admin-sdk/directory/v1/guides/manage-users#get_user) method.", "items": { "type": "string" }, @@ -5274,20 +5499,20 @@ "type": "string" }, "hardwareId": { - "description": "Mobile Device Hardware Id (Read-only)", + "description": "The IMEI/MEID unique identifier for Android hardware. It is not applicable to Google Sync devices. When adding an Android mobile device, this is an optional property. When updating one of these devices, this is a read-only property.", "type": "string" }, "imei": { - "description": "Mobile Device IMEI number (Read-only)", + "description": "The device's IMEI number.", "type": "string" }, "kernelVersion": { - "description": "Mobile Device Kernel version (Read-only)", + "description": "The device's kernel version.", "type": "string" }, "kind": { "default": "admin#directory#mobiledevice", - "description": "Kind of resource this is.", + "description": "The type of the API resource. For Mobiledevices resources, the value is `admin#directory#mobiledevice`.", "type": "string" }, "lastSync": { @@ -5296,7 +5521,7 @@ "type": "string" }, "managedAccountIsOnOwnerProfile": { - "description": "Boolean indicating if this account is on owner/primary profile or not (Read-only)", + "description": "Boolean indicating if this account is on owner/primary profile or not.", "type": "boolean" }, "manufacturer": { @@ -5304,15 +5529,15 @@ "type": "string" }, "meid": { - "description": "Mobile Device MEID number (Read-only)", + "description": "The device's MEID number.", "type": "string" }, "model": { - "description": "Name of the model of the device", + "description": "The mobile device's model name, for example Nexus S. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile=devices#update_mobile_device).", "type": "string" }, "name": { - "description": "List of owner user's names (Read-only)", + "description": "List of the owner's user names. If your application needs the current list of device owner names, use the [get](/admin-sdk/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-users#get_user).", "items": { "type": "string" }, @@ -5323,7 +5548,7 @@ "type": "string" }, "os": { - "description": "Name of the mobile operating system", + "description": "The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).", "type": "string" }, "otherAccountsInfo": { @@ -5342,7 +5567,7 @@ "type": "string" }, "resourceId": { - "description": "Unique identifier of Mobile Device (Read-only)", + "description": "The unique ID the API service uses to identify the mobile device.", "type": "string" }, "securityPatchLevel": { @@ -5351,11 +5576,11 @@ "type": "string" }, "serialNumber": { - "description": "Mobile Device SSN or Serial Number (Read-only)", + "description": "The device's serial number.", "type": "string" }, "status": { - "description": "Status of the device (Read-only)", + "description": "The device's status.", "type": "string" }, "supportsWorkProfile": { @@ -5363,7 +5588,7 @@ "type": "boolean" }, "type": { - "description": "The type of device (Read-only)", + "description": "The type of mobile device.", "type": "string" }, "unknownSourcesStatus": { @@ -5371,11 +5596,11 @@ "type": "boolean" }, "userAgent": { - "description": "Mobile Device user agent", + "description": "Gives information about the device such as `os` version. This property can be [updated](/admin-sdk/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-mobile-devices#update_mobile_device).", "type": "string" }, "wifiMacAddress": { - "description": "Mobile Device WiFi MAC address (Read-only)", + "description": "The device's MAC address on Wi-Fi networks.", "type": "string" } }, @@ -5390,7 +5615,7 @@ "directory.mobiledevices.action" ] }, - "description": "Action to be taken on the Mobile Device", + "description": "The action to be performed on the device.", "type": "string" } }, @@ -5423,15 +5648,15 @@ "type": "object" }, "OrgUnit": { - "description": "JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).", "id": "OrgUnit", "properties": { "blockInheritance": { - "description": "Should block inheritance", + "description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=182442&topic=1227584&ctx=topic).", "type": "boolean" }, "description": { - "description": "Description of OrgUnit", + "description": "Description of the organizational unit.", "type": "string" }, "etag": { @@ -5440,7 +5665,7 @@ }, "kind": { "default": "admin#directory#orgUnit", - "description": "Kind of resource this is.", + "description": "The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.", "type": "string" }, "name": { @@ -5449,30 +5674,29 @@ "directory.orgunits.insert" ] }, - "description": "Name of OrgUnit", + "description": "The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.", "type": "string" }, "orgUnitId": { - "description": "Id of OrgUnit", + "description": "The unique ID of the organizational unit.", "type": "string" }, "orgUnitPath": { - "description": "Path of OrgUnit", + "description": "The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=182433&topic=1227584&ctx=topic). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).", "type": "string" }, "parentOrgUnitId": { - "description": "Id of parent OrgUnit", + "description": "The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.", "type": "string" }, "parentOrgUnitPath": { - "description": "Path of parent OrgUnit", + "description": "The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.", "type": "string" } }, "type": "object" }, "OrgUnits": { - "description": "JSON response template for List Organization Units operation in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", "id": "OrgUnits", "properties": { "etag": { @@ -5481,11 +5705,11 @@ }, "kind": { "default": "admin#directory#orgUnits", - "description": "Kind of resource this is.", + "description": "The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.", "type": "string" }, "organizationUnits": { - "description": "List of user objects.", + "description": "List of organizational unit objects.", "items": { "$ref": "OrgUnit" }, @@ -5514,7 +5738,7 @@ }, "kind": { "default": "admin#directory#privilege", - "description": "The type of the API resource. This is always admin#directory#privilege.", + "description": "The type of the API resource. This is always `admin#directory#privilege`.", "type": "string" }, "privilegeName": { @@ -5522,7 +5746,7 @@ "type": "string" }, "serviceId": { - "description": "The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().", + "description": "The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).", "type": "string" }, "serviceName": { @@ -5548,7 +5772,22 @@ }, "kind": { "default": "admin#directory#privileges", - "description": "The type of the API resource. This is always admin#directory#privileges.", + "description": "The type of the API resource. This is always `admin#directory#privileges`.", + "type": "string" + } + }, + "type": "object" + }, + "RecentUsers": { + "description": "List of recent device users, in descending order, by last login time.", + "id": "RecentUsers", + "properties": { + "email": { + "description": "The user's email address. This is only present if the user type is `USER_TYPE_MANAGED`.", + "type": "string" + }, + "type": { + "description": "The type of the user.", "type": "string" } }, @@ -5562,16 +5801,16 @@ "type": "string" }, "isSuperAdminRole": { - "description": "Returns true if the role is a super admin role.", + "description": "Returns `true` if the role is a super admin role.", "type": "boolean" }, "isSystemRole": { - "description": "Returns true if this is a pre-defined system role.", + "description": "Returns `true` if this is a pre-defined system role.", "type": "boolean" }, "kind": { "default": "admin#directory#role", - "description": "The type of the API resource. This is always admin#directory#role.", + "description": "The type of the API resource. This is always `admin#directory#role`.", "type": "string" }, "roleDescription": { @@ -5606,7 +5845,7 @@ "type": "string" }, "serviceId": { - "description": "The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().", + "description": "The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list).", "type": "string" } }, @@ -5630,7 +5869,7 @@ }, "kind": { "default": "admin#directory#roleAssignment", - "description": "The type of the API resource. This is always admin#directory#roleAssignment.", + "description": "The type of the API resource. This is always `admin#directory#roleAssignment`.", "type": "string" }, "orgUnitId": { @@ -5648,7 +5887,7 @@ "type": "string" }, "scopeType": { - "description": "The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT ", + "description": "The scope in which this role is assigned.", "type": "string" } }, @@ -5670,7 +5909,7 @@ }, "kind": { "default": "admin#directory#roleAssignments", - "description": "The type of the API resource. This is always admin#directory#roleAssignments .", + "description": "The type of the API resource. This is always `admin#directory#roleAssignments`.", "type": "string" }, "nextPageToken": { @@ -5695,7 +5934,7 @@ }, "kind": { "default": "admin#directory#roles", - "description": "The type of the API resource. This is always admin#directory#roles.", + "description": "The type of the API resource. This is always `admin#directory#roles`.", "type": "string" }, "nextPageToken": { @@ -5705,7 +5944,7 @@ "type": "object" }, "Schema": { - "description": "JSON template for Schema resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "The type of API resource. For Schema resources, this is always `admin#directory#schema`.", "id": "Schema", "properties": { "displayName": { @@ -5718,7 +5957,7 @@ "type": "string" }, "etag": { - "description": "ETag of the resource.", + "description": "The ETag of the resource.", "type": "string" }, "fields": { @@ -5728,7 +5967,7 @@ "directory.schemas.update" ] }, - "description": "Fields of Schema", + "description": "A list of fields in the schema.", "items": { "$ref": "SchemaFieldSpec" }, @@ -5740,7 +5979,7 @@ "type": "string" }, "schemaId": { - "description": "Unique identifier of Schema (Read-only)", + "description": "The unique identifier of the schema (Read-only)", "type": "string" }, "schemaName": { @@ -5749,14 +5988,14 @@ "directory.schemas.insert" ] }, - "description": "Schema name", + "description": "The schema's name.", "type": "string" } }, "type": "object" }, "SchemaFieldSpec": { - "description": "JSON template for FieldSpec resource for Schemas in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see [Custom User Fields](/admin-sdk/directory/v1/guides/manage-schemas).", "id": "SchemaFieldSpec", "properties": { "displayName": { @@ -5770,11 +6009,11 @@ "type": "string" }, "etag": { - "description": "ETag of the resource.", + "description": "The ETag of the field.", "type": "string" }, "fieldId": { - "description": "Unique identifier of Field (Read-only)", + "description": "The unique identifier of the field (Read-only)", "type": "string" }, "fieldName": { @@ -5784,7 +6023,7 @@ "directory.schemas.update" ] }, - "description": "Name of the field.", + "description": "The name of the field.", "type": "string" }, "fieldType": { @@ -5794,25 +6033,25 @@ "directory.schemas.update" ] }, - "description": "Type of the field.", + "description": "The type of the field.", "type": "string" }, "indexed": { "default": "true", - "description": "Boolean specifying whether the field is indexed or not.", + "description": "Boolean specifying whether the field is indexed or not. Default: `true`.", "type": "boolean" }, "kind": { "default": "admin#directory#schema#fieldspec", - "description": "Kind of resource this is.", + "description": "The kind of resource this is. For schema fields this is always `admin#directory#schema#fieldspec`.", "type": "string" }, "multiValued": { - "description": "Boolean specifying whether this is a multi-valued field or not.", + "description": "A boolean specifying whether this is a multi-valued field or not. Default: `false`.", "type": "boolean" }, "numericIndexingSpec": { - "description": "Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.", + "description": "Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the `numericIndexingSpec` allows range queries to be supported.", "properties": { "maxValue": { "description": "Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.", @@ -5829,14 +6068,14 @@ }, "readAccessType": { "default": "ALL_DOMAIN_USERS", - "description": "Read ACLs on the field specifying who can view values of this field. Valid values are \"ALL_DOMAIN_USERS\" and \"ADMINS_AND_SELF\".", + "description": "Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin-sdk/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected.", "type": "string" } }, "type": "object" }, "Schemas": { - "description": "JSON response template for List Schema operation in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "JSON response template for List Schema operation in Directory API.", "id": "Schemas", "properties": { "etag": { @@ -5859,11 +6098,11 @@ "type": "object" }, "Token": { - "description": "JSON template for token resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "JSON template for token resource in Directory API.", "id": "Token", "properties": { "anonymous": { - "description": "Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.", + "description": "Whether the application is registered with Google. The value is `true` if the application has an anonymous Client ID.", "type": "boolean" }, "clientId": { @@ -5880,11 +6119,11 @@ }, "kind": { "default": "admin#directory#token", - "description": "The type of the API resource. This is always admin#directory#token.", + "description": "The type of the API resource. This is always `admin#directory#token`.", "type": "string" }, "nativeApp": { - "description": "Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device.", + "description": "Whether the token is issued to an installed application. The value is `true` if the application is installed to a desktop or mobile device.", "type": "boolean" }, "scopes": { @@ -5902,7 +6141,7 @@ "type": "object" }, "Tokens": { - "description": "JSON response template for List tokens operation in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "JSON response template for List tokens operation in Directory API.", "id": "Tokens", "properties": { "etag": { @@ -5918,27 +6157,27 @@ }, "kind": { "default": "admin#directory#tokenList", - "description": "The type of the API resource. This is always admin#directory#tokenList.", + "description": "The type of the API resource. This is always `admin#directory#tokenList`.", "type": "string" } }, "type": "object" }, "User": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'external_ids' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'relations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'addresses' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'organizations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'phones' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'languages' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'posix_accounts' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'ssh_public_keys' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'notes' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'websites' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'locations' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'keywords' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'gender' to avoid collision. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'thumbnail_photo_etag' to avoid collision. (See http://go/stepladder-help#fieldNumber)", + "description": "The Directory API allows you to create and manage your account's users, user aliases, and user Gmail chat profile photos. For more information about common tasks, see the [User Accounts Developer's Guide](/admin-sdk/directory/v1/guides/manage-users.html) and the [User Aliases Developer's Guide](/admin-sdk/directory/v1/guides/manage-user-aliases.html).", "id": "User", "properties": { "addresses": { - "description": "Addresses of User", + "description": "A list of the user's addresses. The maximum allowed data size for this field is 10Kb.", "type": "any" }, "agreedToTerms": { - "description": "Output only. Indicates if user has agreed to terms (Read-only)", + "description": "Output only. This property is `true` if the user has completed an initial login and accepted the Terms of Service agreement.", "readOnly": true, "type": "boolean" }, "aliases": { - "description": "Output only. List of aliases (Read-only)", + "description": "Output only. List of the user's alias email addresses.", "items": { "type": "string" }, @@ -5950,7 +6189,7 @@ "type": "boolean" }, "changePasswordAtNextLogin": { - "description": "Boolean indicating if the user should change password in next login", + "description": "Indicates if the user is forced to change their password at next login. This setting doesn't apply when [the user signs in via a third-party identity provider](https://support.google.com/a/answer/60224).", "type": "boolean" }, "creationTime": { @@ -5967,7 +6206,7 @@ "type": "object" }, "customerId": { - "description": "Output only. CustomerId of User (Read-only)", + "description": "Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](/admin-sdk/directory/v1/reference/users/list) request.", "readOnly": true, "type": "string" }, @@ -5977,7 +6216,7 @@ "type": "string" }, "emails": { - "description": "Emails of User", + "description": "A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.", "type": "any" }, "etag": { @@ -5986,40 +6225,40 @@ "type": "string" }, "externalIds": { - "description": "The external Ids of User *", + "description": "A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb.", "type": "any" }, "gender": { - "description": "Gender of User", + "description": "The user's gender. The maximum allowed data size for this field is 1Kb.", "type": "any" }, "hashFunction": { - "description": "Hash function name for password. Supported are MD5, SHA-1 and crypt", + "description": "Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the [SHA-1](http://wikipedia.org/wiki/SHA-1), [MD5](http://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_(C)) hash format.", "type": "string" }, "id": { - "description": "Unique identifier of User (Read-only)", + "description": "The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.", "type": "string" }, "ims": { - "description": "User's Instant Messenger", + "description": "The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb.", "type": "any" }, "includeInGlobalAddressList": { - "description": "Boolean indicating if user is included in Global Address List", + "description": "Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=1285988).", "type": "boolean" }, "ipWhitelisted": { - "description": "Boolean indicating if ip is whitelisted", + "description": "If `true`, the user's IP address is [white listed](http://support.google.com/a/bin/answer.py?answer=60752).", "type": "boolean" }, "isAdmin": { - "description": "Output only. Boolean indicating if the user is admin (Read-only)", + "description": "Output only. Indicates a user with super admininistrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](/admin-sdk/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](/admin-sdk/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](/admin-sdk/directory/v1/reference/users/insert.html) or [update](/admin-sdk/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service.", "readOnly": true, "type": "boolean" }, "isDelegatedAdmin": { - "description": "Output only. Boolean indicating if the user is delegated admin (Read-only)", + "description": "Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](http://support.google.com/a/bin/answer.py?answer=33325).", "readOnly": true, "type": "boolean" }, @@ -6034,22 +6273,22 @@ "type": "boolean" }, "isMailboxSetup": { - "description": "Output only. Is mailbox setup (Read-only)", + "description": "Output only. Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.", "readOnly": true, "type": "boolean" }, "keywords": { - "description": "Keywords of User", + "description": "The user's keywords. The maximum allowed data size for this field is 1Kb.", "type": "any" }, "kind": { "default": "admin#directory#user", - "description": "Output only. Kind of resource this is.", + "description": "Output only. The type of the API resource. For Users resources, the value is `admin#directory#user`.", "readOnly": true, "type": "string" }, "languages": { - "description": "Languages of User", + "description": "The user's languages. The maximum allowed data size for this field is 1Kb.", "type": "any" }, "lastLoginTime": { @@ -6059,7 +6298,7 @@ "type": "string" }, "locations": { - "description": "Locations of User", + "description": "The user's locations. The maximum allowed data size for this field is 10Kb.", "type": "any" }, "name": { @@ -6069,10 +6308,10 @@ "directory.users.insert" ] }, - "description": "User's name" + "description": "Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=33386). Maximum allowed data size for this field is 1Kb." }, "nonEditableAliases": { - "description": "Output only. List of non editable aliases (Read-only)", + "description": "Output only. List of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.", "items": { "type": "string" }, @@ -6080,15 +6319,15 @@ "type": "array" }, "notes": { - "description": "Notes of User", + "description": "Notes for the user.", "type": "any" }, "orgUnitPath": { - "description": "OrgUnit of User", + "description": "The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`).", "type": "string" }, "organizations": { - "description": "Organizations of User", + "description": "A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb.", "type": "any" }, "password": { @@ -6101,11 +6340,11 @@ "type": "string" }, "phones": { - "description": "Phone numbers of User", + "description": "A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.", "type": "any" }, "posixAccounts": { - "description": "The POSIX accounts of User", + "description": "A list of [POSIX](http://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.", "type": "any" }, "primaryEmail": { @@ -6114,7 +6353,7 @@ "directory.users.insert" ] }, - "description": "username of User", + "description": "The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user.", "type": "string" }, "recoveryEmail": { @@ -6126,11 +6365,11 @@ "type": "string" }, "relations": { - "description": "The Relations of User *", + "description": "A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.", "type": "any" }, "sshPublicKeys": { - "description": "The SSH public keys of User", + "description": "A list of SSH public keys.", "type": "any" }, "suspended": { @@ -6138,7 +6377,7 @@ "type": "boolean" }, "suspensionReason": { - "description": "Output only. Suspension reason if user is suspended (Read-only)", + "description": "Output only. Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the `suspended` property is `true`.", "readOnly": true, "type": "string" }, @@ -6153,7 +6392,7 @@ "type": "string" }, "websites": { - "description": "Websites of User", + "description": "The user's websites. The maximum allowed data size for this field is 2Kb.", "type": "any" } }, @@ -6410,7 +6649,7 @@ "directory.users.makeAdmin" ] }, - "description": "Boolean indicating new admin status of the user", + "description": "Indicates the administrator status of the user.", "type": "boolean" } }, @@ -6425,11 +6664,11 @@ "directory.users.insert" ] }, - "description": "Last Name", + "description": "The user's last name. Required when creating a user account.", "type": "string" }, "fullName": { - "description": "Full Name", + "description": "The user's full name formed by concatenating the first and last name values.", "type": "string" }, "givenName": { @@ -6438,7 +6677,7 @@ "directory.users.insert" ] }, - "description": "First Name", + "description": "The user's first name. Required when creating a user account.", "type": "string" } }, @@ -6524,7 +6763,6 @@ "type": "object" }, "UserPhoto": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", "id": "UserPhoto", "properties": { "etag": { @@ -6532,21 +6770,21 @@ "type": "string" }, "height": { - "description": "Height in pixels of the photo", + "description": "Height of the photo in pixels.", "format": "int32", "type": "integer" }, "id": { - "description": "Unique identifier of User (Read-only)", + "description": "The ID the API uses to uniquely identify the user.", "type": "string" }, "kind": { "default": "admin#directory#user#photo", - "description": "Kind of resource this is.", + "description": "The type of the API resource. For Photo resources, this is `admin#directory#user#photo`.", "type": "string" }, "mimeType": { - "description": "Mime Type of the photo", + "description": "The MIME type of the photo. Allowed values are `JPEG`, `PNG`, `GIF`, `BMP`, `TIFF`, and web-safe base64 encoding.", "type": "string" }, "photoData": { @@ -6555,16 +6793,16 @@ "directory.users.photos.update" ] }, - "description": "Base64 encoded photo data", + "description": "The user photo's upload data in [web-safe Base64](https://code.google.com/p/stringencoders/wiki/WebSafeBase64) format in bytes. This means: * The slash (/) character is replaced with the underscore (_) character. * The plus sign (+) character is replaced with the hyphen (-) character. * The equals sign (=) character is replaced with the asterisk (*). * For padding, the period (.) character is used instead of the RFC-4648 baseURL definition which uses the equals sign (=) for padding. This is done to simplify URL-parsing. * Whatever the size of the photo being uploaded, the API downsizes it to 96x96 pixels.", "format": "byte", "type": "string" }, "primaryEmail": { - "description": "Primary email of User (Read-only)", + "description": "The user's primary email address.", "type": "string" }, "width": { - "description": "Width in pixels of the photo", + "description": "Width of the photo in pixels.", "format": "int32", "type": "integer" } @@ -6572,7 +6810,7 @@ "type": "object" }, "UserPosixAccount": { - "description": "JSON template for a POSIX account entry. Description of the field family: go/fbs-posix.", + "description": "JSON template for a POSIX account entry.", "id": "UserPosixAccount", "properties": { "accountId": { @@ -6694,7 +6932,6 @@ "type": "object" }, "Users": { - "description": "STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", "id": "Users", "properties": { "etag": { @@ -6725,7 +6962,7 @@ "type": "object" }, "VerificationCode": { - "description": "JSON template for verification codes in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "The Directory API allows you to view, generate, and invalidate backup verification codes for a user.", "id": "VerificationCode", "properties": { "etag": { @@ -6734,7 +6971,7 @@ }, "kind": { "default": "admin#directory#verificationCode", - "description": "The type of the resource. This is always admin#directory#verificationCode.", + "description": "The type of the resource. This is always `admin#directory#verificationCode`.", "type": "string" }, "userId": { @@ -6749,7 +6986,7 @@ "type": "object" }, "VerificationCodes": { - "description": "JSON response template for List verification codes operation in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)", + "description": "JSON response template for List verification codes operation in Directory API.", "id": "VerificationCodes", "properties": { "etag": { @@ -6765,7 +7002,7 @@ }, "kind": { "default": "admin#directory#verificationCodesList", - "description": "The type of the resource. This is always admin#directory#verificationCodesList.", + "description": "The type of the resource. This is always `admin#directory#verificationCodesList`.", "type": "string" } }, @@ -6773,6 +7010,6 @@ } }, "servicePath": "", - "title": "Admin SDK", + "title": "Admin SDK API", "version": "directory_v1" } \ No newline at end of file
diff --git a/discovery/googleapis/admin__reports_v1.json b/discovery/googleapis/admin__reports_v1.json index 82b2598..f8a8be6 100644 --- a/discovery/googleapis/admin__reports_v1.json +++ b/discovery/googleapis/admin__reports_v1.json
@@ -12,8 +12,8 @@ } }, "basePath": "", - "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch/admin/reports_v1", + "baseUrl": "https://admin.googleapis.com/", + "batchPath": "batch", "canonicalName": "reports", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryVersion": "v1", @@ -145,7 +145,8 @@ "token", "user_accounts", "context_aware_access", - "chrome" + "chrome", + "data_studio" ], "enumDescriptions": [ "", @@ -167,39 +168,46 @@ "The Token application's activity reports return account information about different types of Token activity events.", "The User Accounts application's activity reports return account information about different types of User Accounts activity events.", "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.", - "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp." + "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.", + "The Data Studio activity reports return information about various types of Data Studio activity events." ], "location": "path", - "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)|(gcp)|(context_aware_access)|(data_studio)|(chrome)", + "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)", "required": true, "type": "string" }, "customerId": { "description": "The unique ID of the customer to retrieve data for.", "location": "query", - "pattern": "C.+", + "pattern": "C.+|my_customer", "type": "string" }, "endTime": { - "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.", + "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.", "location": "query", "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))", "type": "string" }, "eventName": { - "description": "The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.", + "description": "The name of the event being queried by the API. Each `eventName` is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.", "location": "query", "type": "string" }, "filters": { - "description": "The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form parameter1 name[parameter1 value],parameter2 name[parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ", + "description": "The `filters` query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form `parameter1 name[parameter1 value],parameter2 name[parameter2 value],...` These event parameters are associated with a specific `eventName`. An empty report is returned if the filtered request's parameter does not belong to the `eventName`. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's `doc_id` parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's `doc_id`. In the second example, the report returns each viewed document's `doc_id` that equals the value 12345 and does not return any viewed document's which have a `doc_id` value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ", "location": "query", "pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)", "type": "string" }, + "groupIdFilter": { + "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"", + "location": "query", + "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)", + "type": "string" + }, "maxResults": { "default": "1000", - "description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000.", + "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.", "format": "int32", "location": "query", "maximum": "1000", @@ -214,18 +222,18 @@ "type": "string" }, "pageToken": { - "description": "The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.", + "description": "The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.", "location": "query", "type": "string" }, "startTime": { - "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.", + "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.", "location": "query", "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))", "type": "string" }, "userKey": { - "description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.", + "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique G Suite profile ID or their primary email address.", "location": "path", "required": true, "type": "string" @@ -275,7 +283,8 @@ "token", "user_accounts", "context_aware_access", - "chrome" + "chrome", + "data_studio" ], "enumDescriptions": [ "", @@ -297,39 +306,46 @@ "The Token application's activity reports return account information about different types of Token activity events.", "The User Accounts application's activity reports return account information about different types of User Accounts activity events.", "The Context-aware access activity reports return information about users' access denied events due to Context-aware access rules.", - "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp." + "The Chrome activity reports return information about unsafe events reported in the context of the WebProtect features of BeyondCorp.", + "The Data Studio activity reports return information about various types of Data Studio activity events." ], "location": "path", - "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)|(groups_enterprise)|(gcp)|(context_aware_access)|(data_studio)|(chrome)", + "pattern": "(access_transparency)|(admin)|(calendar)|(chat)|(chrome)|(context_aware_access)|(data_studio)|(drive)|(gcp)|(gplus)|(groups)|(groups_enterprise)|(jamboard)|(login)|(meet)|(mobile)|(rules)|(saml)|(token)|(user_accounts)", "required": true, "type": "string" }, "customerId": { "description": "The unique ID of the customer to retrieve data for.", "location": "query", - "pattern": "C.+", + "pattern": "C.+|my_customer", "type": "string" }, "endTime": { - "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the endTime is not specified, the report returns all activities from the startTime until the current time or the most recent 180 days if the startTime is more than 180 days in the past.", + "description": "Sets the end of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The default value is the approximate time of the API request. An API report has three basic time concepts: - *Date of the API's request for a report*: When the API created and retrieved the report. - *Report's start time*: The beginning of the timespan shown in the report. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error. - *Report's end time*: The end of the timespan shown in the report. For example, the timespan of events summarized in a report can start in April and end in May. The report itself can be requested in August. If the `endTime` is not specified, the report returns all activities from the `startTime` until the current time or the most recent 180 days if the `startTime` is more than 180 days in the past.", "location": "query", "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))", "type": "string" }, "eventName": { - "description": "The name of the event being queried by the API. Each eventName is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings type structure has all of the Calendar eventName activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings type and eventName parameters. For more information about eventName query strings and parameters, see the list of event names for various applications above in applicationName.", + "description": "The name of the event being queried by the API. Each `eventName` is related to a specific G Suite service or feature which the API organizes into types of events. An example is the Google Calendar events in the Admin console application's reports. The Calendar Settings `type` structure has all of the Calendar `eventName` activities reported by the API. When an administrator changes a Calendar setting, the API reports this activity in the Calendar Settings `type` and `eventName` parameters. For more information about `eventName` query strings and parameters, see the list of event names for various applications above in `applicationName`.", "location": "query", "type": "string" }, "filters": { - "description": "The filters query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form parameter1 name[parameter1 value],parameter2 name[parameter2 value],... These event parameters are associated with a specific eventName. An empty report is returned if the filtered request's parameter does not belong to the eventName. For more information about eventName parameters, see the list of event names for various applications above in applicationName. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's doc_id parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's doc_id. In the second example, the report returns each viewed document's doc_id that equals the value 12345 and does not return any viewed document's which have a doc_id value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ", + "description": "The `filters` query string is a comma-separated list. The list is composed of event parameters that are manipulated by relational operators. Event parameters are in the form `parameter1 name[parameter1 value],parameter2 name[parameter2 value],...` These event parameters are associated with a specific `eventName`. An empty report is returned if the filtered request's parameter does not belong to the `eventName`. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`. In the following Admin Activity example, the <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=CHANGE_CALENDAR_SETTING &filters=NEW_VALUE%3C%3EREAD_ONLY_ACCESS In the following Drive example, the list can be a view or edit event's `doc_id` parameter with a value that is manipulated by an 'equal to' (==) or 'not equal to' (<>) relational operator. In the first example, the report returns each edited document's `doc_id`. In the second example, the report returns each viewed document's `doc_id` that equals the value 12345 and does not return any viewed document's which have a `doc_id` value of 98765. The <> operator is URL-encoded in the request's query string (%3C%3E): GET...&eventName=edit&filters=doc_id GET...&eventName=view&filters=doc_id==12345,doc_id%3C%3E98765 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. If no parameters are requested, all parameters are returned. ", "location": "query", "pattern": "(.+[<,<=,==,>=,>,<>].+,)*(.+[<,<=,==,>=,>,<>].+)", "type": "string" }, + "groupIdFilter": { + "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"", + "location": "query", + "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)", + "type": "string" + }, "maxResults": { "default": "1000", - "description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional in the request. The default value is 1000.", + "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.", "format": "int32", "location": "query", "maximum": "1000", @@ -344,18 +360,18 @@ "type": "string" }, "pageToken": { - "description": "The token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.", + "description": "The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.", "location": "query", "type": "string" }, "startTime": { - "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from startTime until endTime. The startTime must be before the endTime (if specified) and the current time when the request is made, or the API returns an error.", + "description": "Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.", "location": "query", "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))", "type": "string" }, "userKey": { - "description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.", + "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique G Suite profile ID or their primary email address.", "location": "path", "required": true, "type": "string" @@ -405,7 +421,7 @@ "customerId": { "description": "The unique ID of the customer to retrieve data for.", "location": "query", - "pattern": "C.+", + "pattern": "C.+|my_customer", "type": "string" }, "date": { @@ -416,12 +432,12 @@ "type": "string" }, "pageToken": { - "description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string.", + "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the `nextPageToken` value in the `pageToken` query string.", "location": "query", "type": "string" }, "parameters": { - "description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", + "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", "location": "query", "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)", "type": "string" @@ -452,7 +468,7 @@ "customerId": { "description": "The unique ID of the customer to retrieve data for.", "location": "query", - "pattern": "C.+", + "pattern": "C.+|my_customer", "type": "string" }, "date": { @@ -472,7 +488,7 @@ "enumDescriptions": [ "", "Returns activity events for all users.", - "Represents an app-specific identifier for the entity. For details on how to obtain the entityKey for a particular entityType, see the Entities Usage parameters reference guides." + "Represents an app-specific identifier for the entity. For details on how to obtain the `entityKey` for a particular `entityType`, see the Entities Usage parameters reference guides." ], "location": "path", "required": true, @@ -494,14 +510,14 @@ "type": "string" }, "filters": { - "description": "The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include accounts, docs, and gmail. Filters are in the form [application name]:parameter name[parameter value],.... In this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members>0 The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters. ", + "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Entities usage report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01 ?parameters=gplus:community_name,gplus:num_total_members &filters=gplus:num_total_members%3C%3E0 The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). Filters can only be applied to numeric parameters.", "location": "query", "pattern": "(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((gplus)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)", "type": "string" }, "maxResults": { "default": "1000", - "description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page.", + "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page.", "format": "uint32", "location": "query", "maximum": "1000", @@ -509,12 +525,12 @@ "type": "integer" }, "pageToken": { - "description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.", + "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.", "location": "query", "type": "string" }, "parameters": { - "description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only gplus. A parameter query string is in the CSV form of [app_name1:param_name1], [app_name2:param_name2].... *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", + "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Entities usage report are only `gplus`. A `parameter` query string is in the CSV form of `[app_name1:param_name1], [app_name2:param_name2]...`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", "location": "query", "pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)", "type": "string" @@ -544,7 +560,7 @@ "customerId": { "description": "The unique ID of the customer to retrieve data for.", "location": "query", - "pattern": "C.+", + "pattern": "C.+|my_customer", "type": "string" }, "date": { @@ -555,14 +571,20 @@ "type": "string" }, "filters": { - "description": "The filters query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The filters query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include accounts, docs, and gmail. Filters are in the form [application name]:parameter name[parameter value],.... In this example, the <> 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time>2010-10-28T10:26:35.000Z The relational operators include: - == - 'equal to'. - <> - 'not equal to'. It is URL-encoded (%3C%3E). - < - 'less than'. It is URL-encoded (%3C). - <= - 'less than or equal to'. It is URL-encoded (%3C=). - > - 'greater than'. It is URL-encoded (%3E). - >= - 'greater than or equal to'. It is URL-encoded (%3E=). ", + "description": "The `filters` query string is a comma-separated list of an application's event parameters where the parameter's value is manipulated by a relational operator. The `filters` query string includes the name of the application whose usage is returned in the report. The application values for the Users Usage Report include `accounts`, `docs`, and `gmail`. Filters are in the form `[application name]:parameter name[parameter value],...`. In this example, the `<>` 'not equal to' operator is URL-encoded in the request's query string (%3C%3E): GET https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03 ?parameters=accounts:last_login_time &filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z The relational operators include: - `==` - 'equal to'. - `<>` - 'not equal to'. It is URL-encoded (%3C%3E). - `<` - 'less than'. It is URL-encoded (%3C). - `<=` - 'less than or equal to'. It is URL-encoded (%3C=). - `>` - 'greater than'. It is URL-encoded (%3E). - `>=` - 'greater than or equal to'. It is URL-encoded (%3E=). ", "location": "query", "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[<,<=,==,>=,>,!=][^,]+)", "type": "string" }, + "groupIdFilter": { + "description": "Comma separated group ids (obfuscated) on which user activities are filtered, i.e, the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: \"id:abc123,id:xyz456\"", + "location": "query", + "pattern": "(id:[a-z0-9]+(,id:[a-z0-9]+)*)", + "type": "string" + }, "maxResults": { "default": "1000", - "description": "Determines how many activity records are shown on each response page. For example, if the request sets maxResults=1 and the report has two activities, the report has two pages. The response's nextPageToken property has the token to the second page. The maxResults query string is optional.", + "description": "Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response's `nextPageToken` property has the token to the second page. The `maxResults` query string is optional.", "format": "uint32", "location": "query", "maximum": "1000", @@ -577,18 +599,18 @@ "type": "string" }, "pageToken": { - "description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. In your follow-on request getting the next page of the report, enter the nextPageToken value in the pageToken query string.", + "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.", "location": "query", "type": "string" }, "parameters": { - "description": "The parameters query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers usage report include accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet, and sites. A parameters query string is in the CSV form of app_name1:param_name1, app_name2:param_name2. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", + "description": "The `parameters` query string is a comma-separated list of event parameters that refine a report's results. The parameter is associated with a specific application. The application values for the Customers Usage report include `accounts`, `app_maker`, `apps_scripts`, `calendar`, `classroom`, `cros`, `docs`, `gmail`, `gplus`, `device_management`, `meet`, and `sites`. A `parameters` query string is in the CSV form of `app_name1:param_name1, app_name2:param_name2`. *Note:* The API doesn't accept multiple values of a parameter. If a particular parameter is supplied more than once in the API request, the API only accepts the last value of that request parameter. In addition, if an invalid request parameter is supplied in the API request, the API ignores that request parameter and returns the response corresponding to the remaining valid request parameters. An example of an invalid request parameter is one that does not belong to the application. If no parameters are requested, all parameters are returned. ", "location": "query", "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)", "type": "string" }, "userKey": { - "description": "Represents the profile ID or the user email for which the data should be filtered. Can be all for all information, or userKey for a user's unique G Suite profile ID or their primary email address.", + "description": "Represents the profile ID or the user email for which the data should be filtered. Can be `all` for all information, or `userKey` for a user's unique G Suite profile ID or their primary email address.", "location": "path", "required": true, "type": "string" @@ -605,8 +627,8 @@ } } }, - "revision": "20201006", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210202", + "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { "description": "JSON template for a collection of activities.", @@ -625,11 +647,11 @@ }, "kind": { "default": "admin#reports#activities", - "description": "The type of API resource. For an activity report, the value is reports#activities.", + "description": "The type of API resource. For an activity report, the value is `reports#activities`.", "type": "string" }, "nextPageToken": { - "description": "Token for retrieving the follow-on next page of the report. The nextPageToken value is used in the request's pageToken query string.", + "description": "Token for retrieving the follow-on next page of the report. The `nextPageToken` value is used in the request's `pageToken` query string.", "type": "string" } }, @@ -651,7 +673,7 @@ "type": "string" }, "key": { - "description": "Only present when callerType is KEY. Can be the consumer_key of the requestor for OAuth 2LO API requests or an identifier for robot accounts.", + "description": "Only present when `callerType` is `KEY`. Can be the `consumer_key` of the requestor for OAuth 2LO API requests or an identifier for robot accounts.", "type": "string" }, "profileId": { @@ -670,11 +692,11 @@ "items": { "properties": { "name": { - "description": "Name of the event. This is the specific name of the activity reported by the API. And each eventName is related to a specific G Suite service or feature which the API organizes into types of events. For eventName request parameters in general: - If no eventName is given, the report returns all possible instances of an eventName. - When you request an eventName, the API's response returns all activities which contain that eventName. It is possible that the returned activities will have other eventName properties in addition to the one requested. For more information about eventName properties, see the list of event names for various applications above in applicationName.", + "description": "Name of the event. This is the specific name of the activity reported by the API. And each `eventName` is related to a specific G Suite service or feature which the API organizes into types of events. For `eventName` request parameters in general: - If no `eventName` is given, the report returns all possible instances of an `eventName`. - When you request an `eventName`, the API's response returns all activities which contain that `eventName`. It is possible that the returned activities will have other `eventName` properties in addition to the one requested. For more information about `eventName` properties, see the list of event names for various applications above in `applicationName`.", "type": "string" }, "parameters": { - "description": "Parameter value pairs for various applications. For more information about eventName parameters, see the list of event names for various applications above in applicationName.", + "description": "Parameter value pairs for various applications. For more information about `eventName` parameters, see the list of event names for various applications above in `applicationName`.", "items": { "properties": { "boolValue": { @@ -687,7 +709,7 @@ "type": "string" }, "messageValue": { - "description": "Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as [{parameter: [{name: city, value: abc}]}]", + "description": "Nested parameter value pairs associated with this parameter. Complex value type for a parameter are returned as a list of parameter values. For example, the address parameter may have a value as `[{parameter: [{name: city, value: abc}]}]`", "properties": { "parameter": { "description": "Parameter values", @@ -708,7 +730,7 @@ "type": "array" }, "multiMessageValue": { - "description": "List of messageValue objects.", + "description": "List of `messageValue` objects.", "items": { "properties": { "parameter": { @@ -744,7 +766,7 @@ "type": "array" }, "type": { - "description": "Type of event. The G Suite service or feature that an administrator changes is identified in the type property which identifies an event using the eventName property. For a full list of the API's type categories, see the list of event names for various applications above in applicationName.", + "description": "Type of event. The G Suite service or feature that an administrator changes is identified in the `type` property which identifies an event using the `eventName` property. For a full list of the API's `type` categories, see the list of event names for various applications above in `applicationName`.", "type": "string" } }, @@ -756,7 +778,7 @@ "description": "Unique identifier for each activity record.", "properties": { "applicationName": { - "description": "Application name to which the event belongs. For possible values see the list of applications above in applicationName.", + "description": "Application name to which the event belongs. For possible values see the list of applications above in `applicationName`.", "type": "string" }, "customerId": { @@ -782,7 +804,7 @@ }, "kind": { "default": "admin#reports#activity", - "description": "The type of API resource. For an activity report, the value is audit#activity.", + "description": "The type of API resource. For an activity report, the value is `audit#activity`.", "type": "string" }, "ownerDomain": { @@ -811,7 +833,7 @@ }, "kind": { "default": "api#channel", - "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"api#channel\".", + "description": "Identifies this as a notification channel used to watch for changes to a resource, which is \"`api#channel`\".", "type": "string" }, "params": { @@ -838,7 +860,7 @@ "type": "string" }, "type": { - "description": "The type of delivery mechanism used for this channel.", + "description": "The type of delivery mechanism used for this channel. The value should be set to `\"web_hook\"`.", "type": "string" } }, @@ -918,7 +940,7 @@ "type": "string" }, "type": { - "description": "Output only. The type of item. The value is customer.", + "description": "Output only. The type of item. The value is `user`.", "readOnly": true, "type": "string" }, @@ -937,11 +959,11 @@ }, "kind": { "default": "admin#reports#usageReport", - "description": "The type of API resource. For a usage report, the value is admin#reports#usageReport.", + "description": "The type of API resource. For a usage report, the value is `admin#reports#usageReport`.", "type": "string" }, "parameters": { - "description": "Output only. Parameter value pairs for various applications. For the Customers usage report parameters and values, see the customer usage parameters reference.", + "description": "Output only. Parameter value pairs for various applications. For the Entity Usage Report parameters and values, see [the Entity Usage parameters reference](/admin-sdk/reports/v1/reference/usage-ref-appendix-a/entities).", "items": { "properties": { "boolValue": { @@ -974,7 +996,7 @@ "type": "array" }, "name": { - "description": "Name of the parameter.", + "description": "The name of the parameter. For the User Usage Report parameter names, see the User Usage parameters reference.", "type": "string" }, "stringValue": { @@ -1000,11 +1022,11 @@ }, "kind": { "default": "admin#reports#usageReports", - "description": "The type of API resource. For a usage report, the value is admin#reports#usageReports.", + "description": "The type of API resource. For a usage report, the value is `admin#reports#usageReports`.", "type": "string" }, "nextPageToken": { - "description": "Token to specify next page. A report with multiple pages has a nextPageToken property in the response. For your follow-on requests getting all of the report's pages, enter the nextPageToken value in the pageToken query string.", + "description": "Token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. For your follow-on requests getting all of the report's pages, enter the `nextPageToken` value in the `pageToken` query string.", "type": "string" }, "usageReports": { @@ -1019,7 +1041,7 @@ "items": { "properties": { "code": { - "description": "Machine readable code or warning type. The warning code value is 200.", + "description": "Machine readable code or warning type. The warning code value is `200`.", "type": "string" }, "data": { @@ -1040,7 +1062,7 @@ "type": "array" }, "message": { - "description": "The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application \"application name\" is not available. - Partial data is available warning - Data for date yyyy-mm-dd for application \"application name\" is not available right now, please try again after a few hours. ", + "description": "The human readable messages for a warning are: - Data is not available warning - Sorry, data for date yyyy-mm-dd for application \"`application name`\" is not available. - Partial data is available warning - Data for date yyyy-mm-dd for application \"`application name`\" is not available right now, please try again after a few hours. ", "type": "string" } }, @@ -1053,6 +1075,6 @@ } }, "servicePath": "", - "title": "Admin SDK", + "title": "Admin SDK API", "version": "reports_v1" } \ No newline at end of file
diff --git a/discovery/googleapis/admob__v1.json b/discovery/googleapis/admob__v1.json index 81be064..ad49f1c 100644 --- a/discovery/googleapis/admob__v1.json +++ b/discovery/googleapis/admob__v1.json
@@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/admob.readonly": { + "description": "See your AdMob data" + }, "https://www.googleapis.com/auth/admob.report": { "description": "See your AdMob data" } @@ -126,11 +129,12 @@ "$ref": "PublisherAccount" }, "scopes": [ + "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" ] }, "list": { - "description": "Lists the AdMob publisher account accessible with the client credential. Currently, all credentials have access to at most one AdMob account.", + "description": "List the AdMob publisher account accessible with the client credential. Currently, all credentials have access to at most one AdMob account.", "httpMethod": "GET", "id": "admob.accounts.list", "parameterOrder": [], @@ -152,6 +156,7 @@ "$ref": "ListPublisherAccountsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" ] } @@ -160,7 +165,7 @@ "mediationReport": { "methods": { "generate": { - "description": "Generates an AdMob Mediation report based on the provided report specification.", + "description": "Generates an AdMob Mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.", "httpMethod": "POST", "id": "admob.accounts.mediationReport.generate", "parameterOrder": [ @@ -183,6 +188,7 @@ "$ref": "GenerateMediationReportResponse" }, "scopes": [ + "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" ] } @@ -191,7 +197,7 @@ "networkReport": { "methods": { "generate": { - "description": "Generates an AdMob Network report based on the provided report specification.", + "description": "Generates an AdMob Network report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.", "httpMethod": "POST", "id": "admob.accounts.networkReport.generate", "parameterOrder": [ @@ -214,6 +220,7 @@ "$ref": "GenerateNetworkReportResponse" }, "scopes": [ + "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" ] } @@ -222,25 +229,25 @@ } } }, - "revision": "20201008", + "revision": "20210204", "rootUrl": "https://admob.googleapis.com/", "schemas": { "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -656,7 +663,7 @@ "The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000.", "The total number of ads shown to users. The value is an integer.", "The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.", - "The estimated earnings per thousand ad impressions. The value is in micros. For example, $1.03 would be represented as 1030000. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", + "The estimated earnings per thousand ad impressions. The value is in micros. For example, $1.03 would be represented as 1030000. Equivalent to eCPM in the AdMob UI. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", "The number of times ads are returned in response to a request. The value is an integer.", "The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", "The ratio of ads that are displayed over ads that are returned, defined as impressions / matched requests. The value is a double precision (approximate) decimal value." @@ -771,7 +778,7 @@ "The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000.", "The total number of ads shown to users. The value is an integer.", "The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.", - "The estimated earnings per thousand ad impressions. The value is in micros. For example, $1.03 would be represented as 1030000. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", + "The estimated earnings per thousand ad impressions. The value is in micros. For example, $1.03 would be represented as 1030000. Equivalent to eCPM in the AdMob UI. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", "The number of times ads are returned in response to a request. The value is an integer.", "The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", "The ratio of ads that are displayed over ads that are returned, defined as impressions / matched requests. The value is a double precision (approximate) decimal value."
diff --git a/discovery/googleapis/analytics__v3.json b/discovery/googleapis/analytics__v3.json index ccdf64d..23dda81 100644 --- a/discovery/googleapis/analytics__v3.json +++ b/discovery/googleapis/analytics__v3.json
@@ -3806,7 +3806,7 @@ } }, "revision": "20190807", - "rootUrl": "https://www.googleapis.com/", + "rootUrl": "https://analytics.googleapis.com/", "schemas": { "Account": { "description": "JSON template for Analytics account entry.",
diff --git a/discovery/googleapis/analyticsreporting__v4.json b/discovery/googleapis/analyticsreporting__v4.json index 6712a42..56662d8 100644 --- a/discovery/googleapis/analyticsreporting__v4.json +++ b/discovery/googleapis/analyticsreporting__v4.json
@@ -6,7 +6,7 @@ "description": "View and manage your Google Analytics data" }, "https://www.googleapis.com/auth/analytics.readonly": { - "description": "View your Google Analytics data" + "description": "See and download your Google Analytics data" } } } @@ -151,7 +151,7 @@ } } }, - "revision": "20201007", + "revision": "20210106", "rootUrl": "https://analyticsreporting.googleapis.com/", "schemas": { "Activity": {
diff --git a/discovery/googleapis/androiddeviceprovisioning__v1.json b/discovery/googleapis/androiddeviceprovisioning__v1.json index f3037cd..e62f9a9 100644 --- a/discovery/googleapis/androiddeviceprovisioning__v1.json +++ b/discovery/googleapis/androiddeviceprovisioning__v1.json
@@ -797,7 +797,7 @@ } } }, - "revision": "20201007", + "revision": "20210127", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": {
diff --git a/discovery/googleapis/androidenterprise__v1.json b/discovery/googleapis/androidenterprise__v1.json index d40eb3c..e308290 100644 --- a/discovery/googleapis/androidenterprise__v1.json +++ b/discovery/googleapis/androidenterprise__v1.json
@@ -284,7 +284,7 @@ ] }, "update": { - "description": "Updates the device policy", + "description": "Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed configuration for the Google Play package. See restrict accounts in Google Play.", "httpMethod": "PUT", "id": "androidenterprise.devices.update", "parameterOrder": [ @@ -2534,7 +2534,7 @@ } } }, - "revision": "20200929", + "revision": "20210203", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -4126,6 +4126,22 @@ "$ref": "AutoInstallPolicy", "description": "The auto-install policy for the product." }, + "autoUpdateMode": { + "description": "The auto-update mode for the product.", + "enum": [ + "autoUpdateModeUnspecified", + "autoUpdateDefault", + "autoUpdatePostponed", + "autoUpdateHighPriority" + ], + "enumDescriptions": [ + "Unspecified. Defaults to AUTO_UPDATE_DEFAULT.", + "The app is automatically updated with low priority to minimize the impact on the user. The app is updated when the following constraints are met: * The device is not actively used * The device is connected to a Wi-Fi network. * The device is charging * If the system update policy is set to `WINDOWED`: the local time of the device is within the daily maintenance window The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.", + "The app is not automatically updated for a maximum of 90 days after the app becomes out of date. 90 days after the app becomes out of date, the latest available version is installed automatically with low priority (see AUTO_UPDATE_DEFAULT). After the app is updated it is not automatically updated again until 90 days after it becomes out of date again. The user can still manually update the app from the Play Store at any time.", + "The app is updated as soon as possible. No constraints are applied. The device is notified immediately about a new app update after it is published by the developer." + ], + "type": "string" + }, "managedConfiguration": { "$ref": "ManagedConfiguration", "description": "The managed configuration for the product."
diff --git a/discovery/googleapis/androidmanagement__v1.json b/discovery/googleapis/androidmanagement__v1.json index e15938c..adab601 100644 --- a/discovery/googleapis/androidmanagement__v1.json +++ b/discovery/googleapis/androidmanagement__v1.json
@@ -111,6 +111,11 @@ "id": "androidmanagement.enterprises.create", "parameterOrder": [], "parameters": { + "agreementAccepted": { + "description": "This feature is not generally available yet. Whether the managed Google Play Agreement is presented and agreed.", + "location": "query", + "type": "boolean" + }, "enterpriseToken": { "description": "The enterprise token appended to the callback URL.", "location": "query", @@ -138,6 +143,30 @@ "https://www.googleapis.com/auth/androidmanagement" ] }, + "delete": { + "description": "This feature is not generally available yet. Deletes an enterprise.", + "httpMethod": "DELETE", + "id": "androidmanagement.enterprises.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "This feature is not generally available yet. The name of the enterprise in the form enterprises/{enterpriseId}.", + "location": "path", + "pattern": "^enterprises/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidmanagement" + ] + }, "get": { "description": "Gets an enterprise.", "httpMethod": "GET", @@ -162,6 +191,50 @@ "https://www.googleapis.com/auth/androidmanagement" ] }, + "list": { + "description": "This feature is not generally available yet. Lists enterprises that are managed by an EMM. Only partial views are returned.", + "httpMethod": "GET", + "id": "androidmanagement.enterprises.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "This feature is not generally available yet. The requested page size. The actual page size may be fixed to a min or max value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "This feature is not generally available yet. A token identifying a page of results returned by the server.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. This feature is not generally available yet. The ID of the Cloud project of the EMM the enterprises belongs to.", + "location": "query", + "type": "string" + }, + "view": { + "description": "This feature is not generally available yet. View that specify that partial response should be returned.", + "enum": [ + "ENTERPRISE_VIEW_UNSPECIFIED", + "BASIC" + ], + "enumDescriptions": [ + "This feature is not generally available yet. The API will default to the BASIC view for the List method.", + "This feature is not generally available yet. Includes name and enterprise_display_name fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/enterprises", + "response": { + "$ref": "ListEnterprisesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidmanagement" + ] + }, "patch": { "description": "Updates an enterprise.", "httpMethod": "PATCH", @@ -901,13 +974,27 @@ } } }, - "revision": "20200928", + "revision": "20210127", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdvancedSecurityOverrides": { "description": "Security policies set to the most secure values by default. To maintain the security posture of a device, we don't recommend overriding any of the default values.", "id": "AdvancedSecurityOverrides", "properties": { + "commonCriteriaMode": { + "description": "Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required.", + "enum": [ + "COMMON_CRITERIA_MODE_UNSPECIFIED", + "COMMON_CRITERIA_MODE_DISABLED", + "COMMON_CRITERIA_MODE_ENABLED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to COMMON_CRITERIA_MODE_DISABLED.", + "Default. Disables Common Criteria Mode.", + "Enables Common Criteria Mode." + ], + "type": "string" + }, "untrustedAppsPolicy": { "description": "The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated).", "enum": [ @@ -1073,6 +1160,22 @@ }, "type": "array" }, + "autoUpdateMode": { + "description": "This feature is not generally available yet.", + "enum": [ + "AUTO_UPDATE_MODE_UNSPECIFIED", + "AUTO_UPDATE_DEFAULT", + "AUTO_UPDATE_POSTPONED", + "AUTO_UPDATE_HIGH_PRIORITY" + ], + "enumDescriptions": [ + "This feature is not generally available yet.", + "This feature is not generally available yet.", + "This feature is not generally available yet.", + "This feature is not generally available yet." + ], + "type": "string" + }, "connectedWorkAndPersonalApp": { "description": "Controls whether the app can communicate with itself across a device’s work and personal profiles, subject to user consent.", "enum": [ @@ -1394,13 +1497,15 @@ "COMMAND_TYPE_UNSPECIFIED", "LOCK", "RESET_PASSWORD", - "REBOOT" + "REBOOT", + "RELINQUISH_OWNERSHIP" ], "enumDescriptions": [ "This value is disallowed.", "Lock the device, as if the lock screen timeout had expired.", "Reset the user's password.", - "Reboot the device. Only supported on fully managed devices running Android 7.0 (API level 24) or higher." + "Reboot the device. Only supported on fully managed devices running Android 7.0 (API level 24) or higher.", + "Removes the work profile and all policies from a company-owned Android 8.0+ device, relinquishing the device for personal use. Apps and data associated with the personal profile(s) are preserved. The device will be deleted from the server after it acknowledges the command." ], "type": "string" }, @@ -1411,6 +1516,27 @@ }, "type": "object" }, + "CommonCriteriaModeInfo": { + "description": "Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy.", + "id": "CommonCriteriaModeInfo", + "properties": { + "commonCriteriaModeStatus": { + "description": "Whether Common Criteria Mode is enabled.", + "enum": [ + "COMMON_CRITERIA_MODE_STATUS_UNKNOWN", + "COMMON_CRITERIA_MODE_DISABLED", + "COMMON_CRITERIA_MODE_ENABLED" + ], + "enumDescriptions": [ + "Unknown status.", + "Common Criteria Mode is currently disabled.", + "Common Criteria Mode is currently enabled." + ], + "type": "string" + } + }, + "type": "object" + }, "ComplianceRule": { "description": "A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule.", "id": "ComplianceRule", @@ -1437,22 +1563,57 @@ }, "type": "object" }, + "ContactInfo": { + "description": "Contact details for LaForge enterprises.", + "id": "ContactInfo", + "properties": { + "contactEmail": { + "description": "Email address for a point of contact, which will be used to send important announcements related to managed Google Play.", + "type": "string" + }, + "dataProtectionOfficerEmail": { + "description": "The email of the data protection officer. The email is validated but not verified.", + "type": "string" + }, + "dataProtectionOfficerName": { + "description": "The name of the data protection officer.", + "type": "string" + }, + "dataProtectionOfficerPhone": { + "description": "The phone number of the data protection officer The phone number is validated but not verified.", + "type": "string" + }, + "euRepresentativeEmail": { + "description": "The email of the EU representative. The email is validated but not verified.", + "type": "string" + }, + "euRepresentativeName": { + "description": "The name of the EU representative.", + "type": "string" + }, + "euRepresentativePhone": { + "description": "The phone number of the EU representative. The phone number is validated but not verified.", + "type": "string" + } + }, + "type": "object" + }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: A full date, with non-zero year, month and day values A month and day value, with a zero year, e.g. an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, e.g. a credit card expiration dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values A month and day value, with a zero year, such as an anniversary A year on its own, with zero month and day values A year and month value, with a zero day, such as a credit card expiration dateRelated types are google.type.TimeOfDay and google.protobuf.Timestamp.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -1502,6 +1663,10 @@ ], "type": "string" }, + "commonCriteriaModeInfo": { + "$ref": "CommonCriteriaModeInfo", + "description": "Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy." + }, "deviceSettings": { "$ref": "DeviceSettings", "description": "Device settings information. This information is only available if deviceSettingsEnabled is true in the device's policy." @@ -1812,7 +1977,7 @@ "type": "string" }, "duration": { - "description": "The length of time the enrollment token is valid, ranging from 1 minute to 30 days. If not specified, the default duration is 1 hour.", + "description": "The length of time the enrollment token is valid, ranging from 1 minute to 90 days. If not specified, the default duration is 1 hour.", "format": "google-duration", "type": "string" }, @@ -1856,6 +2021,10 @@ "description": "Deprecated and unused.", "type": "boolean" }, + "contactInfo": { + "$ref": "ContactInfo", + "description": "This feature is not generally available yet. The enterprise contact info of an EMM owned enterprise" + }, "enabledNotificationTypes": { "description": "The types of Google Pub/Sub notifications enabled for the enterprise.", "items": { @@ -2253,6 +2422,24 @@ }, "type": "object" }, + "ListEnterprisesResponse": { + "description": "This feature is not generally available yet. Response to a request to list enterprises.", + "id": "ListEnterprisesResponse", + "properties": { + "enterprises": { + "description": "This feature is not generally available yet. The list of enterprises.", + "items": { + "$ref": "Enterprise" + }, + "type": "array" + }, + "nextPageToken": { + "description": "This feature is not generally available yet. If there are more results, a token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -2473,6 +2660,13 @@ "description": "Alphabetic name of current registered operator. For example, Vodafone.", "type": "string" }, + "telephonyInfos": { + "description": "Provides telephony information associated with each SIM card on the device. Only supported on fully managed devices starting from Android API level 23 and above.", + "items": { + "$ref": "TelephonyInfo" + }, + "type": "array" + }, "wifiMacAddress": { "description": "Wi-Fi MAC address of the device. For example, 7c:11:11:11:11:11.", "type": "string" @@ -2826,11 +3020,13 @@ "description": "The type of installation to perform.", "enum": [ "INSTALL_TYPE_UNSPECIFIED", - "BLOCKED" + "BLOCKED", + "AVAILABLE" ], "enumDescriptions": [ - "Unspecified. The default behavior is that all installs are allowed.", - "The app is blocked and can't be installed in the personal profile." + "Unspecified. Defaults to AVAILABLE.", + "The app is blocked and can't be installed in the personal profile.", + "The app is available to install in the personal profile." ], "type": "string" }, @@ -2869,14 +3065,18 @@ "type": "array" }, "personalPlayStoreMode": { - "description": "Used together with personal_applications to control how apps in the personal profile are allowed or blocked.", + "description": "Used together with personalApplications to control how apps in the personal profile are allowed or blocked.", "enum": [ "PLAY_STORE_MODE_UNSPECIFIED", - "BLACKLIST" + "BLACKLIST", + "BLOCKLIST", + "ALLOWLIST" ], "enumDescriptions": [ - "Unspecified. Default behavior is to allow all installs.", - "All Play Store apps are available, except those whose install_type is BLOCKED in personal_applications." + "Unspecified. Defaults to BLOCKLIST.", + "All Play Store apps are available for installation in the personal profile, except those whose installType is BLOCKED in personalApplications.", + "All Play Store apps are available for installation in the personal profile, except those whose installType is BLOCKED in personalApplications.", + "Only apps explicitly specified in personalApplications with installType set to AVAILABLE are allowed to be installed in the personal profile." ], "type": "string" }, @@ -2956,8 +3156,22 @@ }, "type": "array" }, + "autoDateAndTimeZone": { + "description": "Whether auto date, time, and time zone are enabled on a company-owned device. If this is set, then autoTimeRequired is ignored.", + "enum": [ + "AUTO_DATE_AND_TIME_ZONE_UNSPECIFIED", + "AUTO_DATE_AND_TIME_ZONE_USER_CHOICE", + "AUTO_DATE_AND_TIME_ZONE_ENFORCED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to AUTO_DATE_AND_TIME_ZONE_USER_CHOICE.", + "Auto date, time, and time zone are left to user's choice.", + "Enforce auto date, time, and time zone on the device." + ], + "type": "string" + }, "autoTimeRequired": { - "description": "Whether auto time is required, which prevents the user from manually setting the date and time.", + "description": "Whether auto time is required, which prevents the user from manually setting the date and time. If autoDateAndTimeZone is set, this field is ignored.", "type": "boolean" }, "blockApplicationsEnabled": { @@ -3121,20 +3335,26 @@ "description": "Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK." }, "locationMode": { - "description": "The degree of location detection enabled. The user may change the value unless the user is otherwise blocked from accessing device settings.", + "description": "The degree of location detection enabled.", "enum": [ "LOCATION_MODE_UNSPECIFIED", "HIGH_ACCURACY", "SENSORS_ONLY", "BATTERY_SAVING", - "OFF" + "OFF", + "LOCATION_USER_CHOICE", + "LOCATION_ENFORCED", + "LOCATION_DISABLED" ], "enumDescriptions": [ - "The current device value is not modified.", - "All location detection methods are enabled, including GPS, networks, and other sensors.", - "Only GPS and other sensors are enabled.", - "Only the network location provider is enabled.", - "Location detection is disabled." + "Defaults to LOCATION_USER_CHOICE.", + "On Android 8 and below, all location detection methods are enabled, including GPS, networks, and other sensors. On Android 9 and above, this is equivalent to LOCATION_ENFORCED.", + "On Android 8 and below, only GPS and other sensors are enabled. On Android 9 and above, this is equivalent to LOCATION_ENFORCED.", + "On Android 8 and below, only the network location provider is enabled. On Android 9 and above, this is equivalent to LOCATION_ENFORCED.", + "On Android 8 and below, location setting and accuracy are disabled. On Android 9 and above, this is equivalent to LOCATION_DISABLED.", + "Location setting is not restricted on the device. No specific behavior is set or enforced.", + "Enable location setting on the device.", + "Disable location setting on the device." ], "type": "string" }, @@ -3676,6 +3896,10 @@ "description": "Whether app reports are enabled.", "type": "boolean" }, + "commonCriteriaModeEnabled": { + "description": "Whether Common Criteria Mode reporting is enabled.", + "type": "boolean" + }, "deviceSettingsEnabled": { "description": "Whether device settings reporting is enabled.", "type": "boolean" @@ -3781,6 +4005,21 @@ }, "type": "object" }, + "TelephonyInfo": { + "description": "Telephony information associated with a given SIM card on the device. Only supported on fully managed devices starting from Android API level 23 and above.", + "id": "TelephonyInfo", + "properties": { + "carrierName": { + "description": "The carrier name associated with this SIM card.", + "type": "string" + }, + "phoneNumber": { + "description": "The phone number associated with this SIM card.", + "type": "string" + } + }, + "type": "object" + }, "TermsAndConditions": { "description": "A terms and conditions page to be accepted during provisioning.", "id": "TermsAndConditions",
diff --git a/discovery/googleapis/androidpublisher__v3.json b/discovery/googleapis/androidpublisher__v3.json index 0cebead..aaf2cc9 100644 --- a/discovery/googleapis/androidpublisher__v3.json +++ b/discovery/googleapis/androidpublisher__v3.json
@@ -2103,6 +2103,7 @@ "id": "androidpublisher.purchases.subscriptions.cancel", "parameterOrder": [ "packageName", + "subscriptionId", "token" ], "parameters": { @@ -2112,6 +2113,12 @@ "required": true, "type": "string" }, + "subscriptionId": { + "description": "The purchased subscription ID (for example, 'monthly001').", + "location": "path", + "required": true, + "type": "string" + }, "token": { "description": "The token provided to the user's device when the subscription was purchased.", "location": "path", @@ -2119,7 +2126,7 @@ "type": "string" } }, - "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/tokens/{token}:cancel", + "path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptions/{subscriptionId}/tokens/{token}:cancel", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] @@ -2466,7 +2473,7 @@ ], "parameters": { "packageName": { - "description": "Unique identifier of the Android app.", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -2501,7 +2508,7 @@ ], "parameters": { "packageName": { - "description": "Unique identifier of the Android app.", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -2539,7 +2546,7 @@ ], "parameters": { "packageName": { - "description": "Unique identifier of the Android app.", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -2577,7 +2584,7 @@ ], "parameters": { "packageName": { - "description": "Unique identifier of the Android app.", + "description": "Package name of the app.", "location": "path", "required": true, "type": "string" @@ -2603,7 +2610,7 @@ } } }, - "revision": "20201008", + "revision": "20210202", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Apk": { @@ -3647,7 +3654,7 @@ "type": "string" }, "paymentState": { - "description": "The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade", + "description": "The payment state of the subscription. Possible values are: 0. Payment pending 1. Payment received 2. Free trial 3. Pending deferred upgrade/downgrade Not present for canceled, expired subscriptions.", "format": "int32", "type": "integer" },
diff --git a/discovery/googleapis/apigateway__v1.json b/discovery/googleapis/apigateway__v1.json new file mode 100644 index 0000000..1982d16 --- /dev/null +++ b/discovery/googleapis/apigateway__v1.json
@@ -0,0 +1,1774 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://apigateway.googleapis.com/", + "batchPath": "batch", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/api-gateway/docs", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "apigateway:v1", + "kind": "discovery#restDescription", + "name": "apigateway", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ApigatewayListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "apis": { + "methods": { + "create": { + "description": "Creates a new Api in a given project and location.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.apis.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "apiId": { + "description": "Required. Identifier to assign to the API. Must be unique within scope of the parent resource.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the API, of the form: `projects/*/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apis", + "request": { + "$ref": "ApigatewayApi" + }, + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Api.", + "httpMethod": "DELETE", + "id": "apigateway.projects.locations.apis.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/global/apis/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Api.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.apis.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/global/apis/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayApi" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.apis.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "ApigatewayPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Apis in a given project and location.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.apis.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by parameters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the API, of the form: `projects/*/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/apis", + "response": { + "$ref": "ApigatewayListApisResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Api.", + "httpMethod": "PATCH", + "id": "apigateway.projects.locations.apis.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ApigatewayApi" + }, + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.apis.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "ApigatewaySetIamPolicyRequest" + }, + "response": { + "$ref": "ApigatewayPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.apis.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "ApigatewayTestIamPermissionsRequest" + }, + "response": { + "$ref": "ApigatewayTestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "configs": { + "methods": { + "create": { + "description": "Creates a new ApiConfig in a given project and location.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.apis.configs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "apiConfigId": { + "description": "Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the API Config, of the form: `projects/*/locations/global/apis/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/configs", + "request": { + "$ref": "ApigatewayApiConfig" + }, + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ApiConfig.", + "httpMethod": "DELETE", + "id": "apigateway.projects.locations.apis.configs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/global/apis/*/configs/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/configs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ApiConfig.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.apis.configs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/global/apis/*/configs/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/configs/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Specifies which fields of the API Config are returned in the response. Defaults to `BASIC` view.", + "enum": [ + "CONFIG_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "", + "Do not include configuration source files.", + "Include configuration source files." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayApiConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.apis.configs.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/configs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "ApigatewayPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ApiConfigs in a given project and location.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.apis.configs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by parameters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the API Config, of the form: `projects/*/locations/global/apis/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/configs", + "response": { + "$ref": "ApigatewayListApiConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single ApiConfig.", + "httpMethod": "PATCH", + "id": "apigateway.projects.locations.apis.configs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/configs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the ApiConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ApigatewayApiConfig" + }, + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.apis.configs.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/configs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "ApigatewaySetIamPolicyRequest" + }, + "response": { + "$ref": "ApigatewayPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.apis.configs.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apis/[^/]+/configs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "ApigatewayTestIamPermissionsRequest" + }, + "response": { + "$ref": "ApigatewayTestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "gateways": { + "methods": { + "create": { + "description": "Creates a new Gateway in a given project and location.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.gateways.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "gatewayId": { + "description": "Required. Identifier to assign to the Gateway. Must be unique within scope of the parent resource.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the Gateway, of the form: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/gateways", + "request": { + "$ref": "ApigatewayGateway" + }, + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Gateway.", + "httpMethod": "DELETE", + "id": "apigateway.projects.locations.gateways.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/gateways/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Gateway.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.gateways.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/gateways/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayGateway" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.gateways.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "ApigatewayPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Gateways in a given project and location.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.gateways.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by parameters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the Gateway, of the form: `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/gateways", + "response": { + "$ref": "ApigatewayListGatewaysResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Gateway.", + "httpMethod": "PATCH", + "id": "apigateway.projects.locations.gateways.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Gateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ApigatewayGateway" + }, + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.gateways.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "ApigatewaySetIamPolicyRequest" + }, + "response": { + "$ref": "ApigatewayPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.gateways.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "ApigatewayTestIamPermissionsRequest" + }, + "response": { + "$ref": "ApigatewayTestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "apigateway.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "ApigatewayCancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "apigateway.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ApigatewayOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "apigateway.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ApigatewayListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210121", + "rootUrl": "https://apigateway.googleapis.com/", + "schemas": { + "ApigatewayApi": { + "description": "An API that can be served by one or more Gateways.", + "id": "ApigatewayApi", + "properties": { + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Display name.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources", + "type": "object" + }, + "managedService": { + "description": "Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the API.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "DELETING", + "UPDATING" + ], + "enumDescriptions": [ + "API does not have a state yet.", + "API is being created.", + "API is active.", + "API creation failed.", + "API is being deleted.", + "API is being updated." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayApiConfig": { + "description": "An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.", + "id": "ApigatewayApiConfig", + "properties": { + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Display name.", + "type": "string" + }, + "gatewayServiceAccount": { + "description": "Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email (`{ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com`) or its full resource name (`projects/{PROJECT}/accounts/{UNIQUE_ID}`). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.", + "type": "string" + }, + "grpcServices": { + "description": "Optional. gRPC service definition files. If specified, openapi_documents must not be included.", + "items": { + "$ref": "ApigatewayApiConfigGrpcServiceDefinition" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources", + "type": "object" + }, + "managedServiceConfigs": { + "description": "Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using \"last one wins\" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.", + "items": { + "$ref": "ApigatewayApiConfigFile" + }, + "type": "array" + }, + "name": { + "description": "Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}", + "readOnly": true, + "type": "string" + }, + "openapiDocuments": { + "description": "Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.", + "items": { + "$ref": "ApigatewayApiConfigOpenApiDocument" + }, + "type": "array" + }, + "serviceConfigId": { + "description": "Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the API Config.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "DELETING", + "UPDATING", + "ACTIVATING" + ], + "enumDescriptions": [ + "API Config does not have a state yet.", + "API Config is being created and deployed to the API Controller.", + "API Config is ready for use by Gateways.", + "API Config creation failed.", + "API Config is being deleted.", + "API Config is being updated.", + "API Config settings are being activated in downstream systems. API Configs in this state cannot be used by Gateways." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayApiConfigFile": { + "description": "A lightweight description of a file.", + "id": "ApigatewayApiConfigFile", + "properties": { + "contents": { + "description": "The bytes that constitute the file.", + "format": "byte", + "type": "string" + }, + "path": { + "description": "The file path (full or relative path). This is typically the path of the file when it is uploaded.", + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayApiConfigGrpcServiceDefinition": { + "description": "A gRPC service definition.", + "id": "ApigatewayApiConfigGrpcServiceDefinition", + "properties": { + "fileDescriptorSet": { + "$ref": "ApigatewayApiConfigFile", + "description": "Input only. File descriptor set, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $ protoc --include_imports --include_source_info test.proto -o out.pb" + }, + "source": { + "description": "Optional. Uncompiled proto files associated with the descriptor set, used for display purposes (server-side compilation is not supported). These should match the inputs to 'protoc' command used to generate file_descriptor_set.", + "items": { + "$ref": "ApigatewayApiConfigFile" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApigatewayApiConfigOpenApiDocument": { + "description": "An OpenAPI Specification Document describing an API.", + "id": "ApigatewayApiConfigOpenApiDocument", + "properties": { + "document": { + "$ref": "ApigatewayApiConfigFile", + "description": "The OpenAPI Specification document file." + } + }, + "type": "object" + }, + "ApigatewayAuditConfig": { + "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.", + "id": "ApigatewayAuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "ApigatewayAuditLogConfig" + }, + "type": "array" + }, + "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" + }, + "ApigatewayAuditLogConfig": { + "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.", + "id": "ApigatewayAuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayBinding": { + "description": "Associates `members` with a `role`.", + "id": "ApigatewayBinding", + "properties": { + "condition": { + "$ref": "ApigatewayExpr", + "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 members 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)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayCancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "ApigatewayCancelOperationRequest", + "properties": {}, + "type": "object" + }, + "ApigatewayExpr": { + "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() < 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": "ApigatewayExpr", + "properties": { + "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" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "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" + }, + "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" + }, + "ApigatewayGateway": { + "description": "A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.", + "id": "ApigatewayGateway", + "properties": { + "apiConfig": { + "description": "Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}", + "type": "string" + }, + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultHostname": { + "description": "Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Display name.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources", + "type": "object" + }, + "name": { + "description": "Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the Gateway.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "FAILED", + "DELETING", + "UPDATING" + ], + "enumDescriptions": [ + "Gateway does not have a state yet.", + "Gateway is being created.", + "Gateway is running and ready for requests.", + "Gateway creation failed.", + "Gateway is being deleted.", + "Gateway is being updated." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayListApiConfigsResponse": { + "description": "Response message for ApiGatewayService.ListApiConfigs", + "id": "ApigatewayListApiConfigsResponse", + "properties": { + "apiConfigs": { + "description": "API Configs.", + "items": { + "$ref": "ApigatewayApiConfig" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApigatewayListApisResponse": { + "description": "Response message for ApiGatewayService.ListApis", + "id": "ApigatewayListApisResponse", + "properties": { + "apis": { + "description": "APIs.", + "items": { + "$ref": "ApigatewayApi" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApigatewayListGatewaysResponse": { + "description": "Response message for ApiGatewayService.ListGateways", + "id": "ApigatewayListGatewaysResponse", + "properties": { + "gateways": { + "description": "Gateways.", + "items": { + "$ref": "ApigatewayGateway" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApigatewayListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ApigatewayListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "ApigatewayLocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ApigatewayListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "ApigatewayOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApigatewayLocation": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "ApigatewayLocation", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "ApigatewayOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "ApigatewayStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "ApigatewayOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "ApigatewayOperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "diagnostics": { + "description": "Output only. Diagnostics generated during processing of configuration source files.", + "items": { + "$ref": "ApigatewayOperationMetadataDiagnostic" + }, + "readOnly": true, + "type": "array" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayOperationMetadataDiagnostic": { + "description": "Diagnostic information from configuration processing.", + "id": "ApigatewayOperationMetadataDiagnostic", + "properties": { + "location": { + "description": "Location of the diagnostic.", + "type": "string" + }, + "message": { + "description": "The diagnostic message.", + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayPolicy": { + "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` to a single `role`. Members 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 < 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 < 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/).", + "id": "ApigatewayPolicy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "ApigatewayAuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to 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 member.", + "items": { + "$ref": "ApigatewayBinding" + }, + "type": "array" + }, + "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" + }, + "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ApigatewaySetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "ApigatewaySetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "ApigatewayPolicy", + "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 Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "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\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "ApigatewayStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "ApigatewayTestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "ApigatewayTestIamPermissionsRequest", + "properties": { + "permissions": { + "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": "array" + } + }, + "type": "object" + }, + "ApigatewayTestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "ApigatewayTestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "API Gateway API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/apigee__v1.json b/discovery/googleapis/apigee__v1.json index da23cd3..7552a74 100644 --- a/discovery/googleapis/apigee__v1.json +++ b/discovery/googleapis/apigee__v1.json
@@ -160,6 +160,30 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "delete": { + "description": "Delete an Apigee organization. Only supported for SubscriptionType TRIAL.", + "httpMethod": "DELETE", + "id": "apigee.organizations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the profile for an Apigee organization. See [Understanding organizations](https://cloud.google.com/apigee/docs/api-platform/fundamentals/organization-structure).", "httpMethod": "GET", @@ -499,7 +523,7 @@ "apiproducts": { "methods": { "attributes": { - "description": "Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", + "description": "Updates or creates API product attributes. This API **replaces** the current list of attributes with the attributes specified in the request body. In this way, you can update existing attributes, add new attributes, or delete existing attributes by omitting them from the request body. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "httpMethod": "POST", "id": "apigee.organizations.apiproducts.attributes", "parameterOrder": [ @@ -507,7 +531,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -526,7 +550,7 @@ ] }, "create": { - "description": "Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product. *WARNING:* - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see {{what_api_product}}", + "description": "Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer grained API products, defining different sets of API resources for each API product. **WARNING:** - If you don't specify an API proxy in the request body, *any* app associated with the product can make calls to *any* API in your entire organization. - If you don't specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?", "httpMethod": "POST", "id": "apigee.organizations.apiproducts.create", "parameterOrder": [ @@ -534,7 +558,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name under which the API product will be created. Must be in the following form: organizations/organization_ID ", + "description": "Required. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -561,7 +585,7 @@ ], "parameters": { "name": { - "description": "Required. API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -585,7 +609,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -609,12 +633,12 @@ ], "parameters": { "attributename": { - "description": "The name of the attribute to search.", + "description": "Name of the attribute used to filter the search.", "location": "query", "type": "string" }, "attributevalue": { - "description": "The value of the attribute.", + "description": "Value of the attribute used to filter the search.", "location": "query", "type": "string" }, @@ -625,12 +649,12 @@ "type": "string" }, "expand": { - "description": "Set to `true` to get expanded details about each API.", + "description": "Flag that specifies whether to expand the results. Set to `true` to get expanded details about each API.", "location": "query", "type": "boolean" }, "parent": { - "description": "**Required.** The parent organization name in the following form: organizations/organization_ID ", + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -659,7 +683,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -690,7 +714,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name ", + "description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -706,7 +730,7 @@ ] }, "get": { - "description": "Returns the value of an API product attribute.", + "description": "Gets the value of an API product attribute.", "httpMethod": "GET", "id": "apigee.organizations.apiproducts.attributes.get", "parameterOrder": [ @@ -714,7 +738,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name/attributes/attribute_name ", + "description": "Required. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -730,7 +754,7 @@ ] }, "list": { - "description": "Returns a list of all API product attributes.", + "description": "Lists all API product attributes.", "httpMethod": "GET", "id": "apigee.organizations.apiproducts.attributes.list", "parameterOrder": [ @@ -738,7 +762,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent organization name. Must be in the following form: organizations/organization_ID/apiproducts/api_product_name ", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+$", "required": true, @@ -754,7 +778,7 @@ ] }, "updateApiProductAttribute": { - "description": "Updates the value of an API product attribute. Limitations are: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", + "description": "Updates the value of an API product attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.", "httpMethod": "POST", "id": "apigee.organizations.apiproducts.attributes.updateApiProductAttribute", "parameterOrder": [ @@ -762,7 +786,7 @@ ], "parameters": { "name": { - "description": "**Required.** API product name in the following form: organizations/organization_ID/apiproducts/api_product_name ", + "description": "Required. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`", "location": "path", "pattern": "^organizations/[^/]+/apiproducts/[^/]+/attributes/[^/]+$", "required": true, @@ -1214,6 +1238,158 @@ } } }, + "datacollectors": { + "methods": { + "create": { + "description": "Creates a new data collector.", + "httpMethod": "POST", + "id": "apigee.organizations.datacollectors.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "dataCollectorId": { + "description": "ID of the data collector. Overrides any ID in the data collector resource. Must begin with `dc_`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the organization in which to create the data collector in the following format: `organizations/{org}`.", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/datacollectors", + "request": { + "$ref": "GoogleCloudApigeeV1DataCollector" + }, + "response": { + "$ref": "GoogleCloudApigeeV1DataCollector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a data collector.", + "httpMethod": "DELETE", + "id": "apigee.organizations.datacollectors.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/datacollectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a data collector.", + "httpMethod": "GET", + "id": "apigee.organizations.datacollectors.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/datacollectors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1DataCollector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all data collectors.", + "httpMethod": "GET", + "id": "apigee.organizations.datacollectors.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of data collectors to return. The page size defaults to 25.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned from a previous ListDataCollectors call, that you can use to retrieve the next page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the organization for which to list data collectors in the following format: `organizations/{org}`.", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/datacollectors", + "response": { + "$ref": "GoogleCloudApigeeV1ListDataCollectorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a data collector.", + "httpMethod": "PATCH", + "id": "apigee.organizations.datacollectors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the data collector in the following format: `organizations/{org}/datacollectors/{data_collector_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/datacollectors/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "List of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1DataCollector" + }, + "response": { + "$ref": "GoogleCloudApigeeV1DataCollector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "deployments": { "methods": { "list": { @@ -1364,6 +1540,11 @@ "parent" ], "parameters": { + "app": { + "description": "Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.", + "location": "query", + "type": "string" + }, "count": { "description": "Optional. Number of developers to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.", "format": "int64", @@ -3340,7 +3521,7 @@ "keystores": { "methods": { "create": { - "description": "Creates a keystore or truststore: * Keystore: Contains certificates and their associated keys. * Truststore: Contains trusted certificates used to validate a server's certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.", + "description": "Creates a keystore or truststore. - Keystore: Contains certificates and their associated keys. - Truststore: Contains trusted certificates used to validate a server's certificate. These certificates are typically self-signed certificates or certificates that are not signed by a trusted CA.", "httpMethod": "POST", "id": "apigee.organizations.environments.keystores.create", "parameterOrder": [ @@ -3348,12 +3529,12 @@ ], "parameters": { "name": { - "description": "Optional. Overrides the value in Keystore.", + "description": "Optional. Name of the keystore. Overrides the value in Keystore.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The name of the environment in which to create the keystore. Must be of the form `organizations/{organization}/environments/{environment}`.", + "description": "Required. Name of the environment in which to create the keystore. Use the following format in your request: `organizations/{org}/environments/{env}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+$", "required": true, @@ -3380,7 +3561,7 @@ ], "parameters": { "name": { - "description": "Required. The name of keystore to delete. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", + "description": "Required. Name of the keystore. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", "required": true, @@ -3404,7 +3585,7 @@ ], "parameters": { "name": { - "description": "Required. The name of keystore. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", + "description": "Required. Name of the keystore. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", "required": true, @@ -3424,7 +3605,7 @@ "aliases": { "methods": { "create": { - "description": "Creates an alias from a key, certificate pair. The structure of the request is controlled by the `format` query parameter: * `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. The request must have `Content-Type: multipart/form-data` and include fields `keyFile` and `certFile`. If uploading to a truststore, omit `keyFile`. * `pkcs12` - A PKCS12 file is uploaded. The request must have `Content-Type: multipart/form-data` with the file provided in the only field. * `selfsignedcert` - A new private key and certificate are generated. The request must have `Content-Type: application/json` and a body of CertificateGenerationSpec.", + "description": "Creates an alias from a key/certificate pair. The structure of the request is controlled by the `format` query parameter: - `keycertfile` - Separate PEM-encoded key and certificate files are uploaded. Set `Content-Type: multipart/form-data` and include the `keyFile`, `certFile`, and `password` (if keys are encrypted) fields in the request body. If uploading to a truststore, omit `keyFile`. - `pkcs12` - A PKCS12 file is uploaded. Set `Content-Type: multipart/form-data`, provide the file in the `file` field, and include the `password` field if the file is encrypted in the request body. - `selfsignedcert` - A new private key and certificate are generated. Set `Content-Type: application/json` and include CertificateGenerationSpec in the request body.", "httpMethod": "POST", "id": "apigee.organizations.environments.keystores.aliases.create", "parameterOrder": [ @@ -3432,32 +3613,32 @@ ], "parameters": { "_password": { - "description": "The password for the private key file, if it exists.", + "description": "DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set `Content-type: multipart/form-data` part with name `password`. Password for the private key file, if required.", "location": "query", "type": "string" }, "alias": { - "description": "The alias for the key, certificate pair. Values must match regular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats except 'selfsignedcert'; self-signed certs may specify the alias in either this parameter or the JSON body.", + "description": "Alias for the key/certificate pair. Values must match the regular expression `[\\w\\s-.]{1,255}`. This must be provided for all formats except `selfsignedcert`; self-signed certs may specify the alias in either this parameter or the JSON body.", "location": "query", "type": "string" }, "format": { - "description": "Required. The format of the data. Must be either `selfsignedcert`, `keycertfile`, or `pkcs12`.", + "description": "Required. Format of the data. Valid values include: `selfsignedcert`, `keycertfile`, or `pkcs12`", "location": "query", "type": "string" }, "ignoreExpiryValidation": { - "description": "If `true`, no expiry validation will be performed.", + "description": "Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.", "location": "query", "type": "boolean" }, "ignoreNewlineValidation": { - "description": "If `true`, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.", + "description": "Flag that specifies whether to ignore newline validation. If set to `true`, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to `false`.", "location": "query", "type": "boolean" }, "parent": { - "description": "Required. The name of the keystore. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}`.", + "description": "Required. Name of the keystore. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+$", "required": true, @@ -3484,7 +3665,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3508,7 +3689,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3532,7 +3713,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3556,7 +3737,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`.", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -3580,17 +3761,17 @@ ], "parameters": { "ignoreExpiryValidation": { - "description": "Required. If `true`, no expiry validation will be performed.", + "description": "Required. Flag that specifies whether to ignore expiry validation. If set to `true`, no expiry validation will be performed.", "location": "query", "type": "boolean" }, "ignoreNewlineValidation": { - "description": "If `true`, do not throw an error when the file contains a chain with no newline between each certificate. By default, a newline is needed between each certificate in a chain.", + "description": "Flag that specifies whether to ignore newline validation. If set to `true`, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to `false`.", "location": "query", "type": "boolean" }, "name": { - "description": "Required. The name of the alias. Must be of the form `organizations/{organization}/environments/{environment}/keystores/{keystore}/aliases/{alias}`.", + "description": "Required. Name of the alias. Use the following format in your request: `organizations/{org}/environments/{env}/keystores/{keystore}/aliases/{alias}`", "location": "path", "pattern": "^organizations/[^/]+/environments/[^/]+/keystores/[^/]+/aliases/[^/]+$", "required": true, @@ -4012,7 +4193,7 @@ "resourcefiles": { "methods": { "create": { - "description": "Creates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", + "description": "Creates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).", "httpMethod": "POST", "id": "apigee.organizations.environments.resourcefiles.create", "parameterOrder": [ @@ -4049,7 +4230,7 @@ ] }, "delete": { - "description": "Deletes a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", + "description": "Deletes a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).", "httpMethod": "DELETE", "id": "apigee.organizations.environments.resourcefiles.delete", "parameterOrder": [ @@ -4087,7 +4268,7 @@ ] }, "get": { - "description": "Gets the contents of a resource file. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", + "description": "Gets the contents of a resource file. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).", "httpMethod": "GET", "id": "apigee.organizations.environments.resourcefiles.get", "parameterOrder": [ @@ -4125,7 +4306,7 @@ ] }, "list": { - "description": "Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", + "description": "Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).", "httpMethod": "GET", "id": "apigee.organizations.environments.resourcefiles.list", "parameterOrder": [ @@ -4154,7 +4335,7 @@ ] }, "listEnvironmentResources": { - "description": "Lists all resource files. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", + "description": "Lists all resource files, optionally filtering by type. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).", "httpMethod": "GET", "id": "apigee.organizations.environments.resourcefiles.listEnvironmentResources", "parameterOrder": [ @@ -4185,7 +4366,7 @@ ] }, "update": { - "description": "Updates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](/api-platform/develop/resource-files).", + "description": "Updates a resource file. Specify the `Content-Type` as `application/octet-stream` or `multipart/form-data`. For more information about resource files, see [Resource files](https://cloud.google.com/apigee/docs/api-platform/develop/resource-files).", "httpMethod": "PUT", "id": "apigee.organizations.environments.resourcefiles.update", "parameterOrder": [ @@ -4556,6 +4737,266 @@ } } }, + "hostQueries": { + "methods": { + "create": { + "description": "Submit a query at host level to be processed in the background. If the submission of the query succeeds, the API returns a 201 status and an ID that refer to the query. In addition to the HTTP status 201, the `state` of \"enqueued\" means that the request succeeded.", + "httpMethod": "POST", + "id": "apigee.organizations.hostQueries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name. Must be of the form `organizations/{org}`.", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/hostQueries", + "request": { + "$ref": "GoogleCloudApigeeV1Query" + }, + "response": { + "$ref": "GoogleCloudApigeeV1AsyncQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get status of a query submitted at host level. If the query is still in progress, the `state` is set to \"running\" After the query has completed successfully, `state` is set to \"completed\"", + "httpMethod": "GET", + "id": "apigee.organizations.hostQueries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the asynchronous query to get. Must be of the form `organizations/{org}/queries/{queryId}`.", + "location": "path", + "pattern": "^organizations/[^/]+/hostQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1AsyncQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getResult": { + "description": "After the query is completed, use this API to retrieve the results. If the request succeeds, and there is a non-zero result set, the result is downloaded to the client as a zipped JSON file. The name of the downloaded file will be: OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip`", + "httpMethod": "GET", + "id": "apigee.organizations.hostQueries.getResult", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the asynchronous query result to get. Must be of the form `organizations/{org}/queries/{queryId}/result`.", + "location": "path", + "pattern": "^organizations/[^/]+/hostQueries/[^/]+/result$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getResultView": { + "description": "", + "httpMethod": "GET", + "id": "apigee.organizations.hostQueries.getResultView", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the asynchronous query result view to get. Must be of the form `organizations/{org}/queries/{queryId}/resultView`.", + "location": "path", + "pattern": "^organizations/[^/]+/hostQueries/[^/]+/resultView$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1AsyncQueryResultView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Return a list of Asynchronous Queries at host level.", + "httpMethod": "GET", + "id": "apigee.organizations.hostQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "dataset": { + "description": "Filter response list by dataset. Example: `api`, `mint`", + "location": "query", + "type": "string" + }, + "envgroupHostname": { + "description": "Required. Filter response list by hostname.", + "location": "query", + "type": "string" + }, + "from": { + "description": "Filter response list by returning asynchronous queries that created after this date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'.", + "location": "query", + "type": "string" + }, + "inclQueriesWithoutReport": { + "description": "Flag to include asynchronous queries that don't have a report denifition.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Must be of the form `organizations/{org}`.", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + }, + "status": { + "description": "Filter response list by asynchronous query status.", + "location": "query", + "type": "string" + }, + "submittedBy": { + "description": "Filter response list by user who submitted queries.", + "location": "query", + "type": "string" + }, + "to": { + "description": "Filter response list by returning asynchronous queries that created before this date time. Time must be in ISO date-time format like '2011-12-03T10:16:30Z'.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/hostQueries", + "response": { + "$ref": "GoogleCloudApigeeV1ListAsyncQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "hostStats": { + "methods": { + "get": { + "description": "Retrieve metrics grouped by dimensions in host level. The types of metrics you can retrieve include traffic, message counts, API call latency, response size, and cache hits and counts. Dimensions let you view metrics in meaningful groups. The stats api does accept dimensions as path params. The dimensions are optional in which case the metrics are computed on the entire data for the given timerange.", + "httpMethod": "GET", + "id": "apigee.organizations.hostStats.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "accuracy": { + "description": "Legacy field: not used anymore.", + "location": "query", + "type": "string" + }, + "envgroupHostname": { + "description": "Required. The hostname for which the interactive query will be executed.", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Enables drill-down on specific dimension values.", + "location": "query", + "type": "string" + }, + "limit": { + "description": "This parameter is used to limit the number of result items. Default and the max value is 14400.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/stats/{dimensions}`. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/stats/apiproxy,request_verb`", + "location": "path", + "pattern": "^organizations/[^/]+/hostStats/.*$", + "required": true, + "type": "string" + }, + "offset": { + "description": "Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.", + "location": "query", + "type": "string" + }, + "realtime": { + "description": "Legacy field: not used anymore.", + "location": "query", + "type": "boolean" + }, + "select": { + "description": "The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)", + "location": "query", + "type": "string" + }, + "sort": { + "description": "This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.", + "location": "query", + "type": "string" + }, + "sortby": { + "description": "Comma separated list of columns to sort the final result.", + "location": "query", + "type": "string" + }, + "timeRange": { + "description": "Time interval for the interactive query. Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59", + "location": "query", + "type": "string" + }, + "timeUnit": { + "description": "A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.", + "location": "query", + "type": "string" + }, + "topk": { + "description": "Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.", + "location": "query", + "type": "string" + }, + "tsAscending": { + "description": "Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.", + "location": "query", + "type": "boolean" + }, + "tzo": { + "description": "This parameters contains the timezone offset value.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1Stats" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "instances": { "methods": { "create": { @@ -4594,7 +5035,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instance/{instance}`.", + "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`.", "location": "path", "pattern": "^organizations/[^/]+/instances/[^/]+$", "required": true, @@ -4810,6 +5251,202 @@ ] } } + }, + "canaryevaluations": { + "methods": { + "create": { + "description": "Creates a new canary evaluation for an organization.", + "httpMethod": "POST", + "id": "apigee.organizations.instances.canaryevaluations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the organization. Use the following structure in your request: `organizations/{org}/instances/{instance}`.", + "location": "path", + "pattern": "^organizations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/canaryevaluations", + "request": { + "$ref": "GoogleCloudApigeeV1CanaryEvaluation" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a CanaryEvaluation for an organization.", + "httpMethod": "GET", + "id": "apigee.organizations.instances.canaryevaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the CanaryEvaluation. Use the following structure in your request: `organizations/{org}/instances/*/canaryevaluations/{evaluation}`", + "location": "path", + "pattern": "^organizations/[^/]+/instances/[^/]+/canaryevaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1CanaryEvaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "natAddresses": { + "methods": { + "activate": { + "description": "Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. **Note:** Not supported for Apigee hybrid.", + "httpMethod": "POST", + "id": "apigee.organizations.instances.natAddresses.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``", + "location": "path", + "pattern": "^organizations/[^/]+/instances/[^/]+/natAddresses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:activate", + "request": { + "$ref": "GoogleCloudApigeeV1ActivateNatAddressRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. **Note:** Not supported for Apigee hybrid.", + "httpMethod": "POST", + "id": "apigee.organizations.instances.natAddresses.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`", + "location": "path", + "pattern": "^organizations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/natAddresses", + "request": { + "$ref": "GoogleCloudApigeeV1NatAddress" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the NAT address. Connections that are actively using the address are drained before it is removed. **Note:** Not supported for Apigee hybrid.", + "httpMethod": "DELETE", + "id": "apigee.organizations.instances.natAddresses.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``", + "location": "path", + "pattern": "^organizations/[^/]+/instances/[^/]+/natAddresses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a NAT address. **Note:** Not supported for Apigee hybrid.", + "httpMethod": "GET", + "id": "apigee.organizations.instances.natAddresses.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}`", + "location": "path", + "pattern": "^organizations/[^/]+/instances/[^/]+/natAddresses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1NatAddress" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the NAT addresses for an Apigee instance. **Note:** Not supported for Apigee hybrid.", + "httpMethod": "GET", + "id": "apigee.organizations.instances.natAddresses.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of natAddresses to return. Defaults to 25.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned from a previous ListNatAddresses call, that you can use to retrieve the next page of content.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the instance. Use the following structure in your request: `organizations/{org}/instances/{instance}`", + "location": "path", + "pattern": "^organizations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/natAddresses", + "response": { + "$ref": "GoogleCloudApigeeV1ListNatAddressesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -4936,6 +5573,104 @@ } } }, + "optimizedHostStats": { + "methods": { + "get": { + "description": "This api is similar to GetHostStats except that the response is less verbose.", + "httpMethod": "GET", + "id": "apigee.organizations.optimizedHostStats.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "accuracy": { + "description": "Legacy field: not used anymore.", + "location": "query", + "type": "string" + }, + "envgroupHostname": { + "description": "Required. The hostname for which the interactive query will be executed.", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Enables drill-down on specific dimension values.", + "location": "query", + "type": "string" + }, + "limit": { + "description": "This parameter is used to limit the number of result items. Default and the max value is 14400.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name for which the interactive query will be executed. Must be of the form `organizations/{organization_id}/stats/{dimensions}`. Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, target_host. The value of dimensions should be comma separated list as shown below `organizations/{org}/stats/apiproxy,request_verb`", + "location": "path", + "pattern": "^organizations/[^/]+/optimizedHostStats/.*$", + "required": true, + "type": "string" + }, + "offset": { + "description": "Use offset with limit to enable pagination of results. For example, to display results 11-20, set limit to '10' and offset to '10'.", + "location": "query", + "type": "string" + }, + "realtime": { + "description": "Legacy field: not used anymore.", + "location": "query", + "type": "boolean" + }, + "select": { + "description": "Required. The select parameter contains a comma separated list of metrics. E.g. sum(message_count),sum(error_count)", + "location": "query", + "type": "string" + }, + "sort": { + "description": "This parameter specifies if the sort order should be ascending or descending Supported values are DESC and ASC.", + "location": "query", + "type": "string" + }, + "sortby": { + "description": "Comma separated list of columns to sort the final result.", + "location": "query", + "type": "string" + }, + "timeRange": { + "description": "Required. Time interval for the interactive query. Time range is specified as start~end. E.g 04/15/2017 00:00~05/15/2017 23:59.", + "location": "query", + "type": "string" + }, + "timeUnit": { + "description": "A value of second, minute, hour, day, week, month. Time Unit specifies the granularity of metrics returned.", + "location": "query", + "type": "string" + }, + "topk": { + "description": "Take 'top k' results from results, for example, to return the top 5 results 'topk=5'.", + "location": "query", + "type": "string" + }, + "tsAscending": { + "description": "Lists timestamps in ascending order if set to true. Recommend setting this value to true if you are using sortby with sort=DESC.", + "location": "query", + "type": "boolean" + }, + "tzo": { + "description": "This parameters contains the timezone offset value.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1OptimizedStats" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "reports": { "methods": { "create": { @@ -5511,7 +6246,7 @@ } } }, - "revision": "20201002", + "revision": "20210122", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5598,29 +6333,35 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ActivateNatAddressRequest": { + "description": "Request for ActivateNatAddressRequest. Activate the nat address request.", + "id": "GoogleCloudApigeeV1ActivateNatAddressRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudApigeeV1Alias": { - "description": "A reference to a certificate or key, certificate pair.", + "description": "Reference to a certificate or key/certificate pair.", "id": "GoogleCloudApigeeV1Alias", "properties": { "alias": { - "description": "The resource ID for this alias. Values must match regular expression `[^/]{1,255}`.", + "description": "Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`.", "type": "string" }, "certsInfo": { "$ref": "GoogleCloudApigeeV1Certificate", - "description": "The chain of certificates under this alias." + "description": "Chain of certificates under this alias." }, "type": { - "description": "The type of alias.", + "description": "Type of alias.", "enum": [ "ALIAS_TYPE_UNSPECIFIED", "CERT", "KEY_CERT" ], "enumDescriptions": [ - "", - "", - "" + "Alias type is not specified.", + "Certificate.", + "Key/certificate pair." ], "type": "string" } @@ -5645,9 +6386,9 @@ "KEY_CERT" ], "enumDescriptions": [ - "", - "", - "" + "Alias type is not specified.", + "Certificate.", + "Key/certificate pair." ], "type": "string" } @@ -5709,18 +6450,17 @@ "id": "GoogleCloudApigeeV1ApiProduct", "properties": { "apiResources": { - "description": "Comma-separated list of API resources to be bundled in the API Product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see: - Manage API products - Managing a transaction recording policy using the API", "items": { "type": "string" }, "type": "array" }, "approvalType": { - "description": "Specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in \"pending\" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in \"approved\" state and can be used immediately. *NOTE:* Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.", + "description": "Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in \"pending\" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in \"approved\" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities.", "type": "string" }, "attributes": { - "description": "Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal but can be accessed by external developers. For monetization, you can use the attributes field to: - Specify transaction success criteria - Specify custom attributes on which you base rate plan charges.", + "description": "Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers.", "items": { "$ref": "GoogleCloudApigeeV1Attribute" }, @@ -5732,15 +6472,15 @@ "type": "string" }, "description": { - "description": "An overview of the API product. Include key information about the API product that is not captured by other fields.", + "description": "Description of the API product. Include key information about the API product that is not captured by other fields. Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products.", "type": "string" }, "displayName": { - "description": "The name to be displayed in the UI or developer portal to developers registering for API access.", + "description": "Name displayed in the UI or developer portal to developers registering for API access.", "type": "string" }, "environments": { - "description": "A comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in 'prod' from being accessed by API proxies deployed in 'test'.", + "description": "Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`.", "items": { "type": "string" }, @@ -5752,34 +6492,34 @@ "type": "string" }, "name": { - "description": "The internal name of the API Product. Characters you can use in the name are restricted to: A-Z0-9._\\-$ %. *NOTE:* The internal name cannot be edited when updating the API product.", + "description": "Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\\-$ %`. **Note:** The internal name cannot be edited when updating the API product.", "type": "string" }, "operationGroup": { "$ref": "GoogleCloudApigeeV1OperationGroup", - "description": "The operation_group enables api product creators to group Apigee proxies or remote services with resources, method types and quotas. The resource refers to the resource URI(excluding the base path). With this grouping, API product creator is able to finetune and give precise control over which REST methods have access to which resources, and how many such calls can be made (via Quota). Note that api_resources cannot be specified at both the API product level as well as within the operation_group. If configured that way, the call will fail. Please refer go/api-product-with-methods for additional details." + "description": "Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the `quota` setting). **Note:** The `api_resources` setting cannot be specified for both the API product and operation group; otherwise the call will fail." }, "proxies": { - "description": "A comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Edge rejects requests to API proxies that are not listed. *NOTE:* The API proxy names must already exist in the specified environment as they will be validated upon creation.", + "description": "Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation.", "items": { "type": "string" }, "type": "array" }, "quota": { - "description": "The number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.", + "description": "Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours.", "type": "string" }, "quotaInterval": { - "description": "The time interval over which the number of request messages is calculated.", + "description": "Time interval over which the number of request messages is calculated.", "type": "string" }, "quotaTimeUnit": { - "description": "The time unit defined for the `quotaInterval`. Valid values include minute, hour, day, or month.", + "description": "Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`.", "type": "string" }, "scopes": { - "description": "A comma-separated list of OAuth scopes that are validated at runtime. Edge validates that the scopes in any access token presented match the scopes defined in the OAuth policy assoicated with the API product.", + "description": "Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.", "items": { "type": "string" }, @@ -6063,6 +6803,10 @@ "description": "Creation time of the query.", "type": "string" }, + "envgroupHostname": { + "description": "Hostname is available only when query is executed at host level.", + "type": "string" + }, "error": { "description": "Error is set when query fails.", "type": "string" @@ -6097,7 +6841,7 @@ "type": "string" }, "self": { - "description": "Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", + "description": "Self link of the query. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd`", "type": "string" }, "state": { @@ -6119,7 +6863,37 @@ "type": "string" }, "self": { - "description": "Self link of the query results. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`", + "description": "Self link of the query results. Example: `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` or following format if query is running at host level: `/organizations/myorg/hostQueries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1AsyncQueryResultView": { + "id": "GoogleCloudApigeeV1AsyncQueryResultView", + "properties": { + "code": { + "description": "Error code when there is a failure.", + "format": "int32", + "type": "integer" + }, + "error": { + "description": "Error message when there is a failure.", + "type": "string" + }, + "metadata": { + "$ref": "GoogleCloudApigeeV1QueryMetadata", + "description": "Metadata contains information like metrics, dimenstions etc of the AsyncQuery." + }, + "rows": { + "description": "Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: \"(not set)\",…}", + "items": { + "type": "any" + }, + "type": "array" + }, + "state": { + "description": "State of retrieving ResultView.", "type": "string" } }, @@ -6153,57 +6927,148 @@ }, "type": "object" }, + "GoogleCloudApigeeV1CanaryEvaluation": { + "description": "CanaryEvaluation represents the canary analysis between two versions of the runtime that is serving requests.", + "id": "GoogleCloudApigeeV1CanaryEvaluation", + "properties": { + "control": { + "description": "Required. The stable version that is serving requests.", + "type": "string" + }, + "createTime": { + "description": "Output only. Create time of the canary evaluation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Required. End time for the evaluation's analysis.", + "format": "google-datetime", + "type": "string" + }, + "metricLabels": { + "$ref": "GoogleCloudApigeeV1CanaryEvaluationMetricLabels", + "description": "Required. Labels used to filter the metrics used for a canary evaluation." + }, + "name": { + "description": "Output only. Name of the canary evalution.", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Required. Start time for the canary evaluation's analysis.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the canary evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "SUCCEEDED" + ], + "enumDescriptions": [ + "No state has been specified.", + "The canary evaluation is still in progress.", + "The canary evaluation has finished." + ], + "readOnly": true, + "type": "string" + }, + "treatment": { + "description": "Required. The newer version that is serving requests.", + "type": "string" + }, + "verdict": { + "description": "Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL.", + "enum": [ + "VERDICT_UNSPECIFIED", + "NONE", + "FAIL", + "PASS" + ], + "enumDescriptions": [ + "Verdict is not available yet.", + "No verdict reached.", + "Evaluation is not good.", + "Evaluation is good." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1CanaryEvaluationMetricLabels": { + "description": "Labels that can be used to filter Apigee metrics.", + "id": "GoogleCloudApigeeV1CanaryEvaluationMetricLabels", + "properties": { + "env": { + "description": "The environment ID associated with the metrics.", + "type": "string" + }, + "instance_id": { + "description": "Required. The instance ID associated with the metrics. In Apigee Hybrid, the value is configured during installation.", + "type": "string" + }, + "location": { + "description": "Required. The location associated with the metrics.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1CertInfo": { - "description": "An X.509 certificate as defined in RFC 5280.", + "description": "X.509 certificate as defined in RFC 5280.", "id": "GoogleCloudApigeeV1CertInfo", "properties": { "basicConstraints": { - "description": "The X.509 basic constraints extension.", + "description": "X.509 basic constraints extension.", "type": "string" }, "expiryDate": { - "description": "The X.509 validity / notAfter in milliseconds since the epoch.", + "description": "X.509 `notAfter` validity period in milliseconds since epoch.", "format": "int64", "type": "string" }, "isValid": { - "description": "\"Yes\" if certificate is valid, \"No\" if expired and \"Not yet\" if not yet valid.", + "description": "Flag that specifies whether the certificate is valid. Flag is set to `Yes` if the certificate is valid, `No` if expired, or `Not yet` if not yet valid.", "type": "string" }, "issuer": { - "description": "The X.509 issuer.", + "description": "X.509 issuer.", "type": "string" }, "publicKey": { - "description": "The public key component of the X.509 subject public key info.", + "description": "Public key component of the X.509 subject public key info.", "type": "string" }, "serialNumber": { - "description": "The X.509 serial number.", + "description": "X.509 serial number.", "type": "string" }, "sigAlgName": { - "description": "The X.509 signatureAlgorithm.", + "description": "X.509 signatureAlgorithm.", "type": "string" }, "subject": { - "description": "The X.509 subject.", + "description": "X.509 subject.", "type": "string" }, "subjectAlternativeNames": { - "description": "The X.509 subject alternative names (SANs) extension.", + "description": "X.509 subject alternative names (SANs) extension.", "items": { "type": "string" }, "type": "array" }, "validFrom": { - "description": "The X.509 validity / notBefore in milliseconds since the epoch.", + "description": "X.509 `notBefore` validity period in milliseconds since epoch.", "format": "int64", "type": "string" }, "version": { - "description": "The X.509 version.", + "description": "X.509 version.", "format": "int32", "type": "integer" } @@ -6214,7 +7079,7 @@ "id": "GoogleCloudApigeeV1Certificate", "properties": { "certInfo": { - "description": "The chain of certificates under this name.", + "description": "Chain of certificates under this name.", "items": { "$ref": "GoogleCloudApigeeV1CertInfo" }, @@ -6436,6 +7301,53 @@ }, "type": "object" }, + "GoogleCloudApigeeV1DataCollector": { + "description": "Data collector configuration.", + "id": "GoogleCloudApigeeV1DataCollector", + "properties": { + "createdAt": { + "description": "Output only. The time at which the data collector was created in milliseconds since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "A description of the data collector.", + "type": "string" + }, + "lastModifiedAt": { + "description": "Output only. The time at which the Data Collector was last updated in milliseconds since the epoch.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "ID of the data collector. Must begin with `dc_`.", + "type": "string" + }, + "type": { + "description": "Immutable. The type of data this data collector will collect.", + "enum": [ + "TYPE_UNSPECIFIED", + "INTEGER", + "FLOAT", + "STRING", + "BOOLEAN", + "DATETIME" + ], + "enumDescriptions": [ + "For future compatibility.", + "For integer values.", + "For float values.", + "For string values.", + "For boolean values.", + "For datetime values." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1DataCollectorConfig": { "description": "Data collector and its configuration.", "id": "GoogleCloudApigeeV1DataCollectorConfig", @@ -6915,7 +7827,7 @@ "type": "string" }, "email": { - "description": "Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid.", + "description": "Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.", "type": "string" }, "firstName": { @@ -7506,7 +8418,7 @@ "type": "string" }, "diskEncryptionKeyName": { - "description": "Optional. Customer Managed Encryption Key (CMEK) used for disk & volume encryption.", + "description": "Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`", "type": "string" }, "displayName": { @@ -7591,7 +8503,7 @@ "type": "array" }, "deployedRoutes": { - "description": "The current routes deployed in the ingress routing table. A route which is missing will be shown with no destination environment.", + "description": "The current routes deployed in the ingress routing table. A route which is missing will appear in missing_routes.", "items": { "$ref": "GoogleCloudApigeeV1InstanceDeploymentStatusDeployedRoute" }, @@ -7674,11 +8586,11 @@ "type": "object" }, "GoogleCloudApigeeV1Keystore": { - "description": "A datastore for Certificates and Aliases", + "description": "Datastore for Certificates and Aliases.", "id": "GoogleCloudApigeeV1Keystore", "properties": { "aliases": { - "description": "Output only. The aliases in this keystore.", + "description": "Output only. Aliases in this keystore.", "items": { "type": "string" }, @@ -7686,7 +8598,7 @@ "type": "array" }, "name": { - "description": "Required. The resource ID for this keystore. Values must match the regular expression `[\\w[:space:]-.]{1,255}`.", + "description": "Required. Resource ID for this keystore. Values must match the regular expression `[\\w[:space:]-.]{1,255}`.", "type": "string" } }, @@ -7803,6 +8715,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListDataCollectorsResponse": { + "description": "Response for ListDataCollectors.", + "id": "GoogleCloudApigeeV1ListDataCollectorsResponse", + "properties": { + "dataCollectors": { + "description": "Data collectors in the specified organization.", + "items": { + "$ref": "GoogleCloudApigeeV1DataCollector" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Page token that you can include in a ListDataCollectors request to retrieve the next page. If omitted, no subsequent pages exist.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListDatastoresResponse": { "description": "The response for ListDatastores", "id": "GoogleCloudApigeeV1ListDatastoresResponse", @@ -7973,6 +8903,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListNatAddressesResponse": { + "description": "Response for ListNatAddresses.", + "id": "GoogleCloudApigeeV1ListNatAddressesResponse", + "properties": { + "natAddresses": { + "description": "List of NAT Addresses for the instance.", + "items": { + "$ref": "GoogleCloudApigeeV1NatAddress" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Page token that you can include in a ListNatAddresses request to retrieve the next page of content. If omitted, no subsequent pages exist.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListOfDevelopersResponse": { "id": "GoogleCloudApigeeV1ListOfDevelopersResponse", "properties": { @@ -8050,6 +8998,39 @@ }, "type": "object" }, + "GoogleCloudApigeeV1NatAddress": { + "description": "Apigee NAT(network address translation) address. A NAT address is a static external IP address used for Internet egress traffic.", + "id": "GoogleCloudApigeeV1NatAddress", + "properties": { + "ipAddress": { + "description": "Required. The static IPV4 address.", + "type": "string" + }, + "name": { + "description": "Required. Resource ID of the NAT address.", + "type": "string" + }, + "state": { + "description": "Required. State of the nat address.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "RESERVED", + "ACTIVE", + "DELETING" + ], + "enumDescriptions": [ + "The resource is in an unspecified state.", + "The NAT address is being created.", + "The NAT address is reserved but not yet used for Internet egress.", + "The NAT address is active and used for Internet egress.", + "The NAT address is being deleted." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Operation": { "description": "Operation represents the pairing of REST resource path and the actions (verbs) allowed on the resource path.", "id": "GoogleCloudApigeeV1Operation", @@ -8073,18 +9054,18 @@ "id": "GoogleCloudApigeeV1OperationConfig", "properties": { "apiSource": { - "description": "Required. api_source represents either a proxy or remote service name for which the resources, methods and quota are associated with.", + "description": "Required. API proxy or remote service name with which the resources, methods, and quota are associated.", "type": "string" }, "attributes": { - "description": "custom attribute associated with the operation.", + "description": "Custom attributes associated with the operation.", "items": { "$ref": "GoogleCloudApigeeV1Attribute" }, "type": "array" }, "operations": { - "description": "operations is the list of resource/methods pair, belonging to proxy/remote service, upon which quota will applied on. Note that currently we allow only a single operation. The call will fail if more than one is provided.", + "description": "List of resource/method pairs for the proxy/remote service, upon which quota will applied. **Note**: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.", "items": { "$ref": "GoogleCloudApigeeV1Operation" }, @@ -8092,21 +9073,21 @@ }, "quota": { "$ref": "GoogleCloudApigeeV1Quota", - "description": "Quota parameters to be enforced for the resources, methods, api_source combination. If none specified, quota enforcement will not be done." + "description": "Quota parameters to be enforced for the resources, methods, api_source combination. If none are specified, quota enforcement will not be done." } }, "type": "object" }, "GoogleCloudApigeeV1OperationGroup": { - "description": "The OperationGroup contains a list of configuration details associated with Apigee proxies or Remote services. Remote services are non-Apigee Edge proxies. eg, Istio-Envoy.", + "description": "List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy.", "id": "GoogleCloudApigeeV1OperationGroup", "properties": { "operationConfigType": { - "description": "Identfies whether the configuration is for Apigee proxy or a remote service. Possible values are \"proxy\" and \"remoteservice\". If none specified, the default is \"proxy\". \"proxy\" is used when Apigee proxies are associated with the API product. \"remoteservice\" is used when non-Apigee proxy like Envoy is used, and is associated with the API product.", + "description": "Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values are `proxy` or `remoteservice`. Defaults to `proxy`. Set to `proxy` when Apigee API proxies are associated with the API product. Set to `remoteservice` when non-Apigee proxies like Istio-Envoy are associated with the API product.", "type": "string" }, "operationConfigs": { - "description": "Required. A list of OperationConfig for either Apigee proxies or other other remote services, that are associated with this API product.", + "description": "Required. List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.", "items": { "$ref": "GoogleCloudApigeeV1OperationConfig" }, @@ -8274,6 +9255,10 @@ "$ref": "GoogleCloudApigeeV1Properties", "description": "Properties defined in the Apigee organization profile." }, + "runtimeDatabaseEncryptionKeyName": { + "description": "Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified, a Google-Managed encryption key will be used. Valid only when [RuntimeType] is CLOUD. For example: \"projects/foo/locations/us/keyRings/bar/cryptoKeys/baz\". **Note:** Not supported for Apigee hybrid.", + "type": "string" + }, "runtimeType": { "description": "Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.", "enum": [ @@ -8436,7 +9421,7 @@ "id": "GoogleCloudApigeeV1ProvisionOrganizationRequest", "properties": { "analyticsRegion": { - "description": "Primary Cloud Platform region for analytics data storage. For valid values, see [Create an organization](https://docs.apigee.com/hybrid/latest/precog-provision). Defaults to us-west1.", + "description": "Primary Cloud Platform region for analytics data storage. For valid values, see [Create an organization](https://cloud.google.com/apigee/docs/hybrid/latest/precog-provision). Defaults to `us-west1`.", "type": "string" }, "authorizedNetwork": { @@ -8444,7 +9429,7 @@ "type": "string" }, "runtimeLocation": { - "description": "Cloud Platform location for the runtime instance. Defaults to us-west1-a.", + "description": "Cloud Platform location for the runtime instance. Defaults to `us-west1-a`.", "type": "string" } }, @@ -8464,6 +9449,10 @@ }, "type": "array" }, + "envgroupHostname": { + "description": "Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.", + "type": "string" + }, "filter": { "description": "Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax", "type": "string" @@ -8571,15 +9560,15 @@ "id": "GoogleCloudApigeeV1Quota", "properties": { "interval": { - "description": "Required. The time interval over which the number of request messages is calculated.", + "description": "Required. Time interval over which the number of request messages is calculated.", "type": "string" }, "limit": { - "description": "Required. Limit represents the upper bound count allowed for the time interval and time unit specified. Requests exceeding this limit will get rejected.", + "description": "Required. Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.", "type": "string" }, "timeUnit": { - "description": "The time unit defined for the `interval`. Valid values include minute, hour, day, or month. The default value is empty. If limit and interval are valid, the default value is \"hour\".", + "description": "Time unit defined for the `interval`. Valid values include `minute`, `hour`, `day`, or `month`. If `limit` and `interval` are valid, the default value is `hour`; otherwise, the default is null.", "type": "string" } }, @@ -8826,7 +9815,7 @@ "type": "string" }, "envGroupRevision": { - "description": "The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with debug=true.", + "description": "The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.", "format": "int64", "type": "string" }, @@ -8835,11 +9824,11 @@ "type": "string" }, "receiver": { - "description": "The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with debug=true.", + "description": "The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.", "type": "string" }, "updateTime": { - "description": "The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with debug=true.", + "description": "The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.", "format": "google-datetime", "type": "string" } @@ -8921,89 +9910,38 @@ "description": "Trace configuration override for a specific API proxy in an environment." }, "uid": { - "description": "Unique ID for the configuration override. The ID will only change if the override is deleted and recreated.", + "description": "Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's \"override\" field.", "type": "string" } }, "type": "object" }, "GoogleCloudApigeeV1RuntimeTraceSamplingConfig": { - "description": "NEXT ID: 6 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.", + "description": "NEXT ID: 3 RuntimeTraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.", "id": "GoogleCloudApigeeV1RuntimeTraceSamplingConfig", "properties": { - "errorSources": { - "description": "Error sources from which to capture errors. If none are specified, error codes are captured from all sources.", - "items": { - "enum": [ - "ERROR_SOURCE_UNSPECIFIED", - "APIGEE", - "TARGET" - ], - "enumDescriptions": [ - "Error source is unspecified.", - "Only capture trace errors within the Apigee system.", - "Only capture trace errors from target server." - ], - "type": "string" - }, - "type": "array" - }, - "responseCodeRanges": { - "description": "List of response code ranges.", - "items": { - "$ref": "GoogleCloudApigeeV1RuntimeTraceSamplingConfigResponseCodeRange" - }, - "type": "array" - }, - "responseCodes": { - "description": "List of single response codes.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, "sampler": { "description": "Sampler of distributed tracing. OFF is the default value.", "enum": [ "SAMPLER_UNSPECIFIED", "OFF", - "ON", "PROBABILITY" ], "enumDescriptions": [ "Sampler unspecified.", "OFF means distributed trace is disabled, or the sampling probability is 0.", - "ON means distributed trace is enabled always for all api calls, and sampling probability is 0.5.", "PROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set." ], "type": "string" }, "samplingRate": { - "description": "Field sampling rate. This value is only valid when is only applicable when sampling value is probabilistic(PROBABILITY). The supported values are > 0 and <= 0.5.", + "description": "Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.", "format": "float", "type": "number" } }, "type": "object" }, - "GoogleCloudApigeeV1RuntimeTraceSamplingConfigResponseCodeRange": { - "description": "ResponseCodeRange represents a group of response codes to capture, from the first response code to the last response code. Each range is a close interval. For example, if an interval is [400, 403], then that means 400, 401, 402, 403 will be all captured.", - "id": "GoogleCloudApigeeV1RuntimeTraceSamplingConfigResponseCodeRange", - "properties": { - "firstResponseCode": { - "description": "The first response code to capture.", - "format": "int32", - "type": "integer" - }, - "lastResponseCode": { - "description": "The last response code to capture.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "GoogleCloudApigeeV1Schema": { "description": "Response for Schema call", "id": "GoogleCloudApigeeV1Schema", @@ -9213,6 +10151,13 @@ }, "type": "array" }, + "hosts": { + "description": "This field contains a list of query results grouped by host.", + "items": { + "$ref": "GoogleCloudApigeeV1StatsHostStats" + }, + "type": "array" + }, "metaData": { "$ref": "GoogleCloudApigeeV1Metadata", "description": "This field contains the metadata information." @@ -9244,6 +10189,31 @@ }, "type": "object" }, + "GoogleCloudApigeeV1StatsHostStats": { + "description": "This message type encapsulates the hostname wrapper: \"hosts\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.52056245E8\" ] } ], \"name\": \"example.com\" } ]", + "id": "GoogleCloudApigeeV1StatsHostStats", + "properties": { + "dimensions": { + "description": "This field contains the list of metrics grouped under dimensions.", + "items": { + "$ref": "GoogleCloudApigeeV1DimensionMetric" + }, + "type": "array" + }, + "metrics": { + "description": "In the final response, only one of the following fields will be present based on the dimensions provided. If no dimensions are provided, then only a top level metrics is provided. If dimensions are included, then there will be a top level dimensions field under hostnames which will contain metrics values and the dimension name. Example: \"hosts\": [ { \"dimensions\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.14049521E8\" ] } ], \"name\": \"nit_proxy\" } ], \"name\": \"example.com\" } ] OR \"hosts\": [ { \"metrics\": [ { \"name\": \"sum(message_count)\", \"values\": [ \"2.19026331E8\" ] } ], \"name\": \"example.com\" } ] This field contains the list of metric values.", + "items": { + "$ref": "GoogleCloudApigeeV1Metric" + }, + "type": "array" + }, + "name": { + "description": "This field contains the hostname used in query.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Subscription": { "description": "Pub/Sub subscription of an environment.", "id": "GoogleCloudApigeeV1Subscription", @@ -9259,7 +10229,7 @@ "id": "GoogleCloudApigeeV1SyncAuthorization", "properties": { "etag": { - "description": "Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.", + "description": "Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](organizations/getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](organizations/setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions.", "format": "byte", "type": "string" },
diff --git a/discovery/googleapis/appengine__v1.json b/discovery/googleapis/appengine__v1.json index fc763af..9feb34f 100644 --- a/discovery/googleapis/appengine__v1.json +++ b/discovery/googleapis/appengine__v1.json
@@ -1555,7 +1555,7 @@ } } }, - "revision": "20201003", + "revision": "20210111", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2381,6 +2381,27 @@ "readOnly": true, "type": "string" }, + "vmLiveness": { + "description": "Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.", + "enum": [ + "LIVENESS_STATE_UNSPECIFIED", + "UNKNOWN", + "HEALTHY", + "UNHEALTHY", + "DRAINING", + "TIMEOUT" + ], + "enumDescriptions": [ + "There is no liveness health check for the instance. Only applicable for instances in App Engine standard environment.", + "The health checking system is aware of the instance but its health is not known at the moment.", + "The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.", + "The instance is reachable, but does not conform to the requirements defined by the health check.", + "The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.", + "The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout." + ], + "readOnly": true, + "type": "string" + }, "vmName": { "description": "Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.", "readOnly": true,
diff --git a/discovery/googleapis/artifactregistry__v1.json b/discovery/googleapis/artifactregistry__v1.json new file mode 100644 index 0000000..0ba680d --- /dev/null +++ b/discovery/googleapis/artifactregistry__v1.json
@@ -0,0 +1,363 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://artifactregistry.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Artifact Registry", + "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/artifacts/docs/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "artifactregistry:v1", + "kind": "discovery#restDescription", + "name": "artifactregistry", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "artifactregistry.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "artifactregistry.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "artifactregistry.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "artifactregistry.operations.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + }, + "revision": "20210114", + "rootUrl": "https://artifactregistry.googleapis.com/", + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "DockerImage": { + "description": "DockerImage represents a docker artifact.", + "id": "DockerImage", + "properties": { + "imageSizeBytes": { + "description": "Calculated size of the image.", + "format": "int64", + "type": "string" + }, + "mediaType": { + "description": "Media type of this image, e.g. \"application/vnd.docker.distribution.manifest.v2+json\".", + "type": "string" + }, + "name": { + "description": "Required. registry_location, project_id, repository_name and image id forms a unique image name:`projects//locations//repository//dockerimages/`. For example, \"projects/test-project/locations/us-west4/repositories/test-repo/dockerimages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\", where \"us-west4\" is the registry_location, \"test-project\" is the project_id, \"test-repo\" is the repository_name and \"nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf\" is the image's digest.", + "type": "string" + }, + "tags": { + "description": "Tags attached to this image.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uploadTime": { + "description": "Time the image was uploaded.", + "format": "google-datetime", + "type": "string" + }, + "uri": { + "description": "Required. URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Artifact Registry API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/assuredworkloads__v1.json b/discovery/googleapis/assuredworkloads__v1.json new file mode 100644 index 0000000..cfda4fb --- /dev/null +++ b/discovery/googleapis/assuredworkloads__v1.json
@@ -0,0 +1,827 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://assuredworkloads.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Assuredworkloads", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "assuredworkloads:v1", + "kind": "discovery#restDescription", + "name": "assuredworkloads", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "organizations": { + "resources": { + "locations": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workloads": { + "methods": { + "create": { + "description": "Creates Assured Workload.", + "httpMethod": "POST", + "id": "assuredworkloads.organizations.locations.workloads.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "externalId": { + "description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workloads", + "request": { + "$ref": "GoogleCloudAssuredworkloadsV1Workload" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error.", + "httpMethod": "DELETE", + "id": "assuredworkloads.organizations.locations.workloads.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets Assured Workload associated with a CRM Node", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAssuredworkloadsV1Workload" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Assured Workloads under a CRM Node.", + "httpMethod": "GET", + "id": "assuredworkloads.organizations.locations.workloads.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workloads", + "response": { + "$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", + "httpMethod": "PATCH", + "id": "assuredworkloads.organizations.locations.workloads.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAssuredworkloadsV1Workload" + }, + "response": { + "$ref": "GoogleCloudAssuredworkloadsV1Workload" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210128", + "rootUrl": "https://assuredworkloads.googleapis.com/", + "schemas": { + "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata": { + "description": "Operation metadata to give request details of CreateWorkload.", + "id": "GoogleCloudAssuredworkloadsV1CreateWorkloadOperationMetadata", + "properties": { + "complianceRegime": { + "description": "Optional. Compliance controls that should be applied to the resources managed by the workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls" + ], + "type": "string" + }, + "createTime": { + "description": "Optional. Time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the workload.", + "type": "string" + }, + "parent": { + "description": "Optional. The parent of the workload.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse": { + "description": "Response of ListWorkloads endpoint.", + "id": "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse", + "properties": { + "nextPageToken": { + "description": "The next page token. Return empty if reached the last page.", + "type": "string" + }, + "workloads": { + "description": "List of Workloads under a given parent.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1Workload" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1Workload": { + "description": "An Workload object for managing highly regulated workloads of cloud customers.", + "id": "GoogleCloudAssuredworkloadsV1Workload", + "properties": { + "billingAccount": { + "description": "Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.", + "type": "string" + }, + "complianceRegime": { + "description": "Required. Immutable. Compliance Regime associated with this workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls" + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Immutable. The Workload creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", + "type": "string" + }, + "etag": { + "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", + "type": "string" + }, + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings", + "description": "Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels applied to the workload.", + "type": "object" + }, + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "type": "string" + }, + "provisionedResourcesParent": { + "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id} organizations/{organization_id}", + "type": "string" + }, + "resources": { + "description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings": { + "description": "Settings specific to the Key Management Service.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadKMSSettings", + "properties": { + "nextRotationTime": { + "description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo": { + "description": "Represent the resources that are children of this Workload.", + "id": "GoogleCloudAssuredworkloadsV1WorkloadResourceInfo", + "properties": { + "resourceId": { + "description": "Resource identifier. For a project this represents project_number.", + "format": "int64", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "ENCRYPTION_KEYS_PROJECT" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Consumer project.", + "Consumer project containing encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata": { + "description": "Operation metadata to give request details of CreateWorkload.", + "id": "GoogleCloudAssuredworkloadsV1beta1CreateWorkloadOperationMetadata", + "properties": { + "complianceRegime": { + "description": "Optional. Compliance controls that should be applied to the resources managed by the workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls" + ], + "type": "string" + }, + "createTime": { + "description": "Optional. Time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the workload.", + "type": "string" + }, + "parent": { + "description": "Optional. The parent of the workload.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1Workload": { + "description": "An Workload object for managing highly regulated workloads of cloud customers.", + "id": "GoogleCloudAssuredworkloadsV1beta1Workload", + "properties": { + "billingAccount": { + "description": "Required. Input only. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.", + "type": "string" + }, + "cjisSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for CJIS." + }, + "complianceRegime": { + "description": "Required. Immutable. Compliance Regime associated with this workload.", + "enum": [ + "COMPLIANCE_REGIME_UNSPECIFIED", + "IL4", + "CJIS", + "FEDRAMP_HIGH", + "FEDRAMP_MODERATE", + "US_REGIONAL_ACCESS" + ], + "enumDescriptions": [ + "Unknown compliance regime.", + "Information protection as per DoD IL4 requirements.", + "Criminal Justice Information Services (CJIS) Security policies.", + "FedRAMP High data protection controls", + "FedRAMP Moderate data protection controls", + "Assured Workloads For US Regions data protection controls" + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Immutable. The Workload creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload", + "type": "string" + }, + "etag": { + "description": "Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.", + "type": "string" + }, + "fedrampHighSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP High." + }, + "fedrampModerateSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for FedRAMP Moderate." + }, + "il4Settings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings", + "description": "Required. Input only. Immutable. Settings specific to resources needed for IL4." + }, + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Input only. Settings used to create a CMEK crypto key. When set a project with a KMS CMEK key is provisioned. This field is mandatory for a subset of Compliance Regimes." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels applied to the workload.", + "type": "object" + }, + "name": { + "description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", + "type": "string" + }, + "provisionedResourcesParent": { + "description": "Input only. The parent resource for the resources managed by this Assured Workload. May be either an organization or a folder. Must be the same or a child of the Workload parent. If not specified all resources are created under the Workload parent. Formats: folders/{folder_id} organizations/{organization_id}", + "type": "string" + }, + "resources": { + "description": "Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.", + "items": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings": { + "description": "Settings specific to resources needed for CJIS.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadCJISSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings": { + "description": "Settings specific to resources needed for FedRAMP High.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampHighSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings": { + "description": "Settings specific to resources needed for FedRAMP Moderate.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadFedrampModerateSettings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings": { + "description": "Settings specific to resources needed for IL4.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadIL4Settings", + "properties": { + "kmsSettings": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "description": "Required. Input only. Immutable. Settings used to create a CMEK crypto key." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings": { + "description": "Settings specific to the Key Management Service.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadKMSSettings", + "properties": { + "nextRotationTime": { + "description": "Required. Input only. Immutable. The time at which the Key Management Service will automatically create a new version of the crypto key and mark it as the primary.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "Required. Input only. Immutable. [next_rotation_time] will be advanced by this period when the Key Management Service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo": { + "description": "Represent the resources that are children of this Workload.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceInfo", + "properties": { + "resourceId": { + "description": "Resource identifier. For a project this represents project_number.", + "format": "int64", + "type": "string" + }, + "resourceType": { + "description": "Indicates the type of resource.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "CONSUMER_PROJECT", + "ENCRYPTION_KEYS_PROJECT" + ], + "enumDescriptions": [ + "Unknown resource type.", + "Consumer project.", + "Consumer project containing encryption keys." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Assured Workloads API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/bigquery__v2.json b/discovery/googleapis/bigquery__v2.json index 6730c6b..df291e2 100644 --- a/discovery/googleapis/bigquery__v2.json +++ b/discovery/googleapis/bigquery__v2.json
@@ -1066,6 +1066,152 @@ } } }, + "rowAccessPolicies": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists all row access policies on the specified table.", + "httpMethod": "GET", + "id": "bigquery.rowAccessPolicies.list", + "parameterOrder": [ + "projectId", + "datasetId", + "tableId" + ], + "parameters": { + "datasetId": { + "description": "Required. Dataset ID of row access policies to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID of the row access policies to list.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "tableId": { + "description": "Required. Table ID of the table to list row access policies.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "projects/{+projectId}/datasets/{+datasetId}/tables/{+tableId}/rowAccessPolicies", + "response": { + "$ref": "ListRowAccessPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "bigquery.rowAccessPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/tables/[^/]+/rowAccessPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/bigquery.readonly", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, "tabledata": { "methods": { "insertAll": { @@ -1507,7 +1653,7 @@ } } }, - "revision": "20200929", + "revision": "20210120", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2305,7 +2451,7 @@ "id": "ClusteringMetrics", "properties": { "clusters": { - "description": "[Beta] Information for all clusters.", + "description": "Information for all clusters.", "items": { "$ref": "Cluster" }, @@ -2428,6 +2574,10 @@ "description": "[Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", "type": "string" }, + "routine": { + "$ref": "RoutineReference", + "description": "[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation." + }, "specialGroup": { "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", "type": "string" @@ -2616,6 +2766,18 @@ }, "type": "object" }, + "DimensionalityReductionMetrics": { + "description": "Model evaluation metrics for dimensionality reduction models.", + "id": "DimensionalityReductionMetrics", + "properties": { + "totalExplainedVarianceRatio": { + "description": "Total percentage of variance explained by the selected principal components.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "EncryptionConfiguration": { "id": "EncryptionConfiguration", "properties": { @@ -2680,6 +2842,10 @@ "$ref": "ClusteringMetrics", "description": "Populated for clustering models." }, + "dimensionalityReductionMetrics": { + "$ref": "DimensionalityReductionMetrics", + "description": "Evaluation metrics when the model is a dimensionality reduction model, which currently includes PCA." + }, "multiClassClassificationMetrics": { "$ref": "MultiClassClassificationMetrics", "description": "Populated for multi-class classification/classifier models." @@ -2871,6 +3037,22 @@ }, "type": "object" }, + "Explanation": { + "description": "Explanation for a single feature.", + "id": "Explanation", + "properties": { + "attribution": { + "description": "Attribution of feature.", + "format": "double", + "type": "number" + }, + "featureName": { + "description": "Full name of the feature. For non-numerical features, will be formatted like .. Overall size of feature name will always be truncated to first 120 characters.", + "type": "string" + } + }, + "type": "object" + }, "Expr": { "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() < 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", @@ -2923,7 +3105,7 @@ }, "hivePartitioningOptions": { "$ref": "HivePartitioningOptions", - "description": "[Optional, Trusted Tester] Options to configure hive partitioning support." + "description": "[Optional] Options to configure hive partitioning support." }, "ignoreUnknownValues": { "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.", @@ -3074,6 +3256,24 @@ }, "type": "object" }, + "GlobalExplanation": { + "description": "Global explanations containing the top most important features after training.", + "id": "GlobalExplanation", + "properties": { + "classLabel": { + "description": "Class label for this set of global explanations. Will be empty/null for binary logistic and linear regression models. Sorted alphabetically in descending order.", + "type": "string" + }, + "explanations": { + "description": "A list of the top global explanations. Sorted by absolute value of attribution in descending order.", + "items": { + "$ref": "Explanation" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleSheetsOptions": { "id": "GoogleSheetsOptions", "properties": { @@ -3141,6 +3341,13 @@ "format": "double", "type": "number" }, + "principalComponentInfos": { + "description": "The information of the principal components.", + "items": { + "$ref": "PrincipalComponentInfo" + }, + "type": "array" + }, "trainingLoss": { "description": "Loss computed on the training data at the end of iteration.", "format": "double", @@ -3319,7 +3526,7 @@ "type": "string" }, "decimalTargetTypes": { - "description": "[Trusted Tester] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = [\"NUMERIC\", \"BIGNUMERIC\"]. Then if (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). For duplicated types in this field, only one will be considered and the rest will be ignored. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC.", + "description": "Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC ([Preview](/products/#product-launch-stages)), and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is [\"NUMERIC\", \"BIGNUMERIC\"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, [\"BIGNUMERIC\", \"NUMERIC\"] is the same as [\"NUMERIC\", \"BIGNUMERIC\"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to [\"NUMERIC\", \"STRING\"] for ORC and [\"NUMERIC\"] for the other file formats.", "items": { "type": "string" }, @@ -3347,12 +3554,16 @@ }, "hivePartitioningOptions": { "$ref": "HivePartitioningOptions", - "description": "[Optional, Trusted Tester] Options to configure hive partitioning support." + "description": "[Optional] Options to configure hive partitioning support." }, "ignoreUnknownValues": { "description": "[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names", "type": "boolean" }, + "jsonExtension": { + "description": "[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.", + "type": "string" + }, "maxBadRecords": { "description": "[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.", "format": "int32", @@ -4043,6 +4254,24 @@ }, "type": "object" }, + "ListRowAccessPoliciesResponse": { + "description": "Response message for the ListRowAccessPolicies method.", + "id": "ListRowAccessPoliciesResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of results.", + "type": "string" + }, + "rowAccessPolicies": { + "description": "Row access policies on the requested table.", + "items": { + "$ref": "RowAccessPolicy" + }, + "type": "array" + } + }, + "type": "object" + }, "LocationMetadata": { "description": "BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.", "id": "LocationMetadata", @@ -4170,12 +4399,12 @@ "Logistic regression based classification model.", "K-means clustering model.", "Matrix factorization model.", - "[Beta] DNN classifier model.", - "[Beta] An imported TensorFlow model.", - "[Beta] DNN regressor model.", - "[Beta] Boosted tree regressor model.", - "[Beta] Boosted tree classifier model.", - "[Beta] ARIMA model.", + "DNN classifier model.", + "An imported TensorFlow model.", + "DNN regressor model.", + "Boosted tree regressor model.", + "Boosted tree classifier model.", + "ARIMA model.", "[Beta] AutoML Tables regression model.", "[Beta] AutoML Tables classification model." ], @@ -4291,6 +4520,33 @@ }, "type": "object" }, + "PrincipalComponentInfo": { + "description": "Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.", + "id": "PrincipalComponentInfo", + "properties": { + "cumulativeExplainedVarianceRatio": { + "description": "The explained_variance is pre-ordered in the descending order to compute the cumulative explained variance ratio.", + "format": "double", + "type": "number" + }, + "explainedVariance": { + "description": "Explained variance by this principal component, which is simply the eigenvalue.", + "format": "double", + "type": "number" + }, + "explainedVarianceRatio": { + "description": "Explained_variance over the total explained variance.", + "format": "double", + "type": "number" + }, + "principalComponentId": { + "description": "Id of the principal component.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ProjectList": { "id": "ProjectList", "properties": { @@ -4697,7 +4953,7 @@ "type": "number" }, "rSquared": { - "description": "R^2 score.", + "description": "R^2 score. This corresponds to r2_score in ML.EVALUATE.", "format": "double", "type": "number" } @@ -4836,6 +5092,38 @@ }, "type": "object" }, + "RowAccessPolicy": { + "description": "Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.", + "id": "RowAccessPolicy", + "properties": { + "creationTime": { + "description": "Output only. The time when this row access policy was created, in milliseconds since the epoch.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Output only. A hash of this resource.", + "readOnly": true, + "type": "string" + }, + "filterPredicate": { + "description": "Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region=\"EU\" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0", + "type": "string" + }, + "lastModifiedTime": { + "description": "Output only. The time when this row access policy was last modified, in milliseconds since the epoch.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "rowAccessPolicyReference": { + "$ref": "RowAccessPolicyReference", + "description": "Required. Reference describing the ID of this row access policy." + } + }, + "type": "object" + }, "RowAccessPolicyReference": { "id": "RowAccessPolicyReference", "properties": { @@ -5175,7 +5463,7 @@ "description": "Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified." }, "type": { - "description": "[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.", + "description": "[Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.", "type": "string" }, "view": { @@ -5345,7 +5633,7 @@ "type": "object" }, "type": { - "description": "[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).", + "description": "[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).", "type": "string" } }, @@ -5554,6 +5842,7 @@ "type": "object" }, "TrainingOptions": { + "description": "Options used in model training.", "id": "TrainingOptions", "properties": { "autoArima": { @@ -5580,7 +5869,8 @@ "MONTHLY", "WEEKLY", "DAILY", - "HOURLY" + "HOURLY", + "PER_MINUTE" ], "enumDescriptions": [ "", @@ -5590,7 +5880,8 @@ "Monthly data.", "Weekly data.", "Daily data.", - "Hourly data." + "Hourly data.", + "Per-minute data." ], "type": "string" }, @@ -5852,7 +6143,7 @@ "KMEANS_PLUS_PLUS" ], "enumDescriptions": [ - "", + "Unspecified initialization method.", "Initializes the centroids randomly.", "Initializes the centroids using data specified in kmeans_initialization_column.", "Initializes with kmeans++." @@ -5931,7 +6222,7 @@ "type": "number" }, "modelUri": { - "description": "[Beta] Google Cloud Storage URI from which the model was imported. Only applicable for imported models.", + "description": "Google Cloud Storage URI from which the model was imported. Only applicable for imported models.", "type": "string" }, "nonSeasonalOrder": { @@ -6011,6 +6302,13 @@ "$ref": "EvaluationMetrics", "description": "The evaluation metrics over training/eval data that were computed at the end of training." }, + "globalExplanations": { + "description": "Global explanations for important features of the model. For multi-class models, there is one entry for each label class. For other models, there is only one entry in the list.", + "items": { + "$ref": "GlobalExplanation" + }, + "type": "array" + }, "results": { "description": "Output of each iteration run, results.size() <= max_iterations.", "items": {
diff --git a/discovery/googleapis/bigquerydatatransfer__v1.json b/discovery/googleapis/bigquerydatatransfer__v1.json index 9be01ed..9625ea2 100644 --- a/discovery/googleapis/bigquerydatatransfer__v1.json +++ b/discovery/googleapis/bigquerydatatransfer__v1.json
@@ -23,7 +23,7 @@ "canonicalName": "BigQuery Data Transfer", "description": "Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/bigquery/", + "documentationLink": "https://cloud.google.com/bigquery-transfer/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -1269,7 +1269,7 @@ } } }, - "revision": "20201002", + "revision": "20210130", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": {
diff --git a/discovery/googleapis/bigqueryreservation__v1.json b/discovery/googleapis/bigqueryreservation__v1.json index a44f243..658903c 100644 --- a/discovery/googleapis/bigqueryreservation__v1.json +++ b/discovery/googleapis/bigqueryreservation__v1.json
@@ -821,7 +821,7 @@ } } }, - "revision": "20201003", + "revision": "20210128", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": {
diff --git a/discovery/googleapis/bigtableadmin__v2.json b/discovery/googleapis/bigtableadmin__v2.json index 101caef..10f0b19 100644 --- a/discovery/googleapis/bigtableadmin__v2.json +++ b/discovery/googleapis/bigtableadmin__v2.json
@@ -1713,7 +1713,7 @@ } } }, - "revision": "20200916", + "revision": "20210121", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": {
diff --git a/discovery/googleapis_beta/billingbudgets__v1beta1.json b/discovery/googleapis/billingbudgets__v1.json similarity index 83% rename from discovery/googleapis_beta/billingbudgets__v1beta1.json rename to discovery/googleapis/billingbudgets__v1.json index c829b8b..00f278b 100644 --- a/discovery/googleapis_beta/billingbudgets__v1beta1.json +++ b/discovery/googleapis/billingbudgets__v1.json
@@ -22,7 +22,7 @@ "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "id": "billingbudgets:v1beta1", + "id": "billingbudgets:v1", "kind": "discovery#restDescription", "name": "billingbudgets", "ownerDomain": "google.com", @@ -111,7 +111,7 @@ "budgets": { "methods": { "create": { - "description": "Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.", + "description": "Creates a new budget. See [Quotas and limits](https://cloud.google.com/billing/quotas) for more information on the limits of the number of budgets you can create.", "httpMethod": "POST", "id": "billingbudgets.billingAccounts.budgets.create", "parameterOrder": [ @@ -126,12 +126,12 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/budgets", + "path": "v1/{+parent}/budgets", "request": { - "$ref": "GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest" + "$ref": "GoogleCloudBillingBudgetsV1Budget" }, "response": { - "$ref": "GoogleCloudBillingBudgetsV1beta1Budget" + "$ref": "GoogleCloudBillingBudgetsV1Budget" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", @@ -154,7 +154,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, @@ -179,9 +179,9 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudBillingBudgetsV1beta1Budget" + "$ref": "GoogleCloudBillingBudgetsV1Budget" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", @@ -215,9 +215,9 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/budgets", + "path": "v1/{+parent}/budgets", "response": { - "$ref": "GoogleCloudBillingBudgetsV1beta1ListBudgetsResponse" + "$ref": "GoogleCloudBillingBudgetsV1ListBudgetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", @@ -238,14 +238,20 @@ "pattern": "^billingAccounts/[^/]+/budgets/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided budget to update. Read-only fields (such as `name`) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol-buffers/docs/proto3#default for more details about default values.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest" + "$ref": "GoogleCloudBillingBudgetsV1Budget" }, "response": { - "$ref": "GoogleCloudBillingBudgetsV1beta1Budget" + "$ref": "GoogleCloudBillingBudgetsV1Budget" }, "scopes": [ "https://www.googleapis.com/auth/cloud-billing", @@ -257,53 +263,23 @@ } } }, - "revision": "20201003", + "revision": "20210131", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { - "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": { - "description": "AllUpdatesRule defines notifications that are sent based on budget spend and thresholds.", - "id": "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule", - "properties": { - "disableDefaultIamRecipients": { - "description": "Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.", - "type": "boolean" - }, - "monitoringNotificationChannels": { - "description": "Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.", - "items": { - "type": "string" - }, - "type": "array" - }, - "pubsubTopic": { - "description": "Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications for more details. Caller is expected to have `pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details on Pub/Sub roles and permissions.", - "type": "string" - }, - "schemaVersion": { - "description": "Optional. The schema version of the notification sent to `pubsub_topic`. Only \"1.0\" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudBillingBudgetsV1beta1Budget": { + "GoogleCloudBillingBudgetsV1Budget": { "description": "A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). Currently all plans are monthly budgets so the usage period(s) tracked are implied (calendar months of usage back-to-back).", - "id": "GoogleCloudBillingBudgetsV1beta1Budget", + "id": "GoogleCloudBillingBudgetsV1Budget", "properties": { - "allUpdatesRule": { - "$ref": "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule", - "description": "Optional. Rules to apply to notifications sent based on budget spend and thresholds." - }, "amount": { - "$ref": "GoogleCloudBillingBudgetsV1beta1BudgetAmount", + "$ref": "GoogleCloudBillingBudgetsV1BudgetAmount", "description": "Required. Budgeted amount." }, "budgetFilter": { - "$ref": "GoogleCloudBillingBudgetsV1beta1Filter", + "$ref": "GoogleCloudBillingBudgetsV1Filter", "description": "Optional. Filters that define which resources are used to compute the actual spend against the budget." }, "displayName": { - "description": "User data for display name in UI. Validation: <= 60 chars.", + "description": "User data for display name in UI. The name must be less than or equal to 60 characters.", "type": "string" }, "etag": { @@ -315,57 +291,59 @@ "readOnly": true, "type": "string" }, + "notificationsRule": { + "$ref": "GoogleCloudBillingBudgetsV1NotificationsRule", + "description": "Optional. Rules to apply to notifications sent based on budget spend and thresholds." + }, "thresholdRules": { "description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget.", "items": { - "$ref": "GoogleCloudBillingBudgetsV1beta1ThresholdRule" + "$ref": "GoogleCloudBillingBudgetsV1ThresholdRule" }, "type": "array" } }, "type": "object" }, - "GoogleCloudBillingBudgetsV1beta1BudgetAmount": { + "GoogleCloudBillingBudgetsV1BudgetAmount": { "description": "The budgeted amount for each usage period.", - "id": "GoogleCloudBillingBudgetsV1beta1BudgetAmount", + "id": "GoogleCloudBillingBudgetsV1BudgetAmount", "properties": { "lastPeriodAmount": { - "$ref": "GoogleCloudBillingBudgetsV1beta1LastPeriodAmount", + "$ref": "GoogleCloudBillingBudgetsV1LastPeriodAmount", "description": "Use the last period's actual spend as the budget for the present period." }, "specifiedAmount": { "$ref": "GoogleTypeMoney", - "description": "A specified amount to use as the budget. `currency_code` is optional. If specified, it must match the currency of the billing account. The `currency_code` is provided on output." + "description": "A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output." } }, "type": "object" }, - "GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest": { - "description": "Request for CreateBudget", - "id": "GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest", - "properties": { - "budget": { - "$ref": "GoogleCloudBillingBudgetsV1beta1Budget", - "description": "Required. Budget to create." - } - }, - "type": "object" - }, - "GoogleCloudBillingBudgetsV1beta1Filter": { + "GoogleCloudBillingBudgetsV1Filter": { "description": "A filter for a budget, limiting the scope of the cost to calculate.", - "id": "GoogleCloudBillingBudgetsV1beta1Filter", + "id": "GoogleCloudBillingBudgetsV1Filter", "properties": { + "creditTypes": { + "description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type).", + "items": { + "type": "string" + }, + "type": "array" + }, "creditTypesTreatment": { "description": "Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.", "enum": [ "CREDIT_TYPES_TREATMENT_UNSPECIFIED", "INCLUDE_ALL_CREDITS", - "EXCLUDE_ALL_CREDITS" + "EXCLUDE_ALL_CREDITS", + "INCLUDE_SPECIFIED_CREDITS" ], "enumDescriptions": [ - "", + "This is an invalid value.", "All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.", - "All types of credit are added to the net cost to determine the spend for threshold calculations." + "All types of credit are added to the net cost to determine the spend for threshold calculations.", + "Credit types specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations." ], "type": "string" }, @@ -394,7 +372,7 @@ "type": "array" }, "subaccounts": { - "description": "Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.", + "description": "Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If the field is omitted, the report will include usage from the parent account and all subaccounts, if they exist.", "items": { "type": "string" }, @@ -403,20 +381,20 @@ }, "type": "object" }, - "GoogleCloudBillingBudgetsV1beta1LastPeriodAmount": { + "GoogleCloudBillingBudgetsV1LastPeriodAmount": { "description": "Describes a budget amount targeted to last period's spend. At this time, the amount is automatically 100% of last period's spend; that is, there are no other options yet. Future configuration will be described here (for example, configuring a percentage of last period's spend).", - "id": "GoogleCloudBillingBudgetsV1beta1LastPeriodAmount", + "id": "GoogleCloudBillingBudgetsV1LastPeriodAmount", "properties": {}, "type": "object" }, - "GoogleCloudBillingBudgetsV1beta1ListBudgetsResponse": { + "GoogleCloudBillingBudgetsV1ListBudgetsResponse": { "description": "Response for ListBudgets", - "id": "GoogleCloudBillingBudgetsV1beta1ListBudgetsResponse", + "id": "GoogleCloudBillingBudgetsV1ListBudgetsResponse", "properties": { "budgets": { "description": "List of the budgets owned by the requested billing account.", "items": { - "$ref": "GoogleCloudBillingBudgetsV1beta1Budget" + "$ref": "GoogleCloudBillingBudgetsV1Budget" }, "type": "array" }, @@ -427,9 +405,35 @@ }, "type": "object" }, - "GoogleCloudBillingBudgetsV1beta1ThresholdRule": { + "GoogleCloudBillingBudgetsV1NotificationsRule": { + "description": "NotificationsRule defines notifications that are sent based on budget spend and thresholds.", + "id": "GoogleCloudBillingBudgetsV1NotificationsRule", + "properties": { + "disableDefaultIamRecipients": { + "description": "Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.", + "type": "boolean" + }, + "monitoringNotificationChannels": { + "description": "Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pubsubTopic": { + "description": "Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications for more details. Caller is expected to have `pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details on Pub/Sub roles and permissions.", + "type": "string" + }, + "schemaVersion": { + "description": "Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only \"1.0\" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBillingBudgetsV1ThresholdRule": { "description": "ThresholdRule contains a definition of a threshold which triggers an alert (a notification of a threshold being crossed) to be sent when spend goes above the specified amount. Alerts are automatically e-mailed to users with the Billing Account Administrator role or the Billing Account User role. The thresholds here have no effect on notifications sent to anything configured under `Budget.all_updates_rule`.", - "id": "GoogleCloudBillingBudgetsV1beta1ThresholdRule", + "id": "GoogleCloudBillingBudgetsV1ThresholdRule", "properties": { "spendBasis": { "description": "Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.", @@ -453,22 +457,6 @@ }, "type": "object" }, - "GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest": { - "description": "Request for UpdateBudget", - "id": "GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest", - "properties": { - "budget": { - "$ref": "GoogleCloudBillingBudgetsV1beta1Budget", - "description": "Required. The updated budget object. The budget to update is specified by the budget name in the budget." - }, - "updateMask": { - "description": "Optional. Indicates which fields in the provided budget to update. Read-only fields (such as `name`) cannot be changed. If this is not provided, then only fields with non-default values from the request are updated. See https://developers.google.com/protocol-buffers/docs/proto3#default for more details about default values.", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - }, "GoogleProtobufEmpty": { "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); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "GoogleProtobufEmpty", @@ -480,7 +468,7 @@ "id": "GoogleTypeMoney", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { @@ -499,6 +487,6 @@ }, "servicePath": "", "title": "Cloud Billing Budget API", - "version": "v1beta1", + "version": "v1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis/binaryauthorization__v1.json b/discovery/googleapis/binaryauthorization__v1.json index deb6826..f7116c9 100644 --- a/discovery/googleapis/binaryauthorization__v1.json +++ b/discovery/googleapis/binaryauthorization__v1.json
@@ -504,9 +504,37 @@ } } } + }, + "systempolicy": { + "methods": { + "getPolicy": { + "description": "Gets the current system policy in the specified location.", + "httpMethod": "GET", + "id": "binaryauthorization.systempolicy.getPolicy", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name, in the format `locations/*/policy`. Note that the system policy is not associated with a project.", + "location": "path", + "pattern": "^locations/[^/]+/policy$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } }, - "revision": "20201002", + "revision": "20210129", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { @@ -558,7 +586,7 @@ "id": "AdmissionWhitelistPattern", "properties": { "namePattern": { - "description": "An image name pattern to whitelist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part.", + "description": "An image name pattern to allowlist, in the form `registry/path/to/image`. This supports a trailing `*` as a wildcard, but this is allowed only in text after the `registry/` part.", "type": "string" } }, @@ -642,10 +670,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -799,7 +823,7 @@ "id": "Policy", "properties": { "admissionWhitelistPatterns": { - "description": "Optional. Admission policy whitelisting. A matching admission request will always be permitted. This feature is typically used to exclude Google or third-party infrastructure images from Binary Authorization policies.", + "description": "Optional. Admission policy allowlisting. A matching admission request will always be permitted. This feature is typically used to exclude Google or third-party infrastructure images from Binary Authorization policies.", "items": { "$ref": "AdmissionWhitelistPattern" }, @@ -834,6 +858,27 @@ ], "type": "string" }, + "istioServiceIdentityAdmissionRules": { + "additionalProperties": { + "$ref": "AdmissionRule" + }, + "description": "Optional. Per-istio-service-identity admission rules. Istio service identity spec format: spiffe:///ns//sa/ or /ns//sa/ e.g. spiffe://example.com/ns/test-ns/sa/default", + "type": "object" + }, + "kubernetesNamespaceAdmissionRules": { + "additionalProperties": { + "$ref": "AdmissionRule" + }, + "description": "Optional. Per-kubernetes-namespace admission rules. K8s namespace spec format: [a-z.-]+, e.g. 'some-namespace'", + "type": "object" + }, + "kubernetesServiceAccountAdmissionRules": { + "additionalProperties": { + "$ref": "AdmissionRule" + }, + "description": "Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. 'test-ns:default'", + "type": "object" + }, "name": { "description": "Output only. The resource name, in the format `projects/*/policy`. There is at most one policy per project.", "readOnly": true,
diff --git a/discovery/googleapis/blogger__v3.json b/discovery/googleapis/blogger__v3.json index 1525632..da27d27 100644 --- a/discovery/googleapis/blogger__v3.json +++ b/discovery/googleapis/blogger__v3.json
@@ -1642,7 +1642,7 @@ } } }, - "revision": "20201006", + "revision": "20210203", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": {
diff --git a/discovery/googleapis/books__v1.json b/discovery/googleapis/books__v1.json index 0b564ef..38c3ce6 100644 --- a/discovery/googleapis/books__v1.json +++ b/discovery/googleapis/books__v1.json
@@ -184,6 +184,7 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", + "minimum": "0", "type": "integer" }, "shelf": { @@ -206,6 +207,7 @@ "description": "Index of the first element to return (starts at 0)", "format": "uint32", "location": "query", + "minimum": "0", "type": "integer" }, "userId": { @@ -268,11 +270,14 @@ "description": "Remove the book and its contents", "httpMethod": "POST", "id": "books.cloudloading.deleteBook", - "parameterOrder": [], + "parameterOrder": [ + "volumeId" + ], "parameters": { "volumeId": { "description": "The id of the book to be removed.", "location": "query", + "required": true, "type": "string" } }, @@ -309,11 +314,14 @@ "description": "Returns a list of offline dictionary metadata available", "httpMethod": "GET", "id": "books.dictionary.listOfflineMetadata", - "parameterOrder": [], + "parameterOrder": [ + "cpksver" + ], "parameters": { "cpksver": { "description": "The device/version ID from which to request the data.", "location": "query", + "required": true, "type": "string" } }, @@ -470,6 +478,8 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", + "maximum": "200", + "minimum": "0", "type": "integer" }, "pageToken": { @@ -508,7 +518,8 @@ "parameterOrder": [ "volumeId", "layerId", - "annotationDataId" + "annotationDataId", + "contentVersion" ], "parameters": { "allowWebDefinitions": { @@ -525,6 +536,7 @@ "contentVersion": { "description": "The content version for the volume you are trying to retrieve.", "location": "query", + "required": true, "type": "string" }, "h": { @@ -548,6 +560,7 @@ "description": "The requested scale for the image.", "format": "int32", "location": "query", + "minimum": "0", "type": "integer" }, "source": { @@ -582,7 +595,8 @@ "id": "books.layers.annotationData.list", "parameterOrder": [ "volumeId", - "layerId" + "layerId", + "contentVersion" ], "parameters": { "annotationDataId": { @@ -594,6 +608,7 @@ "contentVersion": { "description": "The content version for the requested volume.", "location": "query", + "required": true, "type": "string" }, "h": { @@ -617,6 +632,8 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", + "maximum": "200", + "minimum": "0", "type": "integer" }, "pageToken": { @@ -628,6 +645,7 @@ "description": "The requested scale for the image.", "format": "int32", "location": "query", + "minimum": "0", "type": "integer" }, "source": { @@ -723,12 +741,14 @@ "id": "books.layers.volumeAnnotations.list", "parameterOrder": [ "volumeId", - "layerId" + "layerId", + "contentVersion" ], "parameters": { "contentVersion": { "description": "The content version for the requested volume.", "location": "query", + "required": true, "type": "string" }, "endOffset": { @@ -756,6 +776,8 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", + "maximum": "200", + "minimum": "0", "type": "integer" }, "pageToken": { @@ -843,11 +865,15 @@ "description": "Release downloaded content access restriction.", "httpMethod": "POST", "id": "books.myconfig.releaseDownloadAccess", - "parameterOrder": [], + "parameterOrder": [ + "cpksver", + "volumeIds" + ], "parameters": { "cpksver": { "description": "The device/version ID from which to release the restriction.", "location": "query", + "required": true, "type": "string" }, "locale": { @@ -864,6 +890,7 @@ "description": "The volume(s) to release restrictions for.", "location": "query", "repeated": true, + "required": true, "type": "string" } }, @@ -879,11 +906,17 @@ "description": "Request concurrent and download access restrictions.", "httpMethod": "POST", "id": "books.myconfig.requestAccess", - "parameterOrder": [], + "parameterOrder": [ + "cpksver", + "nonce", + "source", + "volumeId" + ], "parameters": { "cpksver": { "description": "The device/version ID from which to request the restrictions.", "location": "query", + "required": true, "type": "string" }, "licenseTypes": { @@ -911,16 +944,19 @@ "nonce": { "description": "The client nonce value.", "location": "query", + "required": true, "type": "string" }, "source": { "description": "String to identify the originator of this request.", "location": "query", + "required": true, "type": "string" }, "volumeId": { "description": "The volume to request concurrent/download restrictions for.", "location": "query", + "required": true, "type": "string" } }, @@ -936,11 +972,16 @@ "description": "Request downloaded content access for specified volumes on the My eBooks shelf.", "httpMethod": "POST", "id": "books.myconfig.syncVolumeLicenses", - "parameterOrder": [], + "parameterOrder": [ + "cpksver", + "nonce", + "source" + ], "parameters": { "cpksver": { "description": "The device/version ID from which to release the restriction.", "location": "query", + "required": true, "type": "string" }, "features": { @@ -970,6 +1011,7 @@ "nonce": { "description": "The client nonce value.", "location": "query", + "required": true, "type": "string" }, "showPreorders": { @@ -980,6 +1022,7 @@ "source": { "description": "String to identify the originator of this request.", "location": "query", + "required": true, "type": "string" }, "volumeIds": { @@ -1112,6 +1155,8 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", + "maximum": "40", + "minimum": "0", "type": "integer" }, "pageToken": { @@ -1157,17 +1202,22 @@ "description": "Gets the summary of specified layers.", "httpMethod": "POST", "id": "books.mylibrary.annotations.summary", - "parameterOrder": [], + "parameterOrder": [ + "layerIds", + "volumeId" + ], "parameters": { "layerIds": { "description": "Array of layer IDs to get the summary for.", "location": "query", "repeated": true, + "required": true, "type": "string" }, "volumeId": { "description": "Volume id to get the summary for.", "location": "query", + "required": true, "type": "string" } }, @@ -1219,7 +1269,8 @@ "httpMethod": "POST", "id": "books.mylibrary.bookshelves.addVolume", "parameterOrder": [ - "shelf" + "shelf", + "volumeId" ], "parameters": { "reason": { @@ -1253,6 +1304,7 @@ "volumeId": { "description": "ID of volume to add.", "location": "query", + "required": true, "type": "string" } }, @@ -1345,7 +1397,9 @@ "httpMethod": "POST", "id": "books.mylibrary.bookshelves.moveVolume", "parameterOrder": [ - "shelf" + "shelf", + "volumeId", + "volumePosition" ], "parameters": { "shelf": { @@ -1362,12 +1416,14 @@ "volumeId": { "description": "ID of volume to move.", "location": "query", + "required": true, "type": "string" }, "volumePosition": { "description": "Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)", "format": "int32", "location": "query", + "required": true, "type": "integer" } }, @@ -1384,7 +1440,8 @@ "httpMethod": "POST", "id": "books.mylibrary.bookshelves.removeVolume", "parameterOrder": [ - "shelf" + "shelf", + "volumeId" ], "parameters": { "reason": { @@ -1414,6 +1471,7 @@ "volumeId": { "description": "ID of volume to remove.", "location": "query", + "required": true, "type": "string" } }, @@ -1446,6 +1504,7 @@ "description": "Maximum number of results to return", "format": "uint32", "location": "query", + "minimum": "0", "type": "integer" }, "projection": { @@ -1488,6 +1547,7 @@ "description": "Index of the first element to return (starts at 0)", "format": "uint32", "location": "query", + "minimum": "0", "type": "integer" } }, @@ -1543,7 +1603,9 @@ "httpMethod": "POST", "id": "books.mylibrary.readingpositions.setPosition", "parameterOrder": [ - "volumeId" + "volumeId", + "position", + "timestamp" ], "parameters": { "action": { @@ -1582,6 +1644,7 @@ "position": { "description": "Position string for the new volume reading position.", "location": "query", + "required": true, "type": "string" }, "source": { @@ -1592,6 +1655,7 @@ "timestamp": { "description": "RFC 3339 UTC format timestamp associated with this reading position.", "location": "query", + "required": true, "type": "string" }, "volumeId": { @@ -1619,7 +1683,9 @@ "description": "Returns notification details for a given notification id.", "httpMethod": "GET", "id": "books.notification.get", - "parameterOrder": [], + "parameterOrder": [ + "notification_id" + ], "parameters": { "locale": { "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.", @@ -1629,6 +1695,7 @@ "notification_id": { "description": "String to identify the notification.", "location": "query", + "required": true, "type": "string" }, "source": { @@ -1926,12 +1993,15 @@ "description": "Returns Series metadata for the given series ids.", "httpMethod": "GET", "id": "books.series.get", - "parameterOrder": [], + "parameterOrder": [ + "series_id" + ], "parameters": { "series_id": { "description": "String that identifies the series", "location": "query", "repeated": true, + "required": true, "type": "string" } }, @@ -1951,7 +2021,9 @@ "description": "Returns Series membership data given the series id.", "httpMethod": "GET", "id": "books.series.membership.get", - "parameterOrder": [], + "parameterOrder": [ + "series_id" + ], "parameters": { "page_size": { "description": "Number of maximum results per page to be included in the response.", @@ -1967,6 +2039,7 @@ "series_id": { "description": "String that identifies the series", "location": "query", + "required": true, "type": "string" } }, @@ -2050,7 +2123,9 @@ "description": "Performs a book search.", "httpMethod": "GET", "id": "books.volumes.list", - "parameterOrder": [], + "parameterOrder": [ + "q" + ], "parameters": { "download": { "description": "Restrict to volumes by download availability.", @@ -2125,6 +2200,8 @@ "description": "Maximum number of results to return.", "format": "uint32", "location": "query", + "maximum": "40", + "minimum": "0", "type": "integer" }, "orderBy": { @@ -2182,6 +2259,7 @@ "q": { "description": "Full-text search query string.", "location": "query", + "required": true, "type": "string" }, "showPreorders": { @@ -2198,6 +2276,7 @@ "description": "Index of the first result to return (starts at 0)", "format": "uint32", "location": "query", + "minimum": "0", "type": "integer" } }, @@ -2330,6 +2409,8 @@ "description": "Maximum number of results to return.", "format": "uint32", "location": "query", + "maximum": "100", + "minimum": "0", "type": "integer" }, "processingState": { @@ -2359,6 +2440,7 @@ "description": "Index of the first result to return (starts at 0)", "format": "uint32", "location": "query", + "minimum": "0", "type": "integer" } }, @@ -2418,7 +2500,10 @@ "description": "Rate a recommended book for the current user.", "httpMethod": "POST", "id": "books.volumes.recommended.rate", - "parameterOrder": [], + "parameterOrder": [ + "rating", + "volumeId" + ], "parameters": { "locale": { "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.", @@ -2438,6 +2523,7 @@ "Rating indicating a negative dismissal of a volume." ], "location": "query", + "required": true, "type": "string" }, "source": { @@ -2448,6 +2534,7 @@ "volumeId": { "description": "ID of the source volume.", "location": "query", + "required": true, "type": "string" } }, @@ -2478,6 +2565,8 @@ "description": "Maximum number of results to return.", "format": "uint32", "location": "query", + "maximum": "40", + "minimum": "0", "type": "integer" }, "processingState": { @@ -2507,6 +2596,7 @@ "description": "Index of the first result to return (starts at 0)", "format": "uint32", "location": "query", + "minimum": "0", "type": "integer" }, "volumeId": { @@ -2529,7 +2619,7 @@ } } }, - "revision": "20201002", + "revision": "20210131", "rootUrl": "https://books.googleapis.com/", "schemas": { "Annotation": {
diff --git a/discovery/googleapis/calendar__v3.json b/discovery/googleapis/calendar__v3.json index bebe7df..18ab3b0 100644 --- a/discovery/googleapis/calendar__v3.json +++ b/discovery/googleapis/calendar__v3.json
@@ -12,7 +12,7 @@ "description": "View events on all your calendars" }, "https://www.googleapis.com/auth/calendar.readonly": { - "description": "View your calendars" + "description": "See and download any calendar you can access using your Google Calendar" }, "https://www.googleapis.com/auth/calendar.settings.readonly": { "description": "View your Calendar settings" @@ -27,8 +27,8 @@ "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/google-apps/calendar/firstapp", "icons": { - "x16": "http://www.google.com/images/icons/product/calendar-16.png", - "x32": "http://www.google.com/images/icons/product/calendar-32.png" + "x16": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-16dp/logo_calendar_2020q4_color_1x_web_16dp.png", + "x32": "http://fonts.gstatic.com/s/i/productlogos/calendar_2020q4/v8/web-32dp/logo_calendar_2020q4_color_1x_web_32dp.png" }, "id": "calendar:v3", "kind": "discovery#restDescription", @@ -1723,7 +1723,7 @@ } } }, - "revision": "20200918", + "revision": "20210202", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2204,7 +2204,7 @@ "id": "ConferenceSolutionKey", "properties": { "type": { - "description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for G Suite users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers", + "description": "The conference solution type.\nIf a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications.\nThe possible values are: \n- \"eventHangout\" for Hangouts for consumers (http://hangouts.google.com)\n- \"eventNamedHangout\" for classic Hangouts for Google Workspace users (http://hangouts.google.com)\n- \"hangoutsMeet\" for Google Meet (http://meet.google.com)\n- \"addOn\" for 3P conference providers", "type": "string" } }, @@ -2378,6 +2378,11 @@ "description": "ETag of the resource.", "type": "string" }, + "eventType": { + "default": "default", + "description": "Specific type of the event. Read-only. Possible values are: \n- \"default\" - A regular event or not further specified. \n- \"outOfOffice\" - An out-of-office event.", + "type": "string" + }, "extendedProperties": { "description": "Extended properties of the event.", "properties": {
diff --git a/discovery/googleapis/chat__v1.json b/discovery/googleapis/chat__v1.json index 638da45..c91c095 100644 --- a/discovery/googleapis/chat__v1.json +++ b/discovery/googleapis/chat__v1.json
@@ -3,7 +3,7 @@ "baseUrl": "https://chat.googleapis.com/", "batchPath": "batch", "canonicalName": "Hangouts Chat", - "description": "Enables bots to fetch information and perform actions in Hangouts Chat.", + "description": "Enables bots to fetch information and perform actions in Google Chat.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/hangouts/chat", "icons": { @@ -94,6 +94,103 @@ }, "protocol": "rest", "resources": { + "dms": { + "methods": { + "messages": { + "description": "Legacy path for creating message. Calling these will result in a BadRequest response.", + "httpMethod": "POST", + "id": "chat.dms.messages", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Space resource name, in the form \"spaces/*\". Example: spaces/AAAAMpdlehY", + "location": "path", + "pattern": "^dms/[^/]+$", + "required": true, + "type": "string" + }, + "threadKey": { + "description": "Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/messages", + "request": { + "$ref": "Message" + }, + "response": { + "$ref": "Message" + } + }, + "webhooks": { + "description": "Legacy path for creating message. Calling these will result in a BadRequest response.", + "httpMethod": "POST", + "id": "chat.dms.webhooks", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Space resource name, in the form \"spaces/*\". Example: spaces/AAAAMpdlehY", + "location": "path", + "pattern": "^dms/[^/]+$", + "required": true, + "type": "string" + }, + "threadKey": { + "description": "Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/webhooks", + "request": { + "$ref": "Message" + }, + "response": { + "$ref": "Message" + } + } + }, + "resources": { + "conversations": { + "methods": { + "messages": { + "description": "Legacy path for creating message. Calling these will result in a BadRequest response.", + "httpMethod": "POST", + "id": "chat.dms.conversations.messages", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Space resource name, in the form \"spaces/*\". Example: spaces/AAAAMpdlehY", + "location": "path", + "pattern": "^dms/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + }, + "threadKey": { + "description": "Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/messages", + "request": { + "$ref": "Message" + }, + "response": { + "$ref": "Message" + } + } + } + } + } + }, "media": { "methods": { "download": { @@ -120,6 +217,103 @@ } } }, + "rooms": { + "methods": { + "messages": { + "description": "Legacy path for creating message. Calling these will result in a BadRequest response.", + "httpMethod": "POST", + "id": "chat.rooms.messages", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Space resource name, in the form \"spaces/*\". Example: spaces/AAAAMpdlehY", + "location": "path", + "pattern": "^rooms/[^/]+$", + "required": true, + "type": "string" + }, + "threadKey": { + "description": "Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/messages", + "request": { + "$ref": "Message" + }, + "response": { + "$ref": "Message" + } + }, + "webhooks": { + "description": "Legacy path for creating message. Calling these will result in a BadRequest response.", + "httpMethod": "POST", + "id": "chat.rooms.webhooks", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Space resource name, in the form \"spaces/*\". Example: spaces/AAAAMpdlehY", + "location": "path", + "pattern": "^rooms/[^/]+$", + "required": true, + "type": "string" + }, + "threadKey": { + "description": "Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/webhooks", + "request": { + "$ref": "Message" + }, + "response": { + "$ref": "Message" + } + } + }, + "resources": { + "conversations": { + "methods": { + "messages": { + "description": "Legacy path for creating message. Calling these will result in a BadRequest response.", + "httpMethod": "POST", + "id": "chat.rooms.conversations.messages", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Space resource name, in the form \"spaces/*\". Example: spaces/AAAAMpdlehY", + "location": "path", + "pattern": "^rooms/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + }, + "threadKey": { + "description": "Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/messages", + "request": { + "$ref": "Message" + }, + "response": { + "$ref": "Message" + } + } + } + } + } + }, "spaces": { "methods": { "get": { @@ -165,6 +359,35 @@ "response": { "$ref": "ListSpacesResponse" } + }, + "webhooks": { + "description": "Legacy path for creating message. Calling these will result in a BadRequest response.", + "httpMethod": "POST", + "id": "chat.spaces.webhooks", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Space resource name, in the form \"spaces/*\". Example: spaces/AAAAMpdlehY", + "location": "path", + "pattern": "^spaces/[^/]+$", + "required": true, + "type": "string" + }, + "threadKey": { + "description": "Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/webhooks", + "request": { + "$ref": "Message" + }, + "response": { + "$ref": "Message" + } } }, "resources": { @@ -360,7 +583,7 @@ } } }, - "revision": "20201003", + "revision": "20210127", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -1234,6 +1457,10 @@ "description": "Obfuscated domain information.", "type": "string" }, + "isAnonymous": { + "description": "True when the user is deleted or the user's proifle is not visible.", + "type": "boolean" + }, "name": { "description": "Resource name, in the format \"users/*\".", "type": "string" @@ -1308,7 +1535,7 @@ } }, "servicePath": "", - "title": "Hangouts Chat API", + "title": "Google Chat API", "version": "v1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis/chromeuxreport__v1.json b/discovery/googleapis/chromeuxreport__v1.json new file mode 100644 index 0000000..39bbf35 --- /dev/null +++ b/discovery/googleapis/chromeuxreport__v1.json
@@ -0,0 +1,298 @@ +{ + "basePath": "", + "baseUrl": "https://chromeuxreport.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Chrome UX Report", + "description": "The Chrome UX Report API lets you view real user experience data for millions of websites. ", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/web/tools/chrome-user-experience-report/api/reference", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "chromeuxreport:v1", + "kind": "discovery#restDescription", + "name": "chromeuxreport", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "records": { + "methods": { + "queryRecord": { + "description": "Queries the Chrome User Experience for a single `record` for a given site. Returns a `record` that contains one or more `metrics` corresponding to performance data about the requested site.", + "httpMethod": "POST", + "id": "chromeuxreport.records.queryRecord", + "parameterOrder": [], + "parameters": {}, + "path": "v1/records:queryRecord", + "request": { + "$ref": "QueryRequest" + }, + "response": { + "$ref": "QueryResponse" + } + } + } + } + }, + "revision": "20210202", + "rootUrl": "https://chromeuxreport.googleapis.com/", + "schemas": { + "Bin": { + "description": "A bin is a discrete portion of data spanning from start to end, or if no end is given, then from start to +inf. A bin's start and end values are given in the value type of the metric it represents. For example, \"first contentful paint\" is measured in milliseconds and exposed as ints, therefore its metric bins will use int32s for its start and end types. However, \"cumulative layout shift\" is measured in unitless decimals and is exposed as a decimal encoded as a string, therefore its metric bins will use strings for its value type.", + "id": "Bin", + "properties": { + "density": { + "description": "The proportion of users that experienced this bin's value for the given metric.", + "format": "double", + "type": "number" + }, + "end": { + "description": "End is the end of the data bin. If end is not populated, then the bin has no end and is valid from start to +inf.", + "type": "any" + }, + "start": { + "description": "Start is the beginning of the data bin.", + "type": "any" + } + }, + "type": "object" + }, + "Key": { + "description": "Key defines all the dimensions that identify this record as unique.", + "id": "Key", + "properties": { + "effectiveConnectionType": { + "description": "The effective connection type is the general connection class that all users experienced for this record. This field uses the values [\"offline\", \"slow-2G\", \"2G\", \"3G\", \"4G\"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types If the effective connection type is unspecified, then aggregated data over all effective connection types will be returned.", + "type": "string" + }, + "formFactor": { + "description": "The form factor is the device class that all users used to access the site for this record. If the form factor is unspecified, then aggregated data over all form factors will be returned.", + "enum": [ + "ALL_FORM_FACTORS", + "PHONE", + "DESKTOP", + "TABLET" + ], + "enumDescriptions": [ + "The default value, representing all device classes.", + "The device class representing a \"mobile\"/\"phone\" sized client.", + "The device class representing a \"desktop\"/\"laptop\" type full size client.", + "The device class representing a \"tablet\" type client." + ], + "type": "string" + }, + "origin": { + "description": "Origin specifies the origin that this record is for. Note: When specifying an origin, data for loads under this origin over all pages are aggregated into origin level user experience data.", + "type": "string" + }, + "url": { + "description": "Url specifies a specific url that this record is for. Note: When specifying a \"url\" only data for that specific url will be aggregated.", + "type": "string" + } + }, + "type": "object" + }, + "Metric": { + "description": "A `metric` is a set of user experience data for a single web performance metric, like \"first contentful paint\". It contains a summary histogram of real world Chrome usage as a series of `bins`.", + "id": "Metric", + "properties": { + "histogram": { + "description": "The histogram of user experiences for a metric. The histogram will have at least one bin and the densities of all bins will add up to ~1.", + "items": { + "$ref": "Bin" + }, + "type": "array" + }, + "percentiles": { + "$ref": "Percentiles", + "description": "Common useful percentiles of the Metric. The value type for the percentiles will be the same as the value types given for the Histogram bins." + } + }, + "type": "object" + }, + "Percentiles": { + "description": "Percentiles contains synthetic values of a metric at a given statistical percentile. These are used for estimating a metric's value as experienced by a percentage of users out of the total number of users.", + "id": "Percentiles", + "properties": { + "p75": { + "description": "75% of users experienced the given metric at or below this value.", + "type": "any" + } + }, + "type": "object" + }, + "QueryRequest": { + "description": "Request payload sent by a physical web client. This request includes all necessary context to load a particular user experience record.", + "id": "QueryRequest", + "properties": { + "effectiveConnectionType": { + "description": "The effective connection type is a query dimension that specifies the effective network class that the record's data should belong to. This field uses the values [\"offline\", \"slow-2G\", \"2G\", \"3G\", \"4G\"] as specified in: https://wicg.github.io/netinfo/#effective-connection-types Note: If no effective connection type is specified, then a special record with aggregated data over all effective connection types will be returned.", + "type": "string" + }, + "formFactor": { + "description": "The form factor is a query dimension that specifies the device class that the record's data should belong to. Note: If no form factor is specified, then a special record with aggregated data over all form factors will be returned.", + "enum": [ + "ALL_FORM_FACTORS", + "PHONE", + "DESKTOP", + "TABLET" + ], + "enumDescriptions": [ + "The default value, representing all device classes.", + "The device class representing a \"mobile\"/\"phone\" sized client.", + "The device class representing a \"desktop\"/\"laptop\" type full size client.", + "The device class representing a \"tablet\" type client." + ], + "type": "string" + }, + "metrics": { + "description": "The metrics that should be included in the response. If none are specified then any metrics found will be returned. Allowed values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\"]", + "items": { + "type": "string" + }, + "type": "array" + }, + "origin": { + "description": "The url pattern \"origin\" refers to a url pattern that is the origin of a website. Examples: \"https://example.com\", \"https://cloud.google.com\"", + "type": "string" + }, + "url": { + "description": "The url pattern \"url\" refers to a url pattern that is any arbitrary url. Examples: \"https://example.com/\", \"https://cloud.google.com/why-google-cloud/\"", + "type": "string" + } + }, + "type": "object" + }, + "QueryResponse": { + "description": "Response payload sent back to a physical web client. This response contains the record found based on the identiers present in a `QueryRequest`. The returned response will have a record, and sometimes details on normalization actions taken on the request that were necessary to make the request successful.", + "id": "QueryResponse", + "properties": { + "record": { + "$ref": "Record", + "description": "The record that was found." + }, + "urlNormalizationDetails": { + "$ref": "UrlNormalization", + "description": "These are details about automated normalization actions that were taken in order to make the requested `url_pattern` valid." + } + }, + "type": "object" + }, + "Record": { + "description": "Record is a single Chrome UX report data record. It contains use experience statistics for a single url pattern and set of dimensions.", + "id": "Record", + "properties": { + "key": { + "$ref": "Key", + "description": "Key defines all of the unique querying parameters needed to look up a user experience record." + }, + "metrics": { + "additionalProperties": { + "$ref": "Metric" + }, + "description": "Metrics is the map of user experience data available for the record defined in the key field. Metrics are keyed on the metric name. Allowed key values: [\"first_contentful_paint\", \"first_input_delay\", \"largest_contentful_paint\", \"cumulative_layout_shift\"]", + "type": "object" + } + }, + "type": "object" + }, + "UrlNormalization": { + "description": "Object representing the normalization actions taken to normalize a url to achieve a higher chance of successful lookup. These are simple automated changes that are taken when looking up the provided `url_patten` would be known to fail. Complex actions like following redirects are not handled.", + "id": "UrlNormalization", + "properties": { + "normalizedUrl": { + "description": "The URL after any normalization actions. This is a valid user experience URL that could reasonably be looked up.", + "type": "string" + }, + "originalUrl": { + "description": "The original requested URL prior to any normalization actions.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Chrome UX Report API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/civicinfo__v2.json b/discovery/googleapis/civicinfo__v2.json index c66a791..c746255 100644 --- a/discovery/googleapis/civicinfo__v2.json +++ b/discovery/googleapis/civicinfo__v2.json
@@ -342,7 +342,7 @@ } } }, - "revision": "20201007", + "revision": "20210108", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { @@ -353,10 +353,6 @@ "$ref": "AdministrativeBody", "description": "The election administration body for this area." }, - "id": { - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.", - "type": "string" - }, "local_jurisdiction": { "$ref": "AdministrationRegion", "description": "The city or county that provides election information for this voter. This object can have the same elements as state." @@ -534,10 +530,6 @@ "description": "A description of any additional eligibility requirements for voting in this contest.", "type": "string" }, - "id": { - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.", - "type": "string" - }, "level": { "description": "The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at \"locality\" level, but also effectively at both \"administrative-area-2\" and \"administrative-area-1\".", "items": { @@ -1031,10 +1023,6 @@ "description": "The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.", "type": "string" }, - "id": { - "description": "An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.", - "type": "string" - }, "latitude": { "description": "Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.", "format": "double",
diff --git a/discovery/googleapis/classroom__v1.json b/discovery/googleapis/classroom__v1.json index 06cc2cd..cd04234 100644 --- a/discovery/googleapis/classroom__v1.json +++ b/discovery/googleapis/classroom__v1.json
@@ -9,13 +9,13 @@ "description": "View announcements in Google Classroom" }, "https://www.googleapis.com/auth/classroom.courses": { - "description": "Manage your Google Classroom classes" + "description": "See, edit, create, and permanently delete your Google Classroom classes" }, "https://www.googleapis.com/auth/classroom.courses.readonly": { "description": "View your Google Classroom classes" }, "https://www.googleapis.com/auth/classroom.coursework.me": { - "description": "Manage your course work and view your grades in Google Classroom" + "description": "See, create and edit coursework items including assignments, questions, and grades" }, "https://www.googleapis.com/auth/classroom.coursework.me.readonly": { "description": "View your course work and grades in Google Classroom" @@ -2337,7 +2337,7 @@ } } }, - "revision": "20201006", + "revision": "20210201", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "Announcement": { @@ -2894,21 +2894,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" }
diff --git a/discovery/googleapis/cloudasset__v1.json b/discovery/googleapis/cloudasset__v1.json index 6a5605a..f95f301 100644 --- a/discovery/googleapis/cloudasset__v1.json +++ b/discovery/googleapis/cloudasset__v1.json
@@ -263,6 +263,115 @@ }, "v1": { "methods": { + "analyzeIamPolicy": { + "description": "Analyzes IAM policies to answer which identities have what accesses on which resources.", + "httpMethod": "GET", + "id": "cloudasset.analyzeIamPolicy", + "parameterOrder": [ + "scope" + ], + "parameters": { + "analysisQuery.accessSelector.permissions": { + "description": "Optional. The permissions to appear in result.", + "location": "query", + "repeated": true, + "type": "string" + }, + "analysisQuery.accessSelector.roles": { + "description": "Optional. The roles to appear in result.", + "location": "query", + "repeated": true, + "type": "string" + }, + "analysisQuery.identitySelector.identity": { + "description": "Required. The identity appear in the form of members in [IAM policy binding](https://cloud.google.com/iam/reference/rest/v1/Binding). The examples of supported forms are: \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\". Notice that wildcard characters (such as * and ?) are not supported. You must give a specific identity.", + "location": "query", + "type": "string" + }, + "analysisQuery.options.analyzeServiceAccountImpersonation": { + "description": "Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. We highly recommend you use AssetService.AnalyzeIamPolicyLongrunning rpc instead. For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another example, if the request analyzes for who has permission P to a GCP folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Default is false.", + "location": "query", + "type": "boolean" + }, + "analysisQuery.options.expandGroups": { + "description": "Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If IamPolicyAnalysisQuery.identity_selector is specified, the identity in the result will be determined by the selector, and this flag is not allowed to set. Default is false.", + "location": "query", + "type": "boolean" + }, + "analysisQuery.options.expandResources": { + "description": "Optional. If true and IamPolicyAnalysisQuery.resource_selector is not specified, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy. For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P. If true and IamPolicyAnalysisQuery.resource_selector is specified, the resource section of the result will expand the specified resource to include resources lower in the resource hierarchy. Only project or lower resources are supported. Folder and organization resource cannot be used together with this option. For example, if the request analyzes for which users have permission P on a GCP project with this option enabled, the results will include all users who have permission P on that project or any lower resource. Default is false.", + "location": "query", + "type": "boolean" + }, + "analysisQuery.options.expandRoles": { + "description": "Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If IamPolicyAnalysisQuery.access_selector is specified, the access section of the result will be determined by the selector, and this flag is not allowed to set. Default is false.", + "location": "query", + "type": "boolean" + }, + "analysisQuery.options.outputGroupEdges": { + "description": "Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false.", + "location": "query", + "type": "boolean" + }, + "analysisQuery.options.outputResourceEdges": { + "description": "Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false.", + "location": "query", + "type": "boolean" + }, + "analysisQuery.resourceSelector.fullResourceName": { + "description": "Required. The [full resource name] (https://cloud.google.com/asset-inventory/docs/resource-name-format) of a resource of [supported resource types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#analyzable_asset_types).", + "location": "query", + "type": "string" + }, + "executionTimeout": { + "description": "Optional. Amount of time executable has to complete. See JSON representation of [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json). If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "scope": { + "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + "location": "path", + "pattern": "^[^/]+/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+scope}:analyzeIamPolicy", + "response": { + "$ref": "AnalyzeIamPolicyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "analyzeIamPolicyLongrunning": { + "description": "Analyzes IAM policies asynchronously to answer which identities have what accesses on which resources, and writes the analysis results to a Google Cloud Storage or a BigQuery destination. For Cloud Storage destination, the output format is the JSON format that represents a AnalyzeIamPolicyResponse. This method implements the google.longrunning.Operation, which allows you to track the operation status. We recommend intervals of at least 2 seconds with exponential backoff retry to poll the operation result. The metadata contains the request to help callers to map responses to requests.", + "httpMethod": "POST", + "id": "cloudasset.analyzeIamPolicyLongrunning", + "parameterOrder": [ + "scope" + ], + "parameters": { + "scope": { + "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + "location": "path", + "pattern": "^[^/]+/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+scope}:analyzeIamPolicyLongrunning", + "request": { + "$ref": "AnalyzeIamPolicyLongrunningRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "batchGetAssetsHistory": { "description": "Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.", "httpMethod": "GET", @@ -284,14 +393,16 @@ "RESOURCE", "IAM_POLICY", "ORG_POLICY", - "ACCESS_POLICY" + "ACCESS_POLICY", + "OS_INVENTORY" ], "enumDescriptions": [ "Unspecified content type.", "Resource metadata.", "The actual IAM policy set on a resource.", "The Cloud Organization Policy set on an asset.", - "The Cloud Access context manager Policy set on an asset." + "The Cloud Access context manager Policy set on an asset.", + "The runtime OS Inventory information." ], "location": "query", "type": "string" @@ -371,7 +482,7 @@ "type": "string" }, "query": { - "description": "Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies#how_to_construct_a_query) for more information. If not specified or empty, it will search all the IAM policies within the specified `scope`. Examples: * `policy:amy@gmail.com` to find IAM policy bindings that specify user \"amy@gmail.com\". * `policy:roles/compute.admin` to find IAM policy bindings that specify the Compute Admin role. * `policy.role.permissions:storage.buckets.update` to find IAM policy bindings that specify a role containing \"storage.buckets.update\" permission. Note that if callers don't have `iam.roles.get` access to a role's included permissions, policy bindings that specify this role will be dropped from the search results. * `resource:organizations/123456` to find IAM policy bindings that are set on \"organizations/123456\". * `Important` to find IAM policy bindings that contain \"Important\" as a word in any of the searchable fields (except for the included permissions). * `*por*` to find IAM policy bindings that contain \"por\" as a substring in any of the searchable fields (except for the included permissions). * `resource:(instance1 OR instance2) policy:amy` to find IAM policy bindings that are set on resources \"instance1\" or \"instance2\" and also specify user \"amy\".", + "description": "Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-iam-policies#how_to_construct_a_query) for more information. If not specified or empty, it will search all the IAM policies within the specified `scope`. Note that the query string is compared against each Cloud IAM policy binding, including its members, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see [IAM policy doc](https://cloud.google.com/iam/docs/policies#structure). Examples: * `policy:amy@gmail.com` to find IAM policy bindings that specify user \"amy@gmail.com\". * `policy:roles/compute.admin` to find IAM policy bindings that specify the Compute Admin role. * `policy:comp*` to find IAM policy bindings that contain \"comp\" as a prefix of any word in the binding. * `policy.role.permissions:storage.buckets.update` to find IAM policy bindings that specify a role containing \"storage.buckets.update\" permission. Note that if callers don't have `iam.roles.get` access to a role's included permissions, policy bindings that specify this role will be dropped from the search results. * `policy.role.permissions:upd*` to find IAM policy bindings that specify a role containing \"upd\" as a prefix of any word in the role permission. Note that if callers don't have `iam.roles.get` access to a role's included permissions, policy bindings that specify this role will be dropped from the search results. * `resource:organizations/123456` to find IAM policy bindings that are set on \"organizations/123456\". * `resource=//cloudresourcemanager.googleapis.com/projects/myproject` to find IAM policy bindings that are set on the project named \"myproject\". * `Important` to find IAM policy bindings that contain \"Important\" as a word in any of the searchable fields (except for the included permissions). * `resource:(instance1 OR instance2) policy:amy` to find IAM policy bindings that are set on resources \"instance1\" or \"instance2\" and also specify user \"amy\".", "location": "query", "type": "string" }, @@ -400,7 +511,7 @@ ], "parameters": { "assetTypes": { - "description": "Optional. A list of asset types that this request searches for. If empty, it will search all the [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types).", + "description": "Optional. A list of asset types that this request searches for. If empty, it will search all the [searchable asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types). Regular expressions are also supported. For example: * \"compute.googleapis.com.*\" snapshots resources whose asset type starts with \"compute.googleapis.com\". * \".*Instance\" snapshots resources whose asset type ends with \"Instance\". * \".*Instance.*\" snapshots resources whose asset type contains \"Instance\". See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular expression syntax. If the regular expression does not match any supported asset type, an INVALID_ARGUMENT error will be returned.", "location": "query", "repeated": true, "type": "string" @@ -422,7 +533,7 @@ "type": "string" }, "query": { - "description": "Optional. The query statement. See [how to construct a query](http://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Note that the query string is compared against each Cloud IAM policy binding, including its members, roles, and Cloud IAM conditions. The returned Cloud IAM policies will only contain the bindings that match your query. To learn more about the IAM policy structure, see [IAM policy doc](https://cloud.google.com/iam/docs/policies#structure). Examples: * `name:Important` to find Cloud resources whose name contains \"Important\" as a word. * `displayName:Impor*` to find Cloud resources whose display name contains \"Impor\" as a prefix. * `description:*por*` to find Cloud resources whose description contains \"por\" as a substring. * `location:us-west*` to find Cloud resources whose location is prefixed with \"us-west\". * `labels:prod` to find Cloud resources whose labels contain \"prod\" as a key or value. * `labels.env:prod` to find Cloud resources that have a label \"env\" and its value is \"prod\". * `labels.env:*` to find Cloud resources that have a label \"env\". * `Important` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields. * `Impor*` to find Cloud resources that contain \"Impor\" as a prefix in any of the searchable fields. * `*por*` to find Cloud resources that contain \"por\" as a substring in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields and are also located in the \"us-west1\" region or the \"global\" location.", + "description": "Optional. The query statement. See [how to construct a query](http://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Cloud resources whose name contains \"Important\" as a word. * `name=Important` to find the Cloud resource whose name is exactly \"Important\". * `displayName:Impor*` to find Cloud resources whose display name contains \"Impor\" as a prefix of any word in the field. * `location:us-west*` to find Cloud resources whose location contains both \"us\" and \"west\" as prefixes. * `labels:prod` to find Cloud resources whose labels contain \"prod\" as a key or value. * `labels.env:prod` to find Cloud resources that have a label \"env\" and its value is \"prod\". * `labels.env:*` to find Cloud resources that have a label \"env\". * `Important` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields. * `Impor*` to find Cloud resources that contain \"Impor\" as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Cloud resources that contain \"Important\" as a word in any of the searchable fields and are also located in the \"us-west1\" region or the \"global\" location.", "location": "query", "type": "string" }, @@ -445,9 +556,67 @@ } } }, - "revision": "20201003", + "revision": "20210122", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { + "AccessSelector": { + "description": "Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include roles or permissions matching any of them. The total number of roles and permissions should be equal or less than 10.", + "id": "AccessSelector", + "properties": { + "permissions": { + "description": "Optional. The permissions to appear in result.", + "items": { + "type": "string" + }, + "type": "array" + }, + "roles": { + "description": "Optional. The roles to appear in result.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AnalyzeIamPolicyLongrunningRequest": { + "description": "A request message for AssetService.AnalyzeIamPolicyLongrunning.", + "id": "AnalyzeIamPolicyLongrunningRequest", + "properties": { + "analysisQuery": { + "$ref": "IamPolicyAnalysisQuery", + "description": "Required. The request query." + }, + "outputConfig": { + "$ref": "IamPolicyAnalysisOutputConfig", + "description": "Required. Output configuration indicating where the results will be output to." + } + }, + "type": "object" + }, + "AnalyzeIamPolicyResponse": { + "description": "A response message for AssetService.AnalyzeIamPolicy.", + "id": "AnalyzeIamPolicyResponse", + "properties": { + "fullyExplored": { + "description": "Represents whether all entries in the main_analysis and service_account_impersonation_analysis have been fully explored to answer the query in the request.", + "type": "boolean" + }, + "mainAnalysis": { + "$ref": "IamPolicyAnalysis", + "description": "The main analysis that matches the original request." + }, + "serviceAccountImpersonationAnalysis": { + "description": "The service account impersonation analysis if AnalyzeIamPolicyRequest.analyze_service_account_impersonation is enabled.", + "items": { + "$ref": "IamPolicyAnalysis" + }, + "type": "array" + } + }, + "type": "object" + }, "Asset": { "description": "An asset in Google Cloud. An asset can be any resource in the Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. Cloud IAM policy). See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information.", "id": "Asset", @@ -486,6 +655,10 @@ }, "type": "array" }, + "osInventory": { + "$ref": "Inventory", + "description": "A representation of runtime OS Inventory information. See [this topic](https://cloud.google.com/compute/docs/instances/os-inventory-management) for more information." + }, "resource": { "$ref": "Resource", "description": "A representation of the resource." @@ -578,7 +751,7 @@ }, "partitionSpec": { "$ref": "PartitionSpec", - "description": "[partition_spec] determines whether to export to partitioned table(s) and how to partition the data. If [partition_spec] is unset or [partition_spec.partion_key] is unset or `PARTITION_KEY_UNSPECIFIED`, the snapshot results will be exported to non-partitioned table(s). [force] will decide whether to overwrite existing table(s). If [partition_spec] is specified. First, the snapshot results will be written to partitioned table(s) with two additional timestamp columns, readTime and requestTime, one of which will be the partition key. Secondly, in the case when any destination table already exists, it will first try to update existing table's schema as necessary by appending additional columns. Then, if [force] is `TRUE`, the corresponding partition will be overwritten by the snapshot results (data in different partitions will remain intact); if [force] is unset or `FALSE`, it will append the data. An error will be returned if the schema update or data appension fails." + "description": "[partition_spec] determines whether to export to partitioned table(s) and how to partition the data. If [partition_spec] is unset or [partition_spec.partition_key] is unset or `PARTITION_KEY_UNSPECIFIED`, the snapshot results will be exported to non-partitioned table(s). [force] will decide whether to overwrite existing table(s). If [partition_spec] is specified. First, the snapshot results will be written to partitioned table(s) with two additional timestamp columns, readTime and requestTime, one of which will be the partition key. Secondly, in the case when any destination table already exists, it will first try to update existing table's schema as necessary by appending additional columns. Then, if [force] is `TRUE`, the corresponding partition will be overwritten by the snapshot results (data in different partitions will remain intact); if [force] is unset or `FALSE`, it will append the data. An error will be returned if the schema update or data appension fails." }, "separateTablesPerAssetType": { "description": "If this flag is `TRUE`, the snapshot results will be written to one or multiple tables, each of which contains results of one asset type. The [force] and [partition_spec] fields will apply to each of them. Field [table] will be concatenated with \"_\" and the asset type names (see https://cloud.google.com/asset-inventory/docs/supported-asset-types for supported asset types) to construct per-asset-type table names, in which all non-alphanumeric characters like \".\" and \"/\" will be substituted by \"_\". Example: if field [table] is \"mytable\" and snapshot results contain \"storage.googleapis.com/Bucket\" assets, the corresponding table name will be \"mytable_storage_googleapis_com_Bucket\". If any of these tables does not exist, a new table with the concatenated name will be created. When [content_type] in the ExportAssetsRequest is `RESOURCE`, the schema of each table will include RECORD-type columns mapped to the nested fields in the Asset.resource.data field of that asset type (up to the 15 nested level BigQuery supports (https://cloud.google.com/bigquery/docs/nested-repeated#limitations)). The fields in >15 nested levels will be stored in JSON format string as a child column of its parent RECORD column. If error occurs when exporting to any table, the whole export call will return an error but the export results that already succeed will persist. Example: if exporting to table_type_A succeeds when exporting to table_type_B fails during one export call, the results in table_type_A will persist and there will not be partial results persisting in a table.", @@ -666,14 +839,16 @@ "RESOURCE", "IAM_POLICY", "ORG_POLICY", - "ACCESS_POLICY" + "ACCESS_POLICY", + "OS_INVENTORY" ], "enumDescriptions": [ "Unspecified content type.", "Resource metadata.", "The actual IAM policy set on a resource.", "The Cloud Organization Policy set on an asset.", - "The Cloud Access context manager Policy set on an asset." + "The Cloud Access context manager Policy set on an asset.", + "The runtime OS Inventory information." ], "type": "string" }, @@ -741,14 +916,16 @@ "RESOURCE", "IAM_POLICY", "ORG_POLICY", - "ACCESS_POLICY" + "ACCESS_POLICY", + "OS_INVENTORY" ], "enumDescriptions": [ "Unspecified content type.", "Resource metadata.", "The actual IAM policy set on a resource.", "The Cloud Organization Policy set on an asset.", - "The Cloud Access context manager Policy set on an asset." + "The Cloud Access context manager Policy set on an asset.", + "The runtime OS Inventory information." ], "type": "string" }, @@ -789,6 +966,161 @@ }, "type": "object" }, + "GoogleCloudAssetV1Access": { + "description": "An IAM role or permission under analysis.", + "id": "GoogleCloudAssetV1Access", + "properties": { + "analysisState": { + "$ref": "IamPolicyAnalysisState", + "description": "The analysis state of this access." + }, + "permission": { + "description": "The permission.", + "type": "string" + }, + "role": { + "description": "The role.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssetV1AccessControlList": { + "description": "An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry. NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations. For example, assume we have the following cases in one IAM policy binding: - Permission P1 and P2 apply to resource R1 and R2; - Permission P3 applies to resource R2 and R3; This will result in the following access control lists: - AccessControlList 1: [R1, R2], [P1, P2] - AccessControlList 2: [R2, R3], [P3]", + "id": "GoogleCloudAssetV1AccessControlList", + "properties": { + "accesses": { + "description": "The accesses that match one of the following conditions: - The access_selector, if it is specified in request; - Otherwise, access specifiers reachable from the policy binding's role.", + "items": { + "$ref": "GoogleCloudAssetV1Access" + }, + "type": "array" + }, + "resourceEdges": { + "description": "Resource edges of the graph starting from the policy attached resource to any descendant resources. The Edge.source_node contains the full resource name of a parent resource and Edge.target_node contains the full resource name of a child resource. This field is present only if the output_resource_edges option is enabled in request.", + "items": { + "$ref": "GoogleCloudAssetV1Edge" + }, + "type": "array" + }, + "resources": { + "description": "The resources that match one of the following conditions: - The resource_selector, if it is specified in request; - Otherwise, resources reachable from the policy attached resource.", + "items": { + "$ref": "GoogleCloudAssetV1Resource" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssetV1BigQueryDestination": { + "description": "A BigQuery destination.", + "id": "GoogleCloudAssetV1BigQueryDestination", + "properties": { + "dataset": { + "description": "Required. The BigQuery dataset in format \"projects/projectId/datasets/datasetId\", to which the analysis results should be exported. If this dataset does not exist, the export call will return an INVALID_ARGUMENT error.", + "type": "string" + }, + "partitionKey": { + "description": "The partition key for BigQuery partitioned table.", + "enum": [ + "PARTITION_KEY_UNSPECIFIED", + "REQUEST_TIME" + ], + "enumDescriptions": [ + "Unspecified partition key. Tables won't be partitioned using this option.", + "The time when the request is received. If specified as partition key, the result table(s) is partitoned by the RequestTime column, an additional timestamp column representing when the request was received." + ], + "type": "string" + }, + "tablePrefix": { + "description": "Required. The prefix of the BigQuery tables to which the analysis results will be written. Tables will be created based on this table_prefix if not exist: * _analysis table will contain export operation's metadata. * _analysis_result will contain all the IamPolicyAnalysisResult. When [partition_key] is specified, both tables will be partitioned based on the [partition_key].", + "type": "string" + }, + "writeDisposition": { + "description": "Optional. Specifies the action that occurs if the destination table or partition already exists. The following values are supported: * WRITE_TRUNCATE: If the table or partition already exists, BigQuery overwrites the entire table or all the partitions data. * WRITE_APPEND: If the table or partition already exists, BigQuery appends the data to the table or the latest partition. * WRITE_EMPTY: If the table already exists and contains data, an error is returned. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Details are at https://cloud.google.com/bigquery/docs/loading-data-local#appending_to_or_overwriting_a_table_using_a_local_file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssetV1Edge": { + "description": "A directional edge.", + "id": "GoogleCloudAssetV1Edge", + "properties": { + "sourceNode": { + "description": "The source node of the edge. For example, it could be a full resource name for a resource node or an email of an identity.", + "type": "string" + }, + "targetNode": { + "description": "The target node of the edge. For example, it could be a full resource name for a resource node or an email of an identity.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssetV1GcsDestination": { + "description": "A Cloud Storage location.", + "id": "GoogleCloudAssetV1GcsDestination", + "properties": { + "uri": { + "description": "Required. The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: \"gs://bucket_name/object_name\". See [Quickstart: Using the gsutil tool] (https://cloud.google.com/storage/docs/quickstart-gsutil) for examples.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssetV1Identity": { + "description": "An identity under analysis.", + "id": "GoogleCloudAssetV1Identity", + "properties": { + "analysisState": { + "$ref": "IamPolicyAnalysisState", + "description": "The analysis state of this identity." + }, + "name": { + "description": "The identity name in any form of members appear in [IAM policy binding](https://cloud.google.com/iam/reference/rest/v1/Binding), such as: - user:foo@google.com - group:group1@google.com - serviceAccount:s1@prj1.iam.gserviceaccount.com - projectOwner:some_project_id - domain:google.com - allUsers - etc.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAssetV1IdentityList": { + "description": "The identities and group edges.", + "id": "GoogleCloudAssetV1IdentityList", + "properties": { + "groupEdges": { + "description": "Group identity edges of the graph starting from the binding's group members to any node of the identities. The Edge.source_node contains a group, such as `group:parent@google.com`. The Edge.target_node contains a member of the group, such as `group:child@google.com` or `user:foo@google.com`. This field is present only if the output_group_edges option is enabled in request.", + "items": { + "$ref": "GoogleCloudAssetV1Edge" + }, + "type": "array" + }, + "identities": { + "description": "Only the identities that match one of the following conditions will be presented: - The identity_selector, if it is specified in request; - Otherwise, identities reachable from the policy binding's members.", + "items": { + "$ref": "GoogleCloudAssetV1Identity" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAssetV1Resource": { + "description": "A Google Cloud resource under analysis.", + "id": "GoogleCloudAssetV1Resource", + "properties": { + "analysisState": { + "$ref": "IamPolicyAnalysisState", + "description": "The analysis state of this resource." + }, + "fullResourceName": { + "description": "The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format)", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudOrgpolicyV1BooleanPolicy": { "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this resource.", "id": "GoogleCloudOrgpolicyV1BooleanPolicy", @@ -937,6 +1269,24 @@ }, "type": "object" }, + "GoogleIdentityAccesscontextmanagerV1ApiOperation": { + "description": "Identification for an API Operation.", + "id": "GoogleIdentityAccesscontextmanagerV1ApiOperation", + "properties": { + "methodSelectors": { + "description": "API methods or permissions to allow. Method or permission must belong to the service specified by `service_name` field. A single MethodSelector entry with `*` specified for the `method` field will allow all methods AND permissions for the service specified in `service_name`.", + "items": { + "$ref": "GoogleIdentityAccesscontextmanagerV1MethodSelector" + }, + "type": "array" + }, + "serviceName": { + "description": "The name of the API whose methods or permissions the IngressPolicy or EgressPolicy want to allow. A single ApiOperation with `service_name` field set to `*` will allow all methods AND permissions for all services.", + "type": "string" + } + }, + "type": "object" + }, "GoogleIdentityAccesscontextmanagerV1BasicLevel": { "description": "`BasicLevel` is an `AccessLevel` using a set of recommended features.", "id": "GoogleIdentityAccesscontextmanagerV1BasicLevel", @@ -1081,6 +1431,175 @@ }, "type": "object" }, + "GoogleIdentityAccesscontextmanagerV1EgressFrom": { + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", + "properties": { + "identities": { + "description": "A list of identities that are allowed access through this [EgressPolicy]. Should be in the format of email address. The email address should represent individual user or service account only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "identityType": { + "description": "Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.", + "enum": [ + "IDENTITY_TYPE_UNSPECIFIED", + "ANY_IDENTITY", + "ANY_USER_ACCOUNT", + "ANY_SERVICE_ACCOUNT" + ], + "enumDescriptions": [ + "No blanket identity group specified.", + "Authorize access from all identities outside the perimeter.", + "Authorize access from all human users outside the perimeter.", + "Authorize access from all service accounts outside the perimeter." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleIdentityAccesscontextmanagerV1EgressPolicy": { + "description": "Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo.", + "id": "GoogleIdentityAccesscontextmanagerV1EgressPolicy", + "properties": { + "egressFrom": { + "$ref": "GoogleIdentityAccesscontextmanagerV1EgressFrom", + "description": "Defines conditions on the source of a request causing this EgressPolicy to apply." + }, + "egressTo": { + "$ref": "GoogleIdentityAccesscontextmanagerV1EgressTo", + "description": "Defines the conditions on the ApiOperation and destination resources that cause this EgressPolicy to apply." + } + }, + "type": "object" + }, + "GoogleIdentityAccesscontextmanagerV1EgressTo": { + "description": "Defines the conditions under which an EgressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the `resources` specified. Note that if the destination of the request is protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed.", + "id": "GoogleIdentityAccesscontextmanagerV1EgressTo", + "properties": { + "operations": { + "description": "A list of ApiOperations that this egress rule applies to. A request matches if it contains an operation/service in this list.", + "items": { + "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" + }, + "type": "array" + }, + "resources": { + "description": "A list of resources, currently only projects in the form `projects/`, that match this to stanza. A request matches if it contains a resource in this list. If `*` is specified for resources, then this EgressTo rule will authorize access to all resources outside the perimeter.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleIdentityAccesscontextmanagerV1IngressFrom": { + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request.", + "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", + "properties": { + "identities": { + "description": "A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "identityType": { + "description": "Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.", + "enum": [ + "IDENTITY_TYPE_UNSPECIFIED", + "ANY_IDENTITY", + "ANY_USER_ACCOUNT", + "ANY_SERVICE_ACCOUNT" + ], + "enumDescriptions": [ + "No blanket identity group specified.", + "Authorize access from all identities outside the perimeter.", + "Authorize access from all human users outside the perimeter.", + "Authorize access from all service accounts outside the perimeter." + ], + "type": "string" + }, + "sources": { + "description": "Sources that this IngressPolicy authorizes access from.", + "items": { + "$ref": "GoogleIdentityAccesscontextmanagerV1IngressSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleIdentityAccesscontextmanagerV1IngressPolicy": { + "description": "Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field.", + "id": "GoogleIdentityAccesscontextmanagerV1IngressPolicy", + "properties": { + "ingressFrom": { + "$ref": "GoogleIdentityAccesscontextmanagerV1IngressFrom", + "description": "Defines the conditions on the source of a request causing this IngressPolicy to apply." + }, + "ingressTo": { + "$ref": "GoogleIdentityAccesscontextmanagerV1IngressTo", + "description": "Defines the conditions on the ApiOperation and request destination that cause this IngressPolicy to apply." + } + }, + "type": "object" + }, + "GoogleIdentityAccesscontextmanagerV1IngressSource": { + "description": "The source that IngressPolicy authorizes access from.", + "id": "GoogleIdentityAccesscontextmanagerV1IngressSource", + "properties": { + "accessLevel": { + "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If `*` is specified, then all IngressSources will be allowed.", + "type": "string" + }, + "resource": { + "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format: `projects/{project_number}` The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleIdentityAccesscontextmanagerV1IngressTo": { + "description": "Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the ApiOperation intended to be performed on the destination of the request.", + "id": "GoogleIdentityAccesscontextmanagerV1IngressTo", + "properties": { + "operations": { + "description": "A list of ApiOperations the sources specified in corresponding IngressFrom are allowed to perform in this ServicePerimeter.", + "items": { + "$ref": "GoogleIdentityAccesscontextmanagerV1ApiOperation" + }, + "type": "array" + }, + "resources": { + "description": "A list of resources, currently only projects in the form `projects/`, protected by this ServicePerimeter that are allowed to be accessed by sources defined in the corresponding IngressFrom. A request matches if it contains a resource in this list. If `*` is specified for resources, then this IngressTo rule will authorize access to all resources inside the perimeter, provided that the request also matches the `operations` field.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleIdentityAccesscontextmanagerV1MethodSelector": { + "description": "An allowed method or permission of a service specified in ApiOperation.", + "id": "GoogleIdentityAccesscontextmanagerV1MethodSelector", + "properties": { + "method": { + "description": "Value for `method` should be a valid method name for the corresponding `service_name` in ApiOperation. If `*` used as value for `method`, then ALL methods and permissions are allowed.", + "type": "string" + }, + "permission": { + "description": "Value for `permission` should be a valid Cloud IAM permission for the corresponding `service_name` in ApiOperation.", + "type": "string" + } + }, + "type": "object" + }, "GoogleIdentityAccesscontextmanagerV1OsConstraint": { "description": "A restriction on the OS type and version of devices making requests.", "id": "GoogleIdentityAccesscontextmanagerV1OsConstraint", @@ -1172,6 +1691,20 @@ }, "type": "array" }, + "egressPolicies": { + "description": "List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge.", + "items": { + "$ref": "GoogleIdentityAccesscontextmanagerV1EgressPolicy" + }, + "type": "array" + }, + "ingressPolicies": { + "description": "List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge.", + "items": { + "$ref": "GoogleIdentityAccesscontextmanagerV1IngressPolicy" + }, + "type": "array" + }, "resources": { "description": "A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}`", "items": { @@ -1211,24 +1744,262 @@ }, "type": "object" }, + "IamPolicyAnalysis": { + "description": "An analysis message to group the query and results.", + "id": "IamPolicyAnalysis", + "properties": { + "analysisQuery": { + "$ref": "IamPolicyAnalysisQuery", + "description": "The analysis query." + }, + "analysisResults": { + "description": "A list of IamPolicyAnalysisResult that matches the analysis query, or empty if no result is found.", + "items": { + "$ref": "IamPolicyAnalysisResult" + }, + "type": "array" + }, + "fullyExplored": { + "description": "Represents whether all entries in the analysis_results have been fully explored to answer the query.", + "type": "boolean" + }, + "nonCriticalErrors": { + "description": "A list of non-critical errors happened during the query handling.", + "items": { + "$ref": "IamPolicyAnalysisState" + }, + "type": "array" + } + }, + "type": "object" + }, + "IamPolicyAnalysisOutputConfig": { + "description": "Output configuration for export IAM policy analysis destination.", + "id": "IamPolicyAnalysisOutputConfig", + "properties": { + "bigqueryDestination": { + "$ref": "GoogleCloudAssetV1BigQueryDestination", + "description": "Destination on BigQuery." + }, + "gcsDestination": { + "$ref": "GoogleCloudAssetV1GcsDestination", + "description": "Destination on Cloud Storage." + } + }, + "type": "object" + }, + "IamPolicyAnalysisQuery": { + "description": "## LINT.IfChange Keep in sync with ## logs/proto/cloud_asset_inventory/iam_policy_analyzer_log.proto IAM policy analysis query message.", + "id": "IamPolicyAnalysisQuery", + "properties": { + "accessSelector": { + "$ref": "AccessSelector", + "description": "Optional. Specifies roles or permissions for analysis. This is optional." + }, + "identitySelector": { + "$ref": "IdentitySelector", + "description": "Optional. Specifies an identity for analysis." + }, + "options": { + "$ref": "Options", + "description": "Optional. The query options." + }, + "resourceSelector": { + "$ref": "ResourceSelector", + "description": "Optional. Specifies a resource for analysis." + }, + "scope": { + "description": "Required. The relative name of the root asset. Only resources and IAM policies within the scope will be analyzed. This can only be an organization number (such as \"organizations/123\"), a folder number (such as \"folders/123\"), a project ID (such as \"projects/my-project-id\"), or a project number (such as \"projects/12345\"). To know how to get organization id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id). To know how to get folder or project id, visit [here ](https://cloud.google.com/resource-manager/docs/creating-managing-folders#viewing_or_listing_folders_and_projects).", + "type": "string" + } + }, + "type": "object" + }, + "IamPolicyAnalysisResult": { + "description": "IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists.", + "id": "IamPolicyAnalysisResult", + "properties": { + "accessControlLists": { + "description": "The access control lists derived from the iam_binding that match or potentially match resource and access selectors specified in the request.", + "items": { + "$ref": "GoogleCloudAssetV1AccessControlList" + }, + "type": "array" + }, + "attachedResourceFullName": { + "description": "The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the resource to which the iam_binding policy attaches.", + "type": "string" + }, + "fullyExplored": { + "description": "Represents whether all analyses on the iam_binding have successfully finished.", + "type": "boolean" + }, + "iamBinding": { + "$ref": "Binding", + "description": "The Cloud IAM policy binding under analysis." + }, + "identityList": { + "$ref": "GoogleCloudAssetV1IdentityList", + "description": "The identity list derived from members of the iam_binding that match or potentially match identity selector specified in the request." + } + }, + "type": "object" + }, + "IamPolicyAnalysisState": { + "description": "Represents the detailed state of an entity under analysis, such as a resource, an identity or an access.", + "id": "IamPolicyAnalysisState", + "properties": { + "cause": { + "description": "The human-readable description of the cause of failure.", + "type": "string" + }, + "code": { + "description": "The Google standard error code that best describes the state. For example: - OK means the analysis on this entity has been successfully finished; - PERMISSION_DENIED means an access denied error is encountered; - DEADLINE_EXCEEDED means the analysis on this entity hasn't been started in time;", + "enum": [ + "OK", + "CANCELLED", + "UNKNOWN", + "INVALID_ARGUMENT", + "DEADLINE_EXCEEDED", + "NOT_FOUND", + "ALREADY_EXISTS", + "PERMISSION_DENIED", + "UNAUTHENTICATED", + "RESOURCE_EXHAUSTED", + "FAILED_PRECONDITION", + "ABORTED", + "OUT_OF_RANGE", + "UNIMPLEMENTED", + "INTERNAL", + "UNAVAILABLE", + "DATA_LOSS" + ], + "enumDescriptions": [ + "Not an error; returned on success HTTP Mapping: 200 OK", + "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", + "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", + "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", + "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", + "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", + "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", + "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", + "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", + "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", + "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level (e.g., when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence). (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. E.g., if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", + "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", + "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", + "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", + "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", + "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", + "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" + ], + "type": "string" + } + }, + "type": "object" + }, "IamPolicySearchResult": { "description": "A result of IAM Policy search, containing information of an IAM policy.", "id": "IamPolicySearchResult", "properties": { "explanation": { "$ref": "Explanation", - "description": "Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query." + "description": "Optional. Explanation about the IAM policy search result. It contains additional information to explain why the search result matches the query." }, "policy": { "$ref": "Policy", - "description": "The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the `policy` bindings: * use a field query: - query by the policy contained members. Example: `policy:amy@gmail.com` - query by the policy contained roles. Example: `policy:roles/compute.admin` - query by the policy contained roles' included permissions. Example: `policy.role.permissions:compute.instances.create`" + "description": "Required. The IAM policy directly set on the given resource. Note that the original IAM policy can contain multiple bindings. This only contains the bindings that match the given query. For queries that don't contain a constrain on policies (e.g., an empty query), this contains all the bindings. To search against the `policy` bindings: * use a field query: - query by the policy contained members. Example: `policy:amy@gmail.com` - query by the policy contained roles. Example: `policy:roles/compute.admin` - query by the policy contained roles' included permissions. Example: `policy.role.permissions:compute.instances.create`" }, "project": { - "description": "The project that the associated GCP resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request.", + "description": "Optional. The project that the associated GCP resource belongs to, in the form of projects/{PROJECT_NUMBER}. If an IAM policy is set on a resource (like VM instance, Cloud Storage bucket), the project field will indicate the project that contains the resource. If an IAM policy is set on a folder or orgnization, the project field will be empty. To search against the `project`: * specify the `scope` field as this project in your search request.", "type": "string" }, "resource": { - "description": "The full resource name of the resource associated with this IAM policy. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Cloud Asset Inventory Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more information. To search against the `resource`: * use a field query. Example: `resource:organizations/123`", + "description": "Required. The full resource name of the resource associated with this IAM policy. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Cloud Asset Inventory Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more information. To search against the `resource`: * use a field query. Example: `resource:organizations/123`", + "type": "string" + } + }, + "type": "object" + }, + "IdentitySelector": { + "description": "Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly.", + "id": "IdentitySelector", + "properties": { + "identity": { + "description": "Required. The identity appear in the form of members in [IAM policy binding](https://cloud.google.com/iam/reference/rest/v1/Binding). The examples of supported forms are: \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\". Notice that wildcard characters (such as * and ?) are not supported. You must give a specific identity.", + "type": "string" + } + }, + "type": "object" + }, + "Inventory": { + "description": "The inventory details of a VM.", + "id": "Inventory", + "properties": { + "items": { + "additionalProperties": { + "$ref": "Item" + }, + "description": "Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.", + "type": "object" + }, + "osInfo": { + "$ref": "OsInfo", + "description": "Base level operating system information for the VM." + } + }, + "type": "object" + }, + "Item": { + "description": "A single piece of inventory on a VM.", + "id": "Item", + "properties": { + "availablePackage": { + "$ref": "SoftwarePackage", + "description": "Software package available to be installed on the VM instance." + }, + "createTime": { + "description": "When this inventory item was first detected.", + "format": "google-datetime", + "type": "string" + }, + "id": { + "description": "Identifier for this item, unique across items for this VM.", + "type": "string" + }, + "installedPackage": { + "$ref": "SoftwarePackage", + "description": "Software package present on the VM instance." + }, + "originType": { + "description": "The origin of this inventory item.", + "enum": [ + "ORIGIN_TYPE_UNSPECIFIED", + "INVENTORY_REPORT" + ], + "enumDescriptions": [ + "Invalid. An origin type must be specified.", + "This inventory item was discovered as the result of the agent reporting inventory via the reporting API." + ], + "type": "string" + }, + "type": { + "description": "The specific type of inventory, correlating to its specific details.", + "enum": [ + "TYPE_UNSPECIFIED", + "INSTALLED_PACKAGE", + "AVAILABLE_PACKAGE" + ], + "enumDescriptions": [ + "Invalid. An type must be specified.", + "This represents a package that is installed on the VM.", + "This represents an update that is available for a package." + ], + "type": "string" + }, + "updateTime": { + "description": "When this inventory item was last modified.", + "format": "google-datetime", "type": "string" } }, @@ -1282,6 +2053,76 @@ }, "type": "object" }, + "Options": { + "description": "Contains query options.", + "id": "Options", + "properties": { + "analyzeServiceAccountImpersonation": { + "description": "Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. We highly recommend you use AssetService.AnalyzeIamPolicyLongrunning rpc instead. For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another example, if the request analyzes for who has permission P to a GCP folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Default is false.", + "type": "boolean" + }, + "expandGroups": { + "description": "Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If IamPolicyAnalysisQuery.identity_selector is specified, the identity in the result will be determined by the selector, and this flag is not allowed to set. Default is false.", + "type": "boolean" + }, + "expandResources": { + "description": "Optional. If true and IamPolicyAnalysisQuery.resource_selector is not specified, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy. For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P. If true and IamPolicyAnalysisQuery.resource_selector is specified, the resource section of the result will expand the specified resource to include resources lower in the resource hierarchy. Only project or lower resources are supported. Folder and organization resource cannot be used together with this option. For example, if the request analyzes for which users have permission P on a GCP project with this option enabled, the results will include all users who have permission P on that project or any lower resource. Default is false.", + "type": "boolean" + }, + "expandRoles": { + "description": "Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If IamPolicyAnalysisQuery.access_selector is specified, the access section of the result will be determined by the selector, and this flag is not allowed to set. Default is false.", + "type": "boolean" + }, + "outputGroupEdges": { + "description": "Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false.", + "type": "boolean" + }, + "outputResourceEdges": { + "description": "Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false.", + "type": "boolean" + } + }, + "type": "object" + }, + "OsInfo": { + "description": "Operating system information for the VM.", + "id": "OsInfo", + "properties": { + "architecture": { + "description": "The system architecture of the operating system.", + "type": "string" + }, + "hostname": { + "description": "The VM hostname.", + "type": "string" + }, + "kernelRelease": { + "description": "The kernel release of the operating system.", + "type": "string" + }, + "kernelVersion": { + "description": "The kernel version of the operating system.", + "type": "string" + }, + "longName": { + "description": "The operating system long name. For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019 Datacenter'.", + "type": "string" + }, + "osconfigAgentVersion": { + "description": "The current version of the OS Config agent running on the VM.", + "type": "string" + }, + "shortName": { + "description": "The operating system short name. For example, 'windows' or 'debian'.", + "type": "string" + }, + "version": { + "description": "The version of the operating system.", + "type": "string" + } + }, + "type": "object" + }, "OutputConfig": { "description": "Output configuration for export assets destination.", "id": "OutputConfig", @@ -1422,45 +2263,85 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: `projectId` for Project, `dnsName` for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding GCP service (e.g., Compute Engine). see [API references and supported searchable attributes](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types) for more information. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version. To search against the `additional_attributes`: * use a free text query to match the attributes values. Example: to search `additional_attributes = { dnsName: \"foobar\" }`, you can issue a query `foobar`.", + "description": "Optional. The additional searchable attributes of this resource. The attributes may vary from one resource type to another. Examples: `projectId` for Project, `dnsName` for DNS ManagedZone. This field contains a subset of the resource metadata fields that are returned by the List or Get APIs provided by the corresponding GCP service (e.g., Compute Engine). see [API references and supported searchable attributes](https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types) for more information. You can search values of these fields through free text search. However, you should not consume the field programically as the field names and values may change as the GCP service updates to a new incompatible API version. To search against the `additional_attributes`: * use a free text query to match the attributes values. Example: to search `additional_attributes = { dnsName: \"foobar\" }`, you can issue a query `foobar`.", "type": "object" }, "assetType": { - "description": "The type of this resource. Example: `compute.googleapis.com/Disk`. To search against the `asset_type`: * specify the `asset_type` field in your search request.", + "description": "Required. The type of this resource. Example: `compute.googleapis.com/Disk`. To search against the `asset_type`: * specify the `asset_type` field in your search request.", + "type": "string" + }, + "createTime": { + "description": "Optional. The create timestamp of this resource, at which the resource was created. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's proto contains it. To search against `create_time`: * use a field query (value in seconds). Example: `createTime >= 1594294238`", + "format": "google-datetime", "type": "string" }, "description": { - "description": "One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. To search against the `description`: * use a field query. Example: `description:\"*important instance*\"` * use a free text query. Example: `\"*important instance*\"`", + "description": "Optional. One or more paragraphs of text description of this resource. Maximum length could be up to 1M bytes. This field is available only when the resource's proto contains it. To search against the `description`: * use a field query. Example: `description:\"important instance\"` * use a free text query. Example: `\"important instance\"`", "type": "string" }, "displayName": { - "description": "The display name of this resource. To search against the `display_name`: * use a field query. Example: `displayName:\"My Instance\"` * use a free text query. Example: `\"My Instance\"`", + "description": "Optional. The display name of this resource. This field is available only when the resource's proto contains it. To search against the `display_name`: * use a field query. Example: `displayName:\"My Instance\"` * use a free text query. Example: `\"My Instance\"`", + "type": "string" + }, + "folders": { + "description": "Optional. The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders. To search against `folders`: * use a field query. Example: `folders:(123 OR 456)` * specify the `scope` field as this folder in your search request.", + "items": { + "type": "string" + }, + "type": "array" + }, + "kmsKey": { + "description": "Optional. The Cloud KMS [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys?hl=en) name or [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en) name. This field is available only when the resource's proto contains it. To search against the `kms_key`: * use a field query. Example: `kmsKey:key` * use a free text query. Example: `key`", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Labels associated with this resource. See [Labelling and grouping GCP resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. To search against the `labels`: * use a field query: - query on any label's key or value. Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - query by a given label's existence. Example: `labels.env:*` * use a free text query. Example: `prod`", + "description": "Optional. Labels associated with this resource. See [Labelling and grouping GCP resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's proto contains it. To search against the `labels`: * use a field query: - query on any label's key or value. Example: `labels:prod` - query by a given label. Example: `labels.env:prod` - query by a given label's existence. Example: `labels.env:*` * use a free text query. Example: `prod`", "type": "object" }, "location": { - "description": "Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`. To search against the `location`: * use a field query. Example: `location:us-west*` * use a free text query. Example: `us-west*`", + "description": "Optional. Location can be `global`, regional like `us-east1`, or zonal like `us-west1-b`. This field is available only when the resource's proto contains it. To search against the `location`: * use a field query. Example: `location:us-west*` * use a free text query. Example: `us-west*`", "type": "string" }, "name": { - "description": "The full resource name of this resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Cloud Asset Inventory Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more information. To search against the `name`: * use a field query. Example: `name:instance1` * use a free text query. Example: `instance1`", + "description": "Required. The full resource name of this resource. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`. See [Cloud Asset Inventory Resource Name Format](https://cloud.google.com/asset-inventory/docs/resource-name-format) for more information. To search against the `name`: * use a field query. Example: `name:instance1` * use a free text query. Example: `instance1`", "type": "string" }, "networkTags": { - "description": "Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See [Labelling GCP resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. To search against the `network_tags`: * use a field query. Example: `networkTags:internal` * use a free text query. Example: `internal`", + "description": "Optional. Network tags associated with this resource. Like labels, network tags are a type of annotations used to group GCP resources. See [Labelling GCP resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) for more information. This field is available only when the resource's proto contains it. To search against the `network_tags`: * use a field query. Example: `networkTags:internal` * use a free text query. Example: `internal`", "items": { "type": "string" }, "type": "array" }, + "organization": { + "description": "Optional. The organization that this resource belongs to, in the form of organizations/{ORGANIZATION_NUMBER}. This field is available when the resource belongs to a organization. To search against `organization`: * use a field query. Example: `organization:123` * specify the `scope` field as this organization in your search request.", + "type": "string" + }, "project": { - "description": "The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. To search against the `project`: * specify the `scope` field as this project in your search request.", + "description": "Optional. The project that this resource belongs to, in the form of projects/{PROJECT_NUMBER}. This field is available when the resource belongs to a project. To search against `project`: * use a field query. Example: `project:12345` * specify the `scope` field as this project in your search request.", + "type": "string" + }, + "state": { + "description": "Optional. The state of this resource. Different resources types have different state definitions that are mapped from various fields of different resource types. This field is available only when the resource's proto contains it. Example: If the resource is an instance provided by Compute Engine, its state will include PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. See `status` definition in [API Reference](https://cloud.google.com/compute/docs/reference/rest/v1/instances). If the resource is a project provided by Cloud Resource Manager, its state will include LIFECYCLE_STATE_UNSPECIFIED, ACTIVE, DELETE_REQUESTED and DELETE_IN_PROGRESS. See `lifecycleState` definition in [API Reference](https://cloud.google.com/resource-manager/reference/rest/v1/projects). To search against the `state`: * use a field query. Example: `state:RUNNING` * use a free text query. Example: `RUNNING`", + "type": "string" + }, + "updateTime": { + "description": "Optional. The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's proto contains it. To search against `update_time`: * use a field query (value in seconds). Example: `updateTime < 1594294238`", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ResourceSelector": { + "description": "Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects.", + "id": "ResourceSelector", + "properties": { + "fullResourceName": { + "description": "Required. The [full resource name] (https://cloud.google.com/asset-inventory/docs/resource-name-format) of a resource of [supported resource types](https://cloud.google.com/asset-inventory/docs/supported-asset-types#analyzable_asset_types).", "type": "string" } }, @@ -1502,6 +2383,45 @@ }, "type": "object" }, + "SoftwarePackage": { + "description": "Software package information of the operating system.", + "id": "SoftwarePackage", + "properties": { + "aptPackage": { + "$ref": "VersionedPackage", + "description": "Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt." + }, + "cosPackage": { + "$ref": "VersionedPackage", + "description": "Details of a COS package." + }, + "googetPackage": { + "$ref": "VersionedPackage", + "description": "Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet." + }, + "qfePackage": { + "$ref": "WindowsQuickFixEngineeringPackage", + "description": "Details of a Windows Quick Fix engineering package. See https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering for info in Windows Quick Fix Engineering." + }, + "wuaPackage": { + "$ref": "WindowsUpdatePackage", + "description": "Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update." + }, + "yumPackage": { + "$ref": "VersionedPackage", + "description": "Yum package info. For details about the yum package manager, see https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum." + }, + "zypperPackage": { + "$ref": "VersionedPackage", + "description": "Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual." + }, + "zypperPatch": { + "$ref": "ZypperPatch", + "description": "Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual." + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1602,6 +2522,141 @@ } }, "type": "object" + }, + "VersionedPackage": { + "description": "Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.", + "id": "VersionedPackage", + "properties": { + "architecture": { + "description": "The system architecture this package is intended for.", + "type": "string" + }, + "packageName": { + "description": "The name of the package.", + "type": "string" + }, + "version": { + "description": "The version of the package.", + "type": "string" + } + }, + "type": "object" + }, + "WindowsQuickFixEngineeringPackage": { + "description": "Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering", + "id": "WindowsQuickFixEngineeringPackage", + "properties": { + "caption": { + "description": "A short textual description of the QFE update.", + "type": "string" + }, + "description": { + "description": "A textual description of the QFE update.", + "type": "string" + }, + "hotFixId": { + "description": "Unique identifier associated with a particular QFE update.", + "type": "string" + }, + "installTime": { + "description": "Date that the QFE update was installed. Mapped from installed_on field.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "WindowsUpdateCategory": { + "description": "Categories specified by the Windows Update.", + "id": "WindowsUpdateCategory", + "properties": { + "id": { + "description": "The identifier of the windows update category.", + "type": "string" + }, + "name": { + "description": "The name of the windows update category.", + "type": "string" + } + }, + "type": "object" + }, + "WindowsUpdatePackage": { + "description": "Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated.", + "id": "WindowsUpdatePackage", + "properties": { + "categories": { + "description": "The categories that are associated with this update package.", + "items": { + "$ref": "WindowsUpdateCategory" + }, + "type": "array" + }, + "description": { + "description": "The localized description of the update package.", + "type": "string" + }, + "kbArticleIds": { + "description": "A collection of Microsoft Knowledge Base article IDs that are associated with the update package.", + "items": { + "type": "string" + }, + "type": "array" + }, + "lastDeploymentChangeTime": { + "description": "The last published date of the update, in (UTC) date and time.", + "format": "google-datetime", + "type": "string" + }, + "moreInfoUrls": { + "description": "A collection of URLs that provide more information about the update package.", + "items": { + "type": "string" + }, + "type": "array" + }, + "revisionNumber": { + "description": "The revision number of this update package.", + "format": "int32", + "type": "integer" + }, + "supportUrl": { + "description": "A hyperlink to the language-specific support information for the update.", + "type": "string" + }, + "title": { + "description": "The localized title of the update package.", + "type": "string" + }, + "updateId": { + "description": "Gets the identifier of an update package. Stays the same across revisions.", + "type": "string" + } + }, + "type": "object" + }, + "ZypperPatch": { + "description": "Details related to a Zypper Patch.", + "id": "ZypperPatch", + "properties": { + "category": { + "description": "The category of the patch.", + "type": "string" + }, + "patchName": { + "description": "The name of the patch.", + "type": "string" + }, + "severity": { + "description": "The severity specified for this patch", + "type": "string" + }, + "summary": { + "description": "Any summary information provided about this patch.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/cloudbilling__v1.json b/discovery/googleapis/cloudbilling__v1.json index 0841f37..41398bb 100644 --- a/discovery/googleapis/cloudbilling__v1.json +++ b/discovery/googleapis/cloudbilling__v1.json
@@ -507,7 +507,7 @@ } } }, - "revision": "20201003", + "revision": "20201017", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { @@ -796,7 +796,7 @@ "id": "Money", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": {
diff --git a/discovery/googleapis/cloudbuild__v1.json b/discovery/googleapis/cloudbuild__v1.json index 6f69268..fddfb48 100644 --- a/discovery/googleapis/cloudbuild__v1.json +++ b/discovery/googleapis/cloudbuild__v1.json
@@ -281,7 +281,7 @@ "type": "integer" }, "pageToken": { - "description": "Token to provide to skip to a particular spot in the list.", + "description": "The page token for the next page of Builds. If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more.", "location": "query", "type": "string" }, @@ -353,7 +353,7 @@ ], "parameters": { "name": { - "description": "The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}`", + "description": "The name of the `Build` to cancel. Format: `projects/{project}/locations/{location}/builds/{build}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/builds/[^/]+$", "required": true, @@ -457,7 +457,7 @@ "type": "integer" }, "pageToken": { - "description": "Token to provide to skip to a particular spot in the list.", + "description": "The page token for the next page of Builds. If unspecified, the first page of results is returned. If the token is rejected for any reason, INVALID_ARGUMENT will be thrown. In this case, the token should be discarded, and pagination should be restarted from the first page of results. See https://google.aip.dev/158 for more.", "location": "query", "type": "string" }, @@ -755,13 +755,48 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "webhook": { + "description": "ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger.", + "httpMethod": "POST", + "id": "cloudbuild.projects.triggers.webhook", + "parameterOrder": [ + "projectId", + "trigger" + ], + "parameters": { + "projectId": { + "description": "Project in which the specified trigger lives", + "location": "path", + "required": true, + "type": "string" + }, + "secret": { + "description": "Secret token used for authorization if an OAuth token isn't provided.", + "location": "query", + "type": "string" + }, + "trigger": { + "description": "Name of the trigger to run the payload against", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/triggers/{trigger}:webhook", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "ReceiveTriggerWebhookResponse" + } } } } } } }, - "revision": "20201001", + "revision": "20210128", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ArtifactObjects": { @@ -824,13 +859,17 @@ "type": "object" }, "Build": { - "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", + "description": "A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.", "id": "Build", "properties": { "artifacts": { "$ref": "Artifacts", "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." }, + "availableSecrets": { + "$ref": "Secrets", + "description": "Secrets and secret environment variables." + }, "buildTriggerId": { "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", "readOnly": true, @@ -894,14 +933,14 @@ "readOnly": true }, "secrets": { - "description": "Secrets to decrypt using Cloud Key Management Service.", + "description": "Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets", "items": { "$ref": "Secret" }, "type": "array" }, "serviceAccount": { - "description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in alpha and is not publicly available.", + "description": "IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. This field is in beta.", "type": "string" }, "source": { @@ -1049,7 +1088,7 @@ "Only Cloud Storage logging is enabled.", "This option is the same as CLOUD_LOGGING_ONLY.", "Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.", - "Turn off all logging. No build logs will be captured. Next ID: 6" + "Turn off all logging. No build logs will be captured." ], "type": "string" }, @@ -1058,12 +1097,16 @@ "enum": [ "UNSPECIFIED", "N1_HIGHCPU_8", - "N1_HIGHCPU_32" + "N1_HIGHCPU_32", + "E2_HIGHCPU_8", + "E2_HIGHCPU_32" ], "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", - "Highcpu machine with 32 CPUs." + "Highcpu machine with 32 CPUs.", + "Highcpu e2 machine with 8 CPUs.", + "Highcpu e2 machine with 32 CPUs." ], "type": "string" }, @@ -1123,7 +1166,7 @@ "type": "array" }, "workerPool": { - "description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is experimental.", + "description": "Option to specify a `WorkerPool` for the build. Format: projects/{project}/locations/{location}/workerPools/{workerPool} This field is in beta and is available only to restricted users.", "type": "string" } }, @@ -1332,7 +1375,7 @@ "type": "string" }, "name": { - "description": "The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}`", + "description": "The name of the `Build` to cancel. Format: `projects/{project}/locations/{location}/builds/{build}`", "type": "string" }, "projectId": { @@ -1433,6 +1476,52 @@ }, "type": "object" }, + "HttpBody": { + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", + "id": "HttpBody", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "InlineSecret": { + "description": "Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.", + "id": "InlineSecret", + "properties": { + "envMap": { + "additionalProperties": { + "format": "byte", + "type": "string" + }, + "description": "Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets.", + "type": "object" + }, + "kmsKeyName": { + "description": "Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*", + "type": "string" + } + }, + "type": "object" + }, "ListBuildTriggersResponse": { "description": "Response containing existing `BuildTriggers`.", "id": "ListBuildTriggersResponse", @@ -1463,7 +1552,7 @@ "type": "array" }, "nextPageToken": { - "description": "Token to receive the next page of results.", + "description": "Token to receive the next page of results. This will be absent if the end of the response list has been reached.", "type": "string" } }, @@ -1665,6 +1754,12 @@ }, "type": "object" }, + "ReceiveTriggerWebhookResponse": { + "description": "ReceiveTriggerWebhookResponse [Experimental] is the response object for the ReceiveTriggerWebhook method.", + "id": "ReceiveTriggerWebhookResponse", + "properties": {}, + "type": "object" + }, "RepoSource": { "description": "Location of the source in a Google Cloud Source Repository.", "id": "RepoSource", @@ -1690,7 +1785,7 @@ "type": "string" }, "repoName": { - "description": "Required. Name of the Cloud Source Repository.", + "description": "Name of the Cloud Source Repository.", "type": "string" }, "substitutions": { @@ -1803,7 +1898,7 @@ "type": "object" }, "Secret": { - "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value.", + "description": "Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `available_secrets` instead of using `kmsKeyName` with `secret`. For instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/use-encrypted-credentials.", "id": "Secret", "properties": { "kmsKeyName": { @@ -1821,6 +1916,42 @@ }, "type": "object" }, + "SecretManagerSecret": { + "description": "Pairs a secret environment variable with a SecretVersion in Secret Manager.", + "id": "SecretManagerSecret", + "properties": { + "env": { + "description": "Environment variable name to associate with the secret. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step.", + "type": "string" + }, + "versionName": { + "description": "Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", + "type": "string" + } + }, + "type": "object" + }, + "Secrets": { + "description": "Secrets and secret environment variables.", + "id": "Secrets", + "properties": { + "inline": { + "description": "Secrets encrypted with KMS key and the associated secret environment variable.", + "items": { + "$ref": "InlineSecret" + }, + "type": "array" + }, + "secretManager": { + "description": "Secrets in Secret Manager and associated secret environment variable.", + "items": { + "$ref": "SecretManagerSecret" + }, + "type": "array" + } + }, + "type": "object" + }, "SlackDelivery": { "description": "SlackDelivery is the delivery configuration for delivering Slack messages via webhooks. See Slack webhook documentation at: https://api.slack.com/messaging/webhooks.", "id": "SlackDelivery",
diff --git a/discovery/googleapis/clouddebugger__v2.json b/discovery/googleapis/clouddebugger__v2.json index 652ea70..ef77ab8 100644 --- a/discovery/googleapis/clouddebugger__v2.json +++ b/discovery/googleapis/clouddebugger__v2.json
@@ -438,7 +438,7 @@ } } }, - "revision": "20201002", + "revision": "20210122", "rootUrl": "https://clouddebugger.googleapis.com/", "schemas": { "AliasContext": {
diff --git a/discovery/googleapis/cloudfunctions__v1.json b/discovery/googleapis/cloudfunctions__v1.json index 6291801..41c248c 100644 --- a/discovery/googleapis/cloudfunctions__v1.json +++ b/discovery/googleapis/cloudfunctions__v1.json
@@ -530,7 +530,7 @@ } } }, - "revision": "20200925", + "revision": "20210121", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -654,6 +654,10 @@ "readOnly": true, "type": "string" }, + "buildWorkerPool": { + "description": "Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.", + "type": "string" + }, "description": { "description": "User-provided description of a function.", "type": "string" @@ -729,6 +733,10 @@ "$ref": "SourceRepository", "description": "**Beta Feature** The source repository where a function is hosted." }, + "sourceToken": { + "description": "Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", + "type": "string" + }, "sourceUploadUrl": { "description": "The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl", "type": "string" @@ -893,6 +901,20 @@ "description": "Describes HttpsTrigger, could be used to connect web hooks to function.", "id": "HttpsTrigger", "properties": { + "securityLevel": { + "description": "The security level for the function.", + "enum": [ + "SECURITY_LEVEL_UNSPECIFIED", + "SECURE_ALWAYS", + "SECURE_OPTIONAL" + ], + "enumDescriptions": [ + "Unspecified.", + "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly." + ], + "type": "string" + }, "url": { "description": "Output only. The deployed url for the function.", "readOnly": true, @@ -1047,6 +1069,10 @@ "description": "The original request that started the operation.", "type": "object" }, + "sourceToken": { + "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", + "type": "string" + }, "target": { "description": "Target of the operation - for example projects/project-1/locations/region-1/functions/function-1", "type": "string"
diff --git a/discovery/googleapis/cloudidentity__v1.json b/discovery/googleapis/cloudidentity__v1.json index 40f286b..acf0171 100644 --- a/discovery/googleapis/cloudidentity__v1.json +++ b/discovery/googleapis/cloudidentity__v1.json
@@ -123,7 +123,7 @@ ], "parameters": { "name": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.", + "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the Device.", "location": "path", "pattern": "^devices/[^/]+$", "required": true, @@ -139,7 +139,7 @@ } }, "create": { - "description": "Creates a device. Only company-owned device may be created.", + "description": "Creates a device. Only company-owned device may be created. **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium", "httpMethod": "POST", "id": "cloudidentity.devices.create", "parameterOrder": [], @@ -222,7 +222,7 @@ "type": "string" }, "filter": { - "description": "Optional. Additional restrictions when fetching list of devices. [Help Center article link](https://support.google.com/a/answer/7549103)", + "description": "Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.", "location": "query", "type": "string" }, @@ -429,7 +429,7 @@ "type": "string" }, "filter": { - "description": "Optional. Additional restrictions when fetching list of devices. [HC article](https://support.google.com/a/answer/7549103)", + "description": "Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.", "location": "query", "type": "string" }, @@ -554,7 +554,7 @@ "type": "string" }, "name": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{partner_id}`, where device_id is the unique ID assigned to the Device, device_user_id is the unique ID assigned to the User and partner_id identifies the partner storing the data.", + "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{partner_id}`, where device_id is the unique ID assigned to the Device, device_user_id is the unique ID assigned to the User and partner_id identifies the partner storing the data. To get the client state for devices belonging to your own organization, the `partnerId` is in the format: `customerId-*anystring*`. Where the `customerId` is your organization's customer ID and `anystring` is any suffix. This suffix is used in setting up Custom Access Levels in Context-Aware Access. You may use `my_customer` instead of the customer ID for devices managed by your own organization.", "location": "path", "pattern": "^devices/[^/]+/deviceUsers/[^/]+/clientStates/[^/]+$", "required": true, @@ -608,7 +608,7 @@ } }, "patch": { - "description": "Updates the client state for the device user", + "description": "Updates the client state for the device user **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium", "httpMethod": "PATCH", "id": "cloudidentity.devices.deviceUsers.clientStates.patch", "parameterOrder": [ @@ -685,7 +685,7 @@ ] }, "delete": { - "description": "Deletes a Group.", + "description": "Deletes a `Group`.", "httpMethod": "DELETE", "id": "cloudidentity.groups.delete", "parameterOrder": [ @@ -693,7 +693,7 @@ ], "parameters": { "name": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.", + "description": "Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`.", "location": "path", "pattern": "^groups/[^/]+$", "required": true, @@ -710,7 +710,7 @@ ] }, "get": { - "description": "Retrieves a Group.", + "description": "Retrieves a `Group`.", "httpMethod": "GET", "id": "cloudidentity.groups.get", "parameterOrder": [ @@ -718,7 +718,7 @@ ], "parameters": { "name": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.", + "description": "Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`.", "location": "path", "pattern": "^groups/[^/]+$", "required": true, @@ -736,29 +736,29 @@ ] }, "list": { - "description": "Lists groups within a customer or a domain.", + "description": "Lists the `Group`s under a customer or namespace.", "httpMethod": "GET", "id": "cloudidentity.groups.list", "parameterOrder": [], "parameters": { "pageSize": { - "description": "The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.", + "description": "The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The next_page_token value returned from a previous list request, if any.", + "description": "The `next_page_token` value returned from a previous list request, if any.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Customer ID to list all groups from.", + "description": "Required. The parent resource under which to list all `Group`s. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups.", "location": "query", "type": "string" }, "view": { - "description": "Group resource view to be returned. Defaults to [View.BASIC]().", + "description": "The level of detail to be returned. If unspecified, defaults to `View.BASIC`.", "enum": [ "VIEW_UNSPECIFIED", "BASIC", @@ -766,8 +766,8 @@ ], "enumDescriptions": [ "Default. Should not be used.", - "Server responses only include basic information.", - "Full representation of the resource." + "Only basic resource information is returned.", + "All resource information is returned." ], "location": "query", "type": "string" @@ -784,18 +784,18 @@ ] }, "lookup": { - "description": "Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Group by its EntityKey.", + "description": "Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.", "httpMethod": "GET", "id": "cloudidentity.groups.lookup", "parameterOrder": [], "parameters": { "groupKey.id": { - "description": "The ID of the entity within the given namespace. The ID must be unique within its namespace.", + "description": "The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`.", "location": "query", "type": "string" }, "groupKey.namespace": { - "description": "Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is created corresponding to every Identity Source `identity_source_id`.", + "description": "The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.", "location": "query", "type": "string" } @@ -811,7 +811,7 @@ ] }, "patch": { - "description": "Updates a Group.", + "description": "Updates a `Group`.", "httpMethod": "PATCH", "id": "cloudidentity.groups.patch", "parameterOrder": [ @@ -819,14 +819,14 @@ ], "parameters": { "name": { - "description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.", + "description": "Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.", "location": "path", "pattern": "^groups/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. Editable fields: `display_name`, `description`", + "description": "Required. The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -845,29 +845,29 @@ ] }, "search": { - "description": "Searches for Groups.", + "description": "Searches for `Group`s matching a specified query.", "httpMethod": "GET", "id": "cloudidentity.groups.search", "parameterOrder": [], "parameters": { "pageSize": { - "description": "The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.", + "description": "The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The next_page_token value returned from a previous search request, if any.", + "description": "The `next_page_token` value returned from a previous search request, if any.", "location": "query", "type": "string" }, "query": { - "description": "Required. `Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels.", + "description": "Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`).", "location": "query", "type": "string" }, "view": { - "description": "Group resource view to be returned. Defaults to [View.BASIC]().", + "description": "The level of detail to be returned. If unspecified, defaults to `View.BASIC`.", "enum": [ "VIEW_UNSPECIFIED", "BASIC", @@ -875,8 +875,8 @@ ], "enumDescriptions": [ "Default. Should not be used.", - "Server responses only include basic information.", - "Full representation of the resource." + "Only basic resource information is returned.", + "All resource information is returned." ], "location": "query", "type": "string" @@ -896,8 +896,39 @@ "resources": { "memberships": { "methods": { + "checkTransitiveMembership": { + "description": "Check a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.", + "httpMethod": "GET", + "id": "cloudidentity.groups.memberships.checkTransitiveMembership", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the group to check the transitive membership in. Format: `groups/{group_id}`, where `group_id` is the unique id assigned to the Group to which the Membership belongs to.", + "location": "path", + "pattern": "^groups/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "Required. A CEL expression that MUST include member specification. This is a `required` field. Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value'`", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/memberships:checkTransitiveMembership", + "response": { + "$ref": "CheckTransitiveMembershipResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.groups", + "https://www.googleapis.com/auth/cloud-identity.groups.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { - "description": "Creates a Membership.", + "description": "Creates a `Membership`.", "httpMethod": "POST", "id": "cloudidentity.groups.memberships.create", "parameterOrder": [ @@ -905,7 +936,7 @@ ], "parameters": { "parent": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.", + "description": "Required. The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`.", "location": "path", "pattern": "^groups/[^/]+$", "required": true, @@ -925,7 +956,7 @@ ] }, "delete": { - "description": "Deletes a Membership.", + "description": "Deletes a `Membership`.", "httpMethod": "DELETE", "id": "cloudidentity.groups.memberships.delete", "parameterOrder": [ @@ -933,7 +964,7 @@ ], "parameters": { "name": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member.", + "description": "Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}`", "location": "path", "pattern": "^groups/[^/]+/memberships/[^/]+$", "required": true, @@ -950,7 +981,7 @@ ] }, "get": { - "description": "Retrieves a Membership.", + "description": "Retrieves a `Membership`.", "httpMethod": "GET", "id": "cloudidentity.groups.memberships.get", "parameterOrder": [ @@ -958,7 +989,7 @@ ], "parameters": { "name": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member.", + "description": "Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`.", "location": "path", "pattern": "^groups/[^/]+/memberships/[^/]+$", "required": true, @@ -975,8 +1006,39 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getMembershipGraph": { + "description": "Get a membership graph of just a member or both a member and a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.", + "httpMethod": "GET", + "id": "cloudidentity.groups.memberships.getMembershipGraph", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group to which the Membership belongs to. group_id can be a wildcard collection id \"-\". When a group_id is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned.", + "location": "path", + "pattern": "^groups/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' && in labels`", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/memberships:getMembershipGraph", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.groups", + "https://www.googleapis.com/auth/cloud-identity.groups.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { - "description": "Lists Memberships within a Group.", + "description": "Lists the `Membership`s within a `Group`.", "httpMethod": "GET", "id": "cloudidentity.groups.memberships.list", "parameterOrder": [ @@ -984,25 +1046,25 @@ ], "parameters": { "pageSize": { - "description": "The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view.", + "description": "The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The next_page_token value returned from a previous list request, if any.", + "description": "The `next_page_token` value returned from a previous search request, if any.", "location": "query", "type": "string" }, "parent": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.", + "description": "Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`.", "location": "path", "pattern": "^groups/[^/]+$", "required": true, "type": "string" }, "view": { - "description": "Membership resource view to be returned. Defaults to View.BASIC.", + "description": "The level of detail to be returned. If unspecified, defaults to `View.BASIC`.", "enum": [ "VIEW_UNSPECIFIED", "BASIC", @@ -1010,8 +1072,8 @@ ], "enumDescriptions": [ "Default. Should not be used.", - "Server responses only include basic information.", - "Full representation of the resource." + "Only basic resource information is returned.", + "All resource information is returned." ], "location": "query", "type": "string" @@ -1028,7 +1090,7 @@ ] }, "lookup": { - "description": "Looks up [resource name](https://cloud.google.com/apis/design/resource_names) of a Membership within a Group by member's EntityKey.", + "description": "Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.", "httpMethod": "GET", "id": "cloudidentity.groups.memberships.lookup", "parameterOrder": [ @@ -1036,17 +1098,17 @@ ], "parameters": { "memberKey.id": { - "description": "The ID of the entity within the given namespace. The ID must be unique within its namespace.", + "description": "The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`.", "location": "query", "type": "string" }, "memberKey.namespace": { - "description": "Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is created corresponding to every Identity Source `identity_source_id`.", + "description": "The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.", "location": "query", "type": "string" }, "parent": { - "description": "Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.", + "description": "Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`.", "location": "path", "pattern": "^groups/[^/]+$", "required": true, @@ -1090,30 +1152,221 @@ "https://www.googleapis.com/auth/cloud-identity.groups", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "searchTransitiveGroups": { + "description": "Search transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.", + "httpMethod": "GET", + "id": "cloudidentity.groups.memberships.searchTransitiveGroups", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The default page size is 200 (max 1000).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is always '-' as this API will search across all groups for a given member.", + "location": "path", + "pattern": "^groups/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' && in labels`", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/memberships:searchTransitiveGroups", + "response": { + "$ref": "SearchTransitiveGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.groups", + "https://www.googleapis.com/auth/cloud-identity.groups.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchTransitiveMemberships": { + "description": "Search transitive memberships of a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.", + "httpMethod": "GET", + "id": "cloudidentity.groups.memberships.searchTransitiveMemberships", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The default page size is 200 (max 1000).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.", + "location": "path", + "pattern": "^groups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/memberships:searchTransitiveMemberships", + "response": { + "$ref": "SearchTransitiveMembershipsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.groups", + "https://www.googleapis.com/auth/cloud-identity.groups.readonly", + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } } }, - "revision": "20200922", + "revision": "20210124", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { + "CheckTransitiveMembershipResponse": { + "description": "The response message for MembershipsService.CheckTransitiveMembership.", + "id": "CheckTransitiveMembershipResponse", + "properties": { + "hasMembership": { + "description": "Response does not include the possible roles of a member since the behavior of this rpc is not all-or-nothing unlike the other rpcs. So, it may not be possible to list all the roles definitively, due to possible lack of authorization in some of the paths.", + "type": "boolean" + } + }, + "type": "object" + }, + "DynamicGroupMetadata": { + "description": "Dynamic group metadata like queries and status.", + "id": "DynamicGroupMetadata", + "properties": { + "queries": { + "description": "Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.", + "items": { + "$ref": "DynamicGroupQuery" + }, + "type": "array" + }, + "status": { + "$ref": "DynamicGroupStatus", + "description": "Output only. Status of the dynamic group.", + "readOnly": true + } + }, + "type": "object" + }, + "DynamicGroupQuery": { + "description": "Defines a query on a resource.", + "id": "DynamicGroupQuery", + "properties": { + "query": { + "description": "Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')`", + "type": "string" + }, + "resourceType": { + "description": "Resource type for the Dynamic Group Query", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "USER" + ], + "enumDescriptions": [ + "Default value (not valid)", + "For queries on User" + ], + "type": "string" + } + }, + "type": "object" + }, + "DynamicGroupStatus": { + "description": "The current status of a dynamic group along with timestamp.", + "id": "DynamicGroupStatus", + "properties": { + "status": { + "description": "Status of the dynamic group.", + "enum": [ + "STATUS_UNSPECIFIED", + "UP_TO_DATE", + "UPDATING_MEMBERSHIPS" + ], + "enumDescriptions": [ + "Default.", + "The dynamic group is up-to-date.", + "The dynamic group has just been created and memberships are being updated." + ], + "type": "string" + }, + "statusTime": { + "description": "The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "EntityKey": { - "description": "An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique.", + "description": "A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.", "id": "EntityKey", "properties": { "id": { - "description": "The ID of the entity within the given namespace. The ID must be unique within its namespace.", + "description": "The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`.", "type": "string" }, "namespace": { - "description": "Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `\"identitysources/{identity_source_id}\"` is created corresponding to every Identity Source `identity_source_id`.", + "description": "The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.", "type": "string" } }, "type": "object" }, + "ExpiryDetail": { + "description": "The `MembershipRole` expiry details.", + "id": "ExpiryDetail", + "properties": { + "expireTime": { + "description": "The time at which the `MembershipRole` will expire.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GetMembershipGraphResponse": { + "description": "The response message for MembershipsService.GetMembershipGraph.", + "id": "GetMembershipGraphResponse", + "properties": { + "adjacencyList": { + "description": "The membership graph's path information represented as an adjacency list.", + "items": { + "$ref": "MembershipAdjacencyList" + }, + "type": "array" + }, + "groups": { + "description": "The resources representing each group in the adjacency list. Each group in this list can be correlated to a 'group' of the MembershipAdjacencyList using the 'name' of the Group resource.", + "items": { + "$ref": "Group" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleAppsCloudidentityDevicesV1AndroidAttributes": { "description": "Resource representing the Android specific attributes of a Device.", "id": "GoogleAppsCloudidentityDevicesV1AndroidAttributes", @@ -1807,45 +2060,49 @@ "type": "object" }, "Group": { - "description": "Resource representing a Group.", + "description": "A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.", "id": "Group", "properties": { "createTime": { - "description": "Output only. The time when the Group was created. Output only.", + "description": "Output only. The time when the `Group` was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { - "description": "An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters.", + "description": "An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.", "type": "string" }, "displayName": { - "description": "The Group's display name.", + "description": "The display name of the `Group`.", "type": "string" }, + "dynamicGroupMetadata": { + "$ref": "DynamicGroupMetadata", + "description": "Optional. Dynamic group metadata like queries and status." + }, "groupKey": { "$ref": "EntityKey", - "description": "Required. Immutable. EntityKey of the Group. Must be set when creating a Group, read-only afterwards." + "description": "Required. Immutable. The `EntityKey` of the `Group`." }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Required. `Required`. Labels for Group resource. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty.", + "description": "Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {\"cloudidentity.googleapis.com/groups.discussion_forum\": \"\"} or {\"system/groups/external\": \"\"}.", "type": "object" }, "name": { - "description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group.", + "description": "Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.", "readOnly": true, "type": "string" }, "parent": { - "description": "Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: `identitysources`.", + "description": "Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups.", "type": "string" }, "updateTime": { - "description": "Output only. The time when the Group was last updated. Output only.", + "description": "Output only. The time when the `Group` was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1853,6 +2110,55 @@ }, "type": "object" }, + "GroupRelation": { + "description": "Message representing a transitive group of a user or a group.", + "id": "GroupRelation", + "properties": { + "displayName": { + "description": "Display name for this group.", + "type": "string" + }, + "group": { + "description": "Resource name for this group.", + "type": "string" + }, + "groupKey": { + "$ref": "EntityKey", + "description": "Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels for Group resource.", + "type": "object" + }, + "relationType": { + "description": "The relation between the member and the transitive group.", + "enum": [ + "RELATION_TYPE_UNSPECIFIED", + "DIRECT", + "INDIRECT", + "DIRECT_AND_INDIRECT" + ], + "enumDescriptions": [ + "The relation type is undefined or undetermined.", + "The two entities have only a direct membership with each other.", + "The two entities have only an indirect membership with each other.", + "The two entities have both a direct and an indirect membership with each other." + ], + "type": "string" + }, + "roles": { + "description": "Membership roles of the member for the group.", + "items": { + "$ref": "TransitiveMembershipRole" + }, + "type": "array" + } + }, + "type": "object" + }, "ListGroupsResponse": { "description": "Response message for ListGroups operation.", "id": "ListGroupsResponse", @@ -1872,63 +2178,107 @@ "type": "object" }, "ListMembershipsResponse": { + "description": "The response message for MembershipsService.ListMemberships.", "id": "ListMembershipsResponse", "properties": { "memberships": { - "description": "List of Memberships.", + "description": "The `Membership`s under the specified `parent`.", "items": { "$ref": "Membership" }, "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results available for listing.", + "description": "A continuation token to retrieve the next page of results, or empty if there are no more results available.", "type": "string" } }, "type": "object" }, "LookupGroupNameResponse": { + "description": "The response message for GroupsService.LookupGroupName.", "id": "LookupGroupNameResponse", "properties": { "name": { - "description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group.", + "description": "The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`.", "type": "string" } }, "type": "object" }, "LookupMembershipNameResponse": { + "description": "The response message for MembershipsService.LookupMembershipName.", "id": "LookupMembershipNameResponse", "properties": { "name": { - "description": "[Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership being looked up. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member.", + "description": "The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Membership`. Must be of the form `groups/{group_id}/memberships/{membership_id}`.", "type": "string" } }, "type": "object" }, + "MemberRelation": { + "description": "Message representing a transitive membership of a group.", + "id": "MemberRelation", + "properties": { + "member": { + "description": "Resource name for this member if member is a GROUP, otherwise it is empty.", + "type": "string" + }, + "preferredMemberKey": { + "description": "Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace.", + "items": { + "$ref": "EntityKey" + }, + "type": "array" + }, + "relationType": { + "description": "The relation between the group and the transitive member.", + "enum": [ + "RELATION_TYPE_UNSPECIFIED", + "DIRECT", + "INDIRECT", + "DIRECT_AND_INDIRECT" + ], + "enumDescriptions": [ + "The relation type is undefined or undetermined.", + "The two entities have only a direct membership with each other.", + "The two entities have only an indirect membership with each other.", + "The two entities have both a direct and an indirect membership with each other." + ], + "type": "string" + }, + "roles": { + "description": "The membership role details (i.e name of role and expiry time).", + "items": { + "$ref": "TransitiveMembershipRole" + }, + "type": "array" + } + }, + "type": "object" + }, "Membership": { - "description": "Resource representing a Membership within a Group", + "description": "A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a \"member\".", "id": "Membership", "properties": { "createTime": { - "description": "Output only. Creation timestamp of the Membership. Output only.", + "description": "Output only. The time when the `Membership` was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { - "description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership in the format: `groups/{group_id}/memberships/{member_id}`, where group_id is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member Must be left blank while creating a Membership.", + "description": "Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`.", "readOnly": true, "type": "string" }, "preferredMemberKey": { "$ref": "EntityKey", - "description": "Required. Immutable. EntityKey of the entity to be added as the member. Must be set while creating a Membership, read-only afterwards. Currently allowed entity types: `Users`, `Groups`." + "description": "Required. Immutable. The `EntityKey` of the member." }, "roles": { - "description": "Roles for a member within the Group. Currently supported MembershipRoles: `\"MEMBER\"`.", + "description": "The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`.", "items": { "$ref": "MembershipRole" }, @@ -1954,7 +2304,7 @@ "type": "string" }, "updateTime": { - "description": "Output only. Last updated timestamp of the Membership. Output only.", + "description": "Output only. The time when the `Membership` was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1962,12 +2312,34 @@ }, "type": "object" }, + "MembershipAdjacencyList": { + "description": "Membership graph's path information as an adjacency list.", + "id": "MembershipAdjacencyList", + "properties": { + "edges": { + "description": "Each edge contains information about the member that belongs to this group. Note: Fields returned here will help identify the specific Membership resource (e.g name, preferred_member_key and role), but may not be a comprehensive list of all fields.", + "items": { + "$ref": "Membership" + }, + "type": "array" + }, + "group": { + "description": "Resource name of the group that the members belong to.", + "type": "string" + } + }, + "type": "object" + }, "MembershipRole": { - "description": "Resource representing a role within a Membership.", + "description": "A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.", "id": "MembershipRole", "properties": { + "expiryDetail": { + "$ref": "ExpiryDetail", + "description": "The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value." + }, "name": { - "description": "MembershipRole in string format. Currently supported MembershipRoles: `\"MEMBER\"`.", + "description": "The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`.", "type": "string" } }, @@ -1990,6 +2362,13 @@ "type": "string" }, "type": "array" + }, + "updateRolesParams": { + "description": "The `MembershipRole`s to be updated. Updating roles in the same request as adding or removing roles is not supported. Must not be set if either `add_roles` or `remove_roles` is set.", + "items": { + "$ref": "UpdateMembershipRolesParams" + }, + "type": "array" } }, "type": "object" @@ -2041,17 +2420,54 @@ "type": "object" }, "SearchGroupsResponse": { + "description": "The response message for GroupsService.SearchGroups.", "id": "SearchGroupsResponse", "properties": { "groups": { - "description": "List of Groups satisfying the search query.", + "description": "The `Group`s that match the search query.", "items": { "$ref": "Group" }, "type": "array" }, "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results available for specified query.", + "description": "A continuation token to retrieve the next page of results, or empty if there are no more results available.", + "type": "string" + } + }, + "type": "object" + }, + "SearchTransitiveGroupsResponse": { + "description": "The response message for MembershipsService.SearchTransitiveGroups.", + "id": "SearchTransitiveGroupsResponse", + "properties": { + "memberships": { + "description": "List of transitive groups satisfying the query.", + "items": { + "$ref": "GroupRelation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results available for listing.", + "type": "string" + } + }, + "type": "object" + }, + "SearchTransitiveMembershipsResponse": { + "description": "The response message for MembershipsService.SearchTransitiveMemberships.", + "id": "SearchTransitiveMembershipsResponse", + "properties": { + "memberships": { + "description": "List of transitive members satisfying the query.", + "items": { + "$ref": "MemberRelation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results.", "type": "string" } }, @@ -2083,6 +2499,72 @@ } }, "type": "object" + }, + "TransitiveMembershipRole": { + "description": "Message representing the role of a TransitiveMembership.", + "id": "TransitiveMembershipRole", + "properties": { + "role": { + "description": "TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `\"MEMBER\"`, `\"OWNER\"`, and `\"MANAGER\"`.", + "type": "string" + } + }, + "type": "object" + }, + "UpdateMembershipRolesParams": { + "description": "The details of an update to a `MembershipRole`.", + "id": "UpdateMembershipRolesParams", + "properties": { + "fieldMask": { + "description": "The fully-qualified names of fields to update. May only contain the field `expiry_detail`.", + "format": "google-fieldmask", + "type": "string" + }, + "membershipRole": { + "$ref": "MembershipRole", + "description": "The `MembershipRole`s to be updated. Only `MEMBER` `MembershipRole` can currently be updated." + } + }, + "type": "object" + }, + "UserInvitation": { + "description": "UserInvitation to join a Google Workspace organization.", + "id": "UserInvitation", + "properties": { + "mailsSentCount": { + "description": "Number of invitation emails sent to the user.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Shall be of the form `customers/{customer}/userinvitations/{user_email_address}`", + "type": "string" + }, + "state": { + "description": "State of the `UserInvitation`.", + "enum": [ + "STATE_UNSPECIFIED", + "NOT_YET_SENT", + "INVITED", + "ACCEPTED", + "DECLINED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The `UserInvitation` has been created and is ready for sending as an email.", + "The user has been invited by email.", + "The user has accepted the invitation and is part of the organization.", + "The user declined the invitation." + ], + "type": "string" + }, + "updateTime": { + "description": "Time when the `UserInvitation` was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/cloudiot__v1.json b/discovery/googleapis/cloudiot__v1.json index 697c176..64d7a9e 100644 --- a/discovery/googleapis/cloudiot__v1.json +++ b/discovery/googleapis/cloudiot__v1.json
@@ -913,7 +913,7 @@ } } }, - "revision": "20200930", + "revision": "20210126", "rootUrl": "https://cloudiot.googleapis.com/", "schemas": { "BindDeviceToGatewayRequest": { @@ -941,10 +941,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)."
diff --git a/discovery/googleapis/cloudkms__v1.json b/discovery/googleapis/cloudkms__v1.json index e179714..f3d4f18 100644 --- a/discovery/googleapis/cloudkms__v1.json +++ b/discovery/googleapis/cloudkms__v1.json
@@ -1223,7 +1223,7 @@ } } }, - "revision": "20200925", + "revision": "20210122", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -1257,6 +1257,22 @@ "format": "int64", "type": "string" }, + "protectionLevel": { + "description": "The ProtectionLevel of the CryptoKeyVersion used in decryption.", + "enum": [ + "PROTECTION_LEVEL_UNSPECIFIED", + "SOFTWARE", + "HSM", + "EXTERNAL" + ], + "enumDescriptions": [ + "Not specified.", + "Crypto operations are performed in software.", + "Crypto operations are performed in a Hardware Security Module.", + "Crypto operations are performed by an external key manager." + ], + "type": "string" + }, "verifiedCiphertextCrc32c": { "description": "Integrity verification field. A flag indicating whether AsymmetricDecryptRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that AsymmetricDecryptRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set AsymmetricDecryptRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries. NOTE: This field is in Beta.", "type": "boolean" @@ -1270,7 +1286,7 @@ "properties": { "digest": { "$ref": "Digest", - "description": "Required. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm." + "description": "Optional. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm." }, "digestCrc32c": { "description": "Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(AsymmetricSignRequest.digest) is equal to AsymmetricSignRequest.digest_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.", @@ -1288,6 +1304,22 @@ "description": "The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing. NOTE: This field is in Beta.", "type": "string" }, + "protectionLevel": { + "description": "The ProtectionLevel of the CryptoKeyVersion used for signing.", + "enum": [ + "PROTECTION_LEVEL_UNSPECIFIED", + "SOFTWARE", + "HSM", + "EXTERNAL" + ], + "enumDescriptions": [ + "Not specified.", + "Crypto operations are performed in software.", + "Crypto operations are performed in a Hardware Security Module.", + "Crypto operations are performed by an external key manager." + ], + "type": "string" + }, "signature": { "description": "The created signature.", "format": "byte", @@ -1357,10 +1389,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -1717,6 +1745,26 @@ "description": "Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext. An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.", "format": "int64", "type": "string" + }, + "protectionLevel": { + "description": "The ProtectionLevel of the CryptoKeyVersion used in decryption.", + "enum": [ + "PROTECTION_LEVEL_UNSPECIFIED", + "SOFTWARE", + "HSM", + "EXTERNAL" + ], + "enumDescriptions": [ + "Not specified.", + "Crypto operations are performed in software.", + "Crypto operations are performed in a Hardware Security Module.", + "Crypto operations are performed by an external key manager." + ], + "type": "string" + }, + "usedPrimary": { + "description": "Whether the Decryption was performed using the primary key version.", + "type": "boolean" } }, "type": "object" @@ -1794,6 +1842,22 @@ "description": "The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.", "type": "string" }, + "protectionLevel": { + "description": "The ProtectionLevel of the CryptoKeyVersion used in encryption.", + "enum": [ + "PROTECTION_LEVEL_UNSPECIFIED", + "SOFTWARE", + "HSM", + "EXTERNAL" + ], + "enumDescriptions": [ + "Not specified.", + "Crypto operations are performed in software.", + "Crypto operations are performed in a Hardware Security Module.", + "Crypto operations are performed by an external key manager." + ], + "type": "string" + }, "verifiedAdditionalAuthenticatedDataCrc32c": { "description": "Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries. NOTE: This field is in Beta.", "type": "boolean" @@ -2289,6 +2353,22 @@ "description": "Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.", "format": "int64", "type": "string" + }, + "protectionLevel": { + "description": "The ProtectionLevel of the CryptoKeyVersion public key.", + "enum": [ + "PROTECTION_LEVEL_UNSPECIFIED", + "SOFTWARE", + "HSM", + "EXTERNAL" + ], + "enumDescriptions": [ + "Not specified.", + "Crypto operations are performed in software.", + "Crypto operations are performed in a Hardware Security Module.", + "Crypto operations are performed by an external key manager." + ], + "type": "string" } }, "type": "object"
diff --git a/discovery/googleapis/cloudprofiler__v2.json b/discovery/googleapis/cloudprofiler__v2.json index 90420ce..5e4ec0c 100644 --- a/discovery/googleapis/cloudprofiler__v2.json +++ b/discovery/googleapis/cloudprofiler__v2.json
@@ -211,7 +211,7 @@ } } }, - "revision": "20201003", + "revision": "20210124", "rootUrl": "https://cloudprofiler.googleapis.com/", "schemas": { "CreateProfileRequest": {
diff --git a/discovery/googleapis/cloudresourcemanager__v1.json b/discovery/googleapis/cloudresourcemanager__v1.json index 4859ec4..9446411 100644 --- a/discovery/googleapis/cloudresourcemanager__v1.json +++ b/discovery/googleapis/cloudresourcemanager__v1.json
@@ -1131,7 +1131,7 @@ } } }, - "revision": "20201005", + "revision": "20210126", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { @@ -1197,10 +1197,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -1252,6 +1248,72 @@ }, "type": "object" }, + "CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation": { + "description": "Metadata describing a long running folder operation", + "id": "CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation", + "properties": { + "destinationParent": { + "description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.", + "type": "string" + }, + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "operationType": { + "description": "The type of this operation.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "CREATE", + "MOVE" + ], + "enumDescriptions": [ + "Operation type not specified.", + "A create folder operation.", + "A move folder operation." + ], + "type": "string" + }, + "sourceParent": { + "description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.", + "type": "string" + } + }, + "type": "object" + }, + "CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation": { + "description": "Metadata describing a long running folder operation", + "id": "CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation", + "properties": { + "destinationParent": { + "description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.", + "type": "string" + }, + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "operationType": { + "description": "The type of this operation.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "CREATE", + "MOVE" + ], + "enumDescriptions": [ + "Operation type not specified.", + "A create folder operation.", + "A move folder operation." + ], + "type": "string" + }, + "sourceParent": { + "description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.", + "type": "string" + } + }, + "type": "object" + }, "Constraint": { "description": "A `Constraint` describes a way in which a resource's configuration can be restricted. For example, it controls which cloud services can be activated across an organization, or whether a Compute Engine instance can have serial port connections established. `Constraints` can be configured by the organization's policy administrator to fit the needs of the organzation by setting Policies for `Constraints` at different locations in the organization's resource hierarchy. Policies are inherited down the resource hierarchy from higher levels, but can also be overridden. For details about the inheritance rules please read about [Policies](/resource-manager/reference/rest/v1/Policy). `Constraints` have a default behavior determined by the `constraint_default` field, which is the enforcement behavior that is used in the absence of a `Policy` being defined or inherited for the resource in question.", "id": "Constraint", @@ -1298,6 +1360,83 @@ }, "type": "object" }, + "CreateFolderMetadata": { + "description": "Metadata pertaining to the Folder creation process.", + "id": "CreateFolderMetadata", + "properties": { + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "parent": { + "description": "The resource name of the folder or organization we are creating the folder under.", + "type": "string" + } + }, + "type": "object" + }, + "CreateProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.", + "id": "CreateProjectMetadata", + "properties": { + "createTime": { + "description": "Creation time of the project creation workflow.", + "format": "google-datetime", + "type": "string" + }, + "gettable": { + "description": "True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.", + "type": "boolean" + }, + "ready": { + "description": "True if the project creation process is complete.", + "type": "boolean" + } + }, + "type": "object" + }, + "CreateTagKeyMetadata": { + "description": "Runtime operation information for creating a TagKey.", + "id": "CreateTagKeyMetadata", + "properties": {}, + "type": "object" + }, + "CreateTagValueMetadata": { + "description": "Runtime operation information for creating a TagValue.", + "id": "CreateTagValueMetadata", + "properties": {}, + "type": "object" + }, + "DeleteFolderMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by DeleteFolder.", + "id": "DeleteFolderMetadata", + "properties": {}, + "type": "object" + }, + "DeleteOrganizationMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by DeleteOrganization.", + "id": "DeleteOrganizationMetadata", + "properties": {}, + "type": "object" + }, + "DeleteProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by DeleteProject.", + "id": "DeleteProjectMetadata", + "properties": {}, + "type": "object" + }, + "DeleteTagKeyMetadata": { + "description": "Runtime operation information for deleting a TagKey.", + "id": "DeleteTagKeyMetadata", + "properties": {}, + "type": "object" + }, + "DeleteTagValueMetadata": { + "description": "Runtime operation information for deleting a TagValue.", + "id": "DeleteTagValueMetadata", + "properties": {}, + "type": "object" + }, "Empty": { "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); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", @@ -1657,6 +1796,31 @@ }, "type": "object" }, + "MoveFolderMetadata": { + "description": "Metadata pertaining to the Folder move process.", + "id": "MoveFolderMetadata", + "properties": { + "destinationParent": { + "description": "The resource name of the folder or organization to move the folder to.", + "type": "string" + }, + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "sourceParent": { + "description": "The resource name of the folder's parent.", + "type": "string" + } + }, + "type": "object" + }, + "MoveProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by MoveProject.", + "id": "MoveProjectMetadata", + "properties": {}, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -2023,11 +2187,53 @@ }, "type": "object" }, + "UndeleteFolderMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UndeleteFolder.", + "id": "UndeleteFolderMetadata", + "properties": {}, + "type": "object" + }, + "UndeleteOrganizationMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.", + "id": "UndeleteOrganizationMetadata", + "properties": {}, + "type": "object" + }, + "UndeleteProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UndeleteProject.", + "id": "UndeleteProjectMetadata", + "properties": {}, + "type": "object" + }, "UndeleteProjectRequest": { "description": "The request sent to the UndeleteProject method.", "id": "UndeleteProjectRequest", "properties": {}, "type": "object" + }, + "UpdateFolderMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.", + "id": "UpdateFolderMetadata", + "properties": {}, + "type": "object" + }, + "UpdateProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UpdateProject.", + "id": "UpdateProjectMetadata", + "properties": {}, + "type": "object" + }, + "UpdateTagKeyMetadata": { + "description": "Runtime operation information for updating a TagKey.", + "id": "UpdateTagKeyMetadata", + "properties": {}, + "type": "object" + }, + "UpdateTagValueMetadata": { + "description": "Runtime operation information for updating a TagValue.", + "id": "UpdateTagValueMetadata", + "properties": {}, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/cloudresourcemanager__v2.json b/discovery/googleapis/cloudresourcemanager__v2.json index b8d133b..49b1129 100644 --- a/discovery/googleapis/cloudresourcemanager__v2.json +++ b/discovery/googleapis/cloudresourcemanager__v2.json
@@ -109,7 +109,7 @@ "folders": { "methods": { "create": { - "description": "Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folder's that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 4. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 8; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 100. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent.", + "description": "Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. In order to succeed, the addition of this new Folder must not violate the Folder naming, height or fanout constraints. + The Folder's display_name must be distinct from all other Folders that share its parent. + The addition of the Folder must not cause the active Folder hierarchy to exceed a height of 10. Note, the full active + deleted Folder hierarchy is allowed to reach a height of 20; this provides additional headroom when moving folders that contain deleted folders. + The addition of the Folder must not cause the total number of Folders under its parent to exceed 300. If the operation fails due to a folder constraint violation, some errors may be returned by the CreateFolder request, with status code FAILED_PRECONDITION and an error description. Other folder constraint violations will be communicated in the Operation, with the specific PreconditionFailure returned via the details list in the Operation.error field. The caller must have `resourcemanager.folders.create` permission on the identified parent.", "httpMethod": "POST", "id": "cloudresourcemanager.folders.create", "parameterOrder": [], @@ -273,7 +273,7 @@ ] }, "patch": { - "description": "Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\\p{L}\\p{N}]([\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.", + "description": "Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. The Folder's display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be between 3 and 30 characters. This is captured by the regular expression: `\\p{L}\\p{N}{1,28}[\\p{L}\\p{N}]`. The caller must have `resourcemanager.folders.update` permission on the identified folder. If the update fails due to the unique name constraint then a PreconditionFailure explaining this violation will be returned in the Status.details field.", "httpMethod": "PATCH", "id": "cloudresourcemanager.folders.patch", "parameterOrder": [ @@ -436,7 +436,7 @@ } } }, - "revision": "20201005", + "revision": "20210126", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -491,10 +491,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -513,6 +509,149 @@ }, "type": "object" }, + "CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation": { + "description": "Metadata describing a long running folder operation", + "id": "CloudresourcemanagerGoogleCloudResourcemanagerV2alpha1FolderOperation", + "properties": { + "destinationParent": { + "description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.", + "type": "string" + }, + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "operationType": { + "description": "The type of this operation.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "CREATE", + "MOVE" + ], + "enumDescriptions": [ + "Operation type not specified.", + "A create folder operation.", + "A move folder operation." + ], + "type": "string" + }, + "sourceParent": { + "description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.", + "type": "string" + } + }, + "type": "object" + }, + "CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation": { + "description": "Metadata describing a long running folder operation", + "id": "CloudresourcemanagerGoogleCloudResourcemanagerV2beta1FolderOperation", + "properties": { + "destinationParent": { + "description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.", + "type": "string" + }, + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "operationType": { + "description": "The type of this operation.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "CREATE", + "MOVE" + ], + "enumDescriptions": [ + "Operation type not specified.", + "A create folder operation.", + "A move folder operation." + ], + "type": "string" + }, + "sourceParent": { + "description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.", + "type": "string" + } + }, + "type": "object" + }, + "CreateFolderMetadata": { + "description": "Metadata pertaining to the Folder creation process.", + "id": "CreateFolderMetadata", + "properties": { + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "parent": { + "description": "The resource name of the folder or organization we are creating the folder under.", + "type": "string" + } + }, + "type": "object" + }, + "CreateProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.", + "id": "CreateProjectMetadata", + "properties": { + "createTime": { + "description": "Creation time of the project creation workflow.", + "format": "google-datetime", + "type": "string" + }, + "gettable": { + "description": "True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.", + "type": "boolean" + }, + "ready": { + "description": "True if the project creation process is complete.", + "type": "boolean" + } + }, + "type": "object" + }, + "CreateTagKeyMetadata": { + "description": "Runtime operation information for creating a TagKey.", + "id": "CreateTagKeyMetadata", + "properties": {}, + "type": "object" + }, + "CreateTagValueMetadata": { + "description": "Runtime operation information for creating a TagValue.", + "id": "CreateTagValueMetadata", + "properties": {}, + "type": "object" + }, + "DeleteFolderMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by DeleteFolder.", + "id": "DeleteFolderMetadata", + "properties": {}, + "type": "object" + }, + "DeleteOrganizationMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by DeleteOrganization.", + "id": "DeleteOrganizationMetadata", + "properties": {}, + "type": "object" + }, + "DeleteProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by DeleteProject.", + "id": "DeleteProjectMetadata", + "properties": {}, + "type": "object" + }, + "DeleteTagKeyMetadata": { + "description": "Runtime operation information for deleting a TagKey.", + "id": "DeleteTagKeyMetadata", + "properties": {}, + "type": "object" + }, + "DeleteTagValueMetadata": { + "description": "Runtime operation information for deleting a TagValue.", + "id": "DeleteTagValueMetadata", + "properties": {}, + "type": "object" + }, "Expr": { "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() < 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", @@ -547,7 +686,7 @@ "type": "string" }, "displayName": { - "description": "The folder’s display name. A folder’s display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\\p{L}\\p{N}]([\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.", + "description": "The folder's display name. A folder's display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\\p{L}\\p{N}]([\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?`.", "type": "string" }, "lifecycleState": { @@ -571,7 +710,7 @@ "type": "string" }, "parent": { - "description": "Required. The Folder’s parent's resource name. Updates to the folder's parent must be performed via MoveFolder.", + "description": "Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder.", "type": "string" } }, @@ -686,6 +825,25 @@ }, "type": "object" }, + "MoveFolderMetadata": { + "description": "Metadata pertaining to the Folder move process.", + "id": "MoveFolderMetadata", + "properties": { + "destinationParent": { + "description": "The resource name of the folder or organization to move the folder to.", + "type": "string" + }, + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "sourceParent": { + "description": "The resource name of the folder's parent.", + "type": "string" + } + }, + "type": "object" + }, "MoveFolderRequest": { "description": "The MoveFolder request message.", "id": "MoveFolderRequest", @@ -697,6 +855,12 @@ }, "type": "object" }, + "MoveProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by MoveProject.", + "id": "MoveProjectMetadata", + "properties": {}, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -892,11 +1056,53 @@ }, "type": "object" }, + "UndeleteFolderMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UndeleteFolder.", + "id": "UndeleteFolderMetadata", + "properties": {}, + "type": "object" + }, "UndeleteFolderRequest": { "description": "The UndeleteFolder request message.", "id": "UndeleteFolderRequest", "properties": {}, "type": "object" + }, + "UndeleteOrganizationMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UndeleteOrganization.", + "id": "UndeleteOrganizationMetadata", + "properties": {}, + "type": "object" + }, + "UndeleteProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UndeleteProject.", + "id": "UndeleteProjectMetadata", + "properties": {}, + "type": "object" + }, + "UpdateFolderMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UpdateFolder.", + "id": "UpdateFolderMetadata", + "properties": {}, + "type": "object" + }, + "UpdateProjectMetadata": { + "description": "A status object which is used as the `metadata` field for the Operation returned by UpdateProject.", + "id": "UpdateProjectMetadata", + "properties": {}, + "type": "object" + }, + "UpdateTagKeyMetadata": { + "description": "Runtime operation information for updating a TagKey.", + "id": "UpdateTagKeyMetadata", + "properties": {}, + "type": "object" + }, + "UpdateTagValueMetadata": { + "description": "Runtime operation information for updating a TagValue.", + "id": "UpdateTagValueMetadata", + "properties": {}, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/cloudscheduler__v1.json b/discovery/googleapis/cloudscheduler__v1.json index 1e74e9b..238ca9f 100644 --- a/discovery/googleapis/cloudscheduler__v1.json +++ b/discovery/googleapis/cloudscheduler__v1.json
@@ -406,7 +406,7 @@ } } }, - "revision": "20200928", + "revision": "20210129", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": {
diff --git a/discovery/googleapis/cloudsearch__v1.json b/discovery/googleapis/cloudsearch__v1.json index 96dadb7..400e884 100644 --- a/discovery/googleapis/cloudsearch__v1.json +++ b/discovery/googleapis/cloudsearch__v1.json
@@ -1826,7 +1826,7 @@ } } }, - "revision": "20200929", + "revision": "20210118", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "BooleanOperatorOptions": { @@ -1967,7 +1967,7 @@ "id": "DataSource", "properties": { "disableModifications": { - "description": "If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.", + "description": "If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.", "type": "boolean" }, "disableServing": { @@ -2943,7 +2943,7 @@ "type": "object" }, "ItemContent": { - "description": "Content of an item to be indexed and surfaced by Cloud Search.", + "description": "Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.", "id": "ItemContent", "properties": { "contentDataRef": { @@ -4780,7 +4780,7 @@ "id": "SuggestRequest", "properties": { "dataSourceRestrictions": { - "description": "The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are supported only for third party data sources and people (i.e. PredefinedSource.PERSON).", + "description": "The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are only supported for the following sources: * Third-party data sources * PredefinedSource.PERSON * PredefinedSource.GOOGLE_DRIVE", "items": { "$ref": "DataSourceRestriction" },
diff --git a/discovery/googleapis/cloudshell__v1.json b/discovery/googleapis/cloudshell__v1.json index 0027873..4e47f44 100644 --- a/discovery/googleapis/cloudshell__v1.json +++ b/discovery/googleapis/cloudshell__v1.json
@@ -363,7 +363,7 @@ } } }, - "revision": "20201003", + "revision": "20210130", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { @@ -377,7 +377,7 @@ "id": "AddPublicKeyRequest", "properties": { "key": { - "description": "Key that should be added to the environment. Supported formats are `ssh-dss` (see RFC4253), `ssh-rsa` (see RFC4253), `ecdsa-sha2-nistp256` (see RFC5656), `ecdsa-sha2-nistp384` (see RFC5656) and `ecdsa-sha2-nistp521` (see RFC5656). It should be structured as , where part is encoded with Base64.", + "description": "Key that should be added to the environment. Supported formats are `ssh-dss` (see RFC4253), `ssh-rsa` (see RFC4253), `ecdsa-sha2-nistp256` (see RFC5656), `ecdsa-sha2-nistp384` (see RFC5656) and `ecdsa-sha2-nistp521` (see RFC5656). It should be structured as <format> <content>, where <content> part is encoded with Base64.", "type": "string" } },
diff --git a/discovery/googleapis/cloudtasks__v2.json b/discovery/googleapis/cloudtasks__v2.json index 70b4586..17bd6d6 100644 --- a/discovery/googleapis/cloudtasks__v2.json +++ b/discovery/googleapis/cloudtasks__v2.json
@@ -665,7 +665,7 @@ } } }, - "revision": "20200924", + "revision": "20210115", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -772,10 +772,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)."
diff --git a/discovery/googleapis/cloudtrace__v2.json b/discovery/googleapis/cloudtrace__v2.json index b2a3295..38b540b 100644 --- a/discovery/googleapis/cloudtrace__v2.json +++ b/discovery/googleapis/cloudtrace__v2.json
@@ -177,7 +177,7 @@ } } }, - "revision": "20201001", + "revision": "20210129", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": {
diff --git a/discovery/googleapis/composer__v1.json b/discovery/googleapis/composer__v1.json index eef2184..367a758 100644 --- a/discovery/googleapis/composer__v1.json +++ b/discovery/googleapis/composer__v1.json
@@ -235,7 +235,7 @@ "type": "string" }, "updateMask": { - "description": "Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values: \"config.softwareConfig.pypiPackages.scikit-learn\" and \"config.softwareConfig.pypiPackages.numpy\". The included patch environment would specify the scikit-learn version as follows: { \"config\":{ \"softwareConfig\":{ \"pypiPackages\":{ \"scikit-learn\":\"==0.19.0\" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels \"label1\" and \"label2\" while clearing \"label3\" (assuming it already exists), one can provide the paths \"labels.label1\", \"labels.label2\", and \"labels.label3\" and populate the patch environment as follows: { \"labels\":{ \"label1\":\"new-label1-value\" \"label2\":\"new-label2-value\" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path \"config.softwareConfig.pypiPackages\", and the patch environment would be the following: { \"config\":{ \"softwareConfig\":{ \"pypiPackages\":{ \"botocore\":\"==1.7.14\" } } } } **Note:** Only the following fields can be updated: *Mask* *Purpose* config.softwareConfig.pypiPackages Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. config.softwareConfig.pypiPackages.packagename Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the \"config.softwareConfig.pypiPackages\" mask. labels Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. labels.labelName Set the label named labelName, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the \"labels\" mask. config.nodeCount Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. config.softwareConfig.airflowConfigOverrides Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. config.softwareConfig.airflowConfigOverrides.section-name Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the \"config.softwareConfig.airflowConfigOverrides\" mask. config.softwareConfig.envVariables Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables. ", + "description": "Required. A comma-separated list of paths, relative to `Environment`, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of numpy, the `updateMask` parameter would include the following two `paths` values: \"config.softwareConfig.pypiPackages.scikit-learn\" and \"config.softwareConfig.pypiPackages.numpy\". The included patch environment would specify the scikit-learn version as follows: { \"config\":{ \"softwareConfig\":{ \"pypiPackages\":{ \"scikit-learn\":\"==0.19.0\" } } } } Note that in the above example, any existing PyPI packages other than scikit-learn and numpy will be unaffected. Only one update type may be included in a single request's `updateMask`. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels \"label1\" and \"label2\" while clearing \"label3\" (assuming it already exists), one can provide the paths \"labels.label1\", \"labels.label2\", and \"labels.label3\" and populate the patch environment as follows: { \"labels\":{ \"label1\":\"new-label1-value\" \"label2\":\"new-label2-value\" } } Note that in the above example, any existing labels that are not included in the `updateMask` will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the `updateMask`. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7.14, the `updateMask` would contain the path \"config.softwareConfig.pypiPackages\", and the patch environment would be the following: { \"config\":{ \"softwareConfig\":{ \"pypiPackages\":{ \"botocore\":\"==1.7.14\" } } } } **Note:** Only the following fields can be updated: *Mask* *Purpose* config.softwareConfig.pypiPackages Replace all custom custom PyPI packages. If a replacement package map is not included in `environment`, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. config.softwareConfig.pypiPackages.packagename Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in `updateMask`, and omit the mapping for it in `environment.config.softwareConfig.pypiPackages`. It is an error to provide both a mask of this form and the \"config.softwareConfig.pypiPackages\" mask. labels Replace all environment labels. If a replacement labels map is not included in `environment`, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. labels.labelName Set the label named labelName, while preserving other labels. To delete the label, include it in `updateMask` and omit its mapping in `environment.labels`. It is an error to provide both a mask of this form and the \"labels\" mask. config.nodeCount Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the `config.nodeCount` field. config.webServerNetworkAccessControl Replace the environment's current WebServerNetworkAccessControl. config.databaseConfig Replace the environment's current DatabaseConfig. config.webServerConfig Replace the environment's current WebServerConfig. config.softwareConfig.airflowConfigOverrides Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in `environment`, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. config.softwareConfig.airflowConfigOverrides.section-name Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in `updateMask` and omit its mapping in `environment.config.softwareConfig.airflowConfigOverrides`. It is an error to provide both a mask of this form and the \"config.softwareConfig.airflowConfigOverrides\" mask. config.softwareConfig.envVariables Replace all environment variables. If a replacement environment variable map is not included in `environment`, all custom environment variables are cleared. It is an error to provide both this mask and a mask specifying one or more individual environment variables. ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -264,6 +264,11 @@ "parent" ], "parameters": { + "includePastReleases": { + "description": "Whether or not image versions from old releases should be included.", + "location": "query", + "type": "boolean" + }, "pageSize": { "description": "The maximum number of image_versions to return.", "format": "int32", @@ -390,15 +395,74 @@ } } }, - "revision": "20201002", + "revision": "20210126", "rootUrl": "https://composer.googleapis.com/", "schemas": { + "AllowedIpRange": { + "description": "Allowed IP range with user-provided description.", + "id": "AllowedIpRange", + "properties": { + "description": { + "description": "Optional. User-provided description. It must contain at most 300 characters.", + "type": "string" + }, + "value": { + "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. IP range prefixes should be properly truncated. For example, `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` should be truncated to `2001:db8::/32`.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseConfig": { + "description": "The configuration of Cloud SQL instance that is used by the Apache Airflow software.", + "id": "DatabaseConfig", + "properties": { + "machineType": { + "description": "Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.", + "type": "string" + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Empty": { "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); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, + "EncryptionConfig": { + "description": "The encryption options for the Cloud Composer environment and its dependencies.", + "id": "EncryptionConfig", + "properties": { + "kmsKeyName": { + "description": "Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.", + "type": "string" + } + }, + "type": "object" + }, "Environment": { "description": "An environment for running orchestration tasks.", "id": "Environment", @@ -467,6 +531,14 @@ "description": "Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using \"/\"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix.", "type": "string" }, + "databaseConfig": { + "$ref": "DatabaseConfig", + "description": "Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software." + }, + "encryptionConfig": { + "$ref": "EncryptionConfig", + "description": "Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated." + }, "gkeCluster": { "description": "Output only. The Kubernetes Engine cluster used to run this environment.", "type": "string" @@ -487,6 +559,14 @@ "softwareConfig": { "$ref": "SoftwareConfig", "description": "The configuration settings for software inside the environment." + }, + "webServerConfig": { + "$ref": "WebServerConfig", + "description": "Optional. The configuration settings for the Airflow web server App Engine instance." + }, + "webServerNetworkAccessControl": { + "$ref": "WebServerNetworkAccessControl", + "description": "Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied." } }, "type": "object" @@ -522,6 +602,10 @@ "description": "ImageVersion information", "id": "ImageVersion", "properties": { + "creationDisabled": { + "description": "Whether it is impossible to create an environment with the image version.", + "type": "boolean" + }, "imageVersionId": { "description": "The string identifier of the ImageVersion, in the form: \"composer-x.y.z-airflow-a.b(.c)\"", "type": "string" @@ -530,12 +614,20 @@ "description": "Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified.", "type": "boolean" }, + "releaseDate": { + "$ref": "Date", + "description": "The date of the version release." + }, "supportedPythonVersions": { "description": "supported python versions", "items": { "type": "string" }, "type": "array" + }, + "upgradeDisabled": { + "description": "Whether it is impossible to upgrade an environment running with the image version.", + "type": "boolean" } }, "type": "object" @@ -616,7 +708,7 @@ "type": "string" }, "network": { - "description": "Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: \"projects/{projectId}/global/networks/{networkId}\". [Shared VPC](/vpc/docs/shared-vpc) is not currently supported. The network must belong to the environment's project. If unspecified, the \"default\" network ID in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided.", + "description": "Optional. The Compute Engine network to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: \"projects/{projectId}/global/networks/{networkId}\". If unspecified, the \"default\" network ID in the environment's project is used. If a [Custom Subnet Network](/vpc/docs/vpc#vpc_networks_and_subnets) is provided, `nodeConfig.subnetwork` must also be provided. For [Shared VPC](/vpc/docs/shared-vpc) subnetwork requirements, see `nodeConfig.subnetwork`.", "type": "string" }, "oauthScopes": { @@ -850,6 +942,31 @@ } }, "type": "object" + }, + "WebServerConfig": { + "description": "The configuration settings for the Airflow web server App Engine instance.", + "id": "WebServerConfig", + "properties": { + "machineType": { + "description": "Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.", + "type": "string" + } + }, + "type": "object" + }, + "WebServerNetworkAccessControl": { + "description": "Network-level access control policy for the Airflow web server.", + "id": "WebServerNetworkAccessControl", + "properties": { + "allowedIpRanges": { + "description": "A collection of allowed IP ranges with descriptions.", + "items": { + "$ref": "AllowedIpRange" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/compute__v1.json b/discovery/googleapis/compute__v1.json index 3bae347..00bdaa1 100644 --- a/discovery/googleapis/compute__v1.json +++ b/discovery/googleapis/compute__v1.json
@@ -23,13 +23,13 @@ } } }, - "basePath": "/compute/v1/projects/", - "baseUrl": "https://compute.googleapis.com/compute/v1/projects/", + "basePath": "/compute/v1/", + "baseUrl": "https://compute.googleapis.com/compute/v1/", "batchPath": "batch/compute/v1", "description": "Creates and runs virtual machines on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", - "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/OX8dix4-_3vK-G_BY-58qfB_C1I\"", + "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/mIZBtT5XI04WAMcpQOOpJwzHbMk\"", "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" @@ -137,7 +137,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/acceleratorTypes", + "path": "projects/{project}/aggregated/acceleratorTypes", "response": { "$ref": "AcceleratorTypeAggregatedList" }, @@ -179,7 +179,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/acceleratorTypes/{acceleratorType}", + "path": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}", "response": { "$ref": "AcceleratorType" }, @@ -241,7 +241,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/acceleratorTypes", + "path": "projects/{project}/zones/{zone}/acceleratorTypes", "response": { "$ref": "AcceleratorTypeList" }, @@ -304,7 +304,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/addresses", + "path": "projects/{project}/aggregated/addresses", "response": { "$ref": "AddressAggregatedList" }, @@ -351,7 +351,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/addresses/{address}", + "path": "projects/{project}/regions/{region}/addresses/{address}", "response": { "$ref": "Operation" }, @@ -392,7 +392,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/addresses/{address}", + "path": "projects/{project}/regions/{region}/addresses/{address}", "response": { "$ref": "Address" }, @@ -431,7 +431,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/addresses", + "path": "projects/{project}/regions/{region}/addresses", "request": { "$ref": "Address" }, @@ -495,7 +495,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/addresses", + "path": "projects/{project}/regions/{region}/addresses", "response": { "$ref": "AddressList" }, @@ -558,7 +558,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/autoscalers", + "path": "projects/{project}/aggregated/autoscalers", "response": { "$ref": "AutoscalerAggregatedList" }, @@ -605,7 +605,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/autoscalers/{autoscaler}", + "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", "response": { "$ref": "Operation" }, @@ -646,7 +646,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/autoscalers/{autoscaler}", + "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", "response": { "$ref": "Autoscaler" }, @@ -685,7 +685,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/autoscalers", + "path": "projects/{project}/zones/{zone}/autoscalers", "request": { "$ref": "Autoscaler" }, @@ -749,7 +749,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/autoscalers", + "path": "projects/{project}/zones/{zone}/autoscalers", "response": { "$ref": "AutoscalerList" }, @@ -794,7 +794,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/autoscalers", + "path": "projects/{project}/zones/{zone}/autoscalers", "request": { "$ref": "Autoscaler" }, @@ -841,7 +841,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/autoscalers", + "path": "projects/{project}/zones/{zone}/autoscalers", "request": { "$ref": "Autoscaler" }, @@ -885,7 +885,7 @@ "type": "string" } }, - "path": "{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey", + "path": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey", "request": { "$ref": "SignedUrlKey" }, @@ -926,7 +926,7 @@ "type": "string" } }, - "path": "{project}/global/backendBuckets/{backendBucket}", + "path": "projects/{project}/global/backendBuckets/{backendBucket}", "response": { "$ref": "Operation" }, @@ -970,7 +970,7 @@ "type": "string" } }, - "path": "{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey", + "path": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey", "response": { "$ref": "Operation" }, @@ -1003,7 +1003,7 @@ "type": "string" } }, - "path": "{project}/global/backendBuckets/{backendBucket}", + "path": "projects/{project}/global/backendBuckets/{backendBucket}", "response": { "$ref": "BackendBucket" }, @@ -1034,7 +1034,7 @@ "type": "string" } }, - "path": "{project}/global/backendBuckets", + "path": "projects/{project}/global/backendBuckets", "request": { "$ref": "BackendBucket" }, @@ -1090,7 +1090,7 @@ "type": "boolean" } }, - "path": "{project}/global/backendBuckets", + "path": "projects/{project}/global/backendBuckets", "response": { "$ref": "BackendBucketList" }, @@ -1129,7 +1129,7 @@ "type": "string" } }, - "path": "{project}/global/backendBuckets/{backendBucket}", + "path": "projects/{project}/global/backendBuckets/{backendBucket}", "request": { "$ref": "BackendBucket" }, @@ -1170,7 +1170,7 @@ "type": "string" } }, - "path": "{project}/global/backendBuckets/{backendBucket}", + "path": "projects/{project}/global/backendBuckets/{backendBucket}", "request": { "$ref": "BackendBucket" }, @@ -1214,7 +1214,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}/addSignedUrlKey", + "path": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey", "request": { "$ref": "SignedUrlKey" }, @@ -1275,7 +1275,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/backendServices", + "path": "projects/{project}/aggregated/backendServices", "response": { "$ref": "BackendServiceAggregatedList" }, @@ -1314,7 +1314,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}", + "path": "projects/{project}/global/backendServices/{backendService}", "response": { "$ref": "Operation" }, @@ -1358,7 +1358,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}/deleteSignedUrlKey", + "path": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey", "response": { "$ref": "Operation" }, @@ -1391,7 +1391,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}", + "path": "projects/{project}/global/backendServices/{backendService}", "response": { "$ref": "BackendService" }, @@ -1424,7 +1424,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}/getHealth", + "path": "projects/{project}/global/backendServices/{backendService}/getHealth", "request": { "$ref": "ResourceGroupReference" }, @@ -1458,7 +1458,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices", + "path": "projects/{project}/global/backendServices", "request": { "$ref": "BackendService" }, @@ -1514,7 +1514,7 @@ "type": "boolean" } }, - "path": "{project}/global/backendServices", + "path": "projects/{project}/global/backendServices", "response": { "$ref": "BackendServiceList" }, @@ -1553,7 +1553,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}", + "path": "projects/{project}/global/backendServices/{backendService}", "request": { "$ref": "BackendService" }, @@ -1593,7 +1593,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}/setSecurityPolicy", + "path": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy", "request": { "$ref": "SecurityPolicyReference" }, @@ -1634,7 +1634,7 @@ "type": "string" } }, - "path": "{project}/global/backendServices/{backendService}", + "path": "projects/{project}/global/backendServices/{backendService}", "request": { "$ref": "BackendService" }, @@ -1699,7 +1699,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/diskTypes", + "path": "projects/{project}/aggregated/diskTypes", "response": { "$ref": "DiskTypeAggregatedList" }, @@ -1741,7 +1741,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/diskTypes/{diskType}", + "path": "projects/{project}/zones/{zone}/diskTypes/{diskType}", "response": { "$ref": "DiskType" }, @@ -1803,7 +1803,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/diskTypes", + "path": "projects/{project}/zones/{zone}/diskTypes", "response": { "$ref": "DiskTypeList" }, @@ -1854,7 +1854,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{disk}/addResourcePolicies", + "path": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", "request": { "$ref": "DisksAddResourcePoliciesRequest" }, @@ -1915,7 +1915,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/disks", + "path": "projects/{project}/aggregated/disks", "response": { "$ref": "DiskAggregatedList" }, @@ -1967,7 +1967,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{disk}/createSnapshot", + "path": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", "request": { "$ref": "Snapshot" }, @@ -2015,7 +2015,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{disk}", + "path": "projects/{project}/zones/{zone}/disks/{disk}", "response": { "$ref": "Operation" }, @@ -2056,7 +2056,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{disk}", + "path": "projects/{project}/zones/{zone}/disks/{disk}", "response": { "$ref": "Disk" }, @@ -2104,7 +2104,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{resource}/getIamPolicy", + "path": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -2136,7 +2136,7 @@ "type": "string" }, "sourceImage": { - "description": "Optional. Source image to restore onto a disk.", + "description": "Source image to restore onto a disk. This field is optional.", "location": "query", "type": "string" }, @@ -2148,7 +2148,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks", + "path": "projects/{project}/zones/{zone}/disks", "request": { "$ref": "Disk" }, @@ -2212,7 +2212,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks", + "path": "projects/{project}/zones/{zone}/disks", "response": { "$ref": "DiskList" }, @@ -2259,7 +2259,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{disk}/removeResourcePolicies", + "path": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies", "request": { "$ref": "DisksRemoveResourcePoliciesRequest" }, @@ -2308,7 +2308,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{disk}/resize", + "path": "projects/{project}/zones/{zone}/disks/{disk}/resize", "request": { "$ref": "DisksResizeRequest" }, @@ -2352,7 +2352,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{resource}/setIamPolicy", + "path": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy", "request": { "$ref": "ZoneSetPolicyRequest" }, @@ -2401,7 +2401,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{resource}/setLabels", + "path": "projects/{project}/zones/{zone}/disks/{resource}/setLabels", "request": { "$ref": "ZoneSetLabelsRequest" }, @@ -2445,7 +2445,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/disks/{resource}/testIamPermissions", + "path": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -2491,7 +2491,7 @@ "type": "string" } }, - "path": "{project}/global/externalVpnGateways/{externalVpnGateway}", + "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", "response": { "$ref": "Operation" }, @@ -2524,7 +2524,7 @@ "type": "string" } }, - "path": "{project}/global/externalVpnGateways/{externalVpnGateway}", + "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", "response": { "$ref": "ExternalVpnGateway" }, @@ -2555,7 +2555,7 @@ "type": "string" } }, - "path": "{project}/global/externalVpnGateways", + "path": "projects/{project}/global/externalVpnGateways", "request": { "$ref": "ExternalVpnGateway" }, @@ -2611,7 +2611,7 @@ "type": "boolean" } }, - "path": "{project}/global/externalVpnGateways", + "path": "projects/{project}/global/externalVpnGateways", "response": { "$ref": "ExternalVpnGatewayList" }, @@ -2645,7 +2645,7 @@ "type": "string" } }, - "path": "{project}/global/externalVpnGateways/{resource}/setLabels", + "path": "projects/{project}/global/externalVpnGateways/{resource}/setLabels", "request": { "$ref": "GlobalSetLabelsRequest" }, @@ -2681,7 +2681,600 @@ "type": "string" } }, - "path": "{project}/global/externalVpnGateways/{resource}/testIamPermissions", + "path": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "firewallPolicies": { + "methods": { + "addAssociation": { + "description": "Inserts an association for the specified firewall policy.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.addAssociation", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "replaceExistingAssociation": { + "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.", + "location": "query", + "type": "boolean" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation", + "request": { + "$ref": "FirewallPolicyAssociation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "addRule": { + "description": "Inserts a rule into a firewall policy.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.addRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/addRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "cloneRules": { + "description": "Copies rules to the specified firewall policy.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.cloneRules", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "sourceFirewallPolicy": { + "description": "The firewall policy from which to copy rules.", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes the specified policy.", + "httpMethod": "DELETE", + "id": "compute.firewallPolicies.delete", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to delete.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified firewall policy.", + "httpMethod": "GET", + "id": "compute.firewallPolicies.get", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to get.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}", + "response": { + "$ref": "FirewallPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getAssociation": { + "description": "Gets an association with the specified name.", + "httpMethod": "GET", + "id": "compute.firewallPolicies.getAssociation", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to which the queried rule belongs.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "name": { + "description": "The name of the association to get from the firewall policy.", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation", + "response": { + "$ref": "FirewallPolicyAssociation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "httpMethod": "GET", + "id": "compute.firewallPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{resource}/getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getRule": { + "description": "Gets a rule of the specified priority.", + "httpMethod": "GET", + "id": "compute.firewallPolicies.getRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to which the queried rule belongs.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to get from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/getRule", + "response": { + "$ref": "FirewallPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new policy in the specified project using the data included in the request.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.insert", + "parameters": { + "parentId": { + "description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies", + "request": { + "$ref": "FirewallPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists all the policies that have been configured for the specified project.", + "httpMethod": "GET", + "id": "compute.firewallPolicies.list", + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "parentId": { + "description": "Parent ID for this request.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.", + "location": "query", + "type": "boolean" + } + }, + "path": "locations/global/firewallPolicies", + "response": { + "$ref": "FirewallPolicyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "listAssociations": { + "description": "Lists associations of a specified target, i.e., organization or folder.", + "httpMethod": "GET", + "id": "compute.firewallPolicies.listAssociations", + "parameters": { + "targetResource": { + "description": "The target resource to list associations. It is an organization, or a folder.", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/listAssociations", + "response": { + "$ref": "FirewallPoliciesListAssociationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "move": { + "description": "Moves the specified firewall policy.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.move", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "parentId": { + "description": "The new parent of the firewall policy.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/move", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "patch": { + "description": "Patches the specified policy with the data included in the request.", + "httpMethod": "PATCH", + "id": "compute.firewallPolicies.patch", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}", + "request": { + "$ref": "FirewallPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "patchRule": { + "description": "Patches a rule of the specified priority.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.patchRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "removeAssociation": { + "description": "Removes an association for the specified firewall policy.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.removeAssociation", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "name": { + "description": "Name for the attachment that will be removed.", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "removeRule": { + "description": "Deletes a rule of the specified priority.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.removeRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to remove from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{resource}/setIamPolicy", + "request": { + "$ref": "GlobalOrganizationSetPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "httpMethod": "POST", + "id": "compute.firewallPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + } + }, + "path": "locations/global/firewallPolicies/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -2727,7 +3320,7 @@ "type": "string" } }, - "path": "{project}/global/firewalls/{firewall}", + "path": "projects/{project}/global/firewalls/{firewall}", "response": { "$ref": "Operation" }, @@ -2760,7 +3353,7 @@ "type": "string" } }, - "path": "{project}/global/firewalls/{firewall}", + "path": "projects/{project}/global/firewalls/{firewall}", "response": { "$ref": "Firewall" }, @@ -2791,7 +3384,7 @@ "type": "string" } }, - "path": "{project}/global/firewalls", + "path": "projects/{project}/global/firewalls", "request": { "$ref": "Firewall" }, @@ -2847,7 +3440,7 @@ "type": "boolean" } }, - "path": "{project}/global/firewalls", + "path": "projects/{project}/global/firewalls", "response": { "$ref": "FirewallList" }, @@ -2886,7 +3479,7 @@ "type": "string" } }, - "path": "{project}/global/firewalls/{firewall}", + "path": "projects/{project}/global/firewalls/{firewall}", "request": { "$ref": "Firewall" }, @@ -2927,7 +3520,7 @@ "type": "string" } }, - "path": "{project}/global/firewalls/{firewall}", + "path": "projects/{project}/global/firewalls/{firewall}", "request": { "$ref": "Firewall" }, @@ -2992,7 +3585,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/forwardingRules", + "path": "projects/{project}/aggregated/forwardingRules", "response": { "$ref": "ForwardingRuleAggregatedList" }, @@ -3039,7 +3632,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}", + "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "response": { "$ref": "Operation" }, @@ -3080,7 +3673,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}", + "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "response": { "$ref": "ForwardingRule" }, @@ -3119,7 +3712,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/forwardingRules", + "path": "projects/{project}/regions/{region}/forwardingRules", "request": { "$ref": "ForwardingRule" }, @@ -3183,7 +3776,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/forwardingRules", + "path": "projects/{project}/regions/{region}/forwardingRules", "response": { "$ref": "ForwardingRuleList" }, @@ -3230,7 +3823,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}", + "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "request": { "$ref": "ForwardingRule" }, @@ -3242,6 +3835,55 @@ "https://www.googleapis.com/auth/compute" ] }, + "setLabels": { + "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.", + "httpMethod": "POST", + "id": "compute.forwardingRules.setLabels", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels", + "request": { + "$ref": "RegionSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setTarget": { "description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target.", "httpMethod": "POST", @@ -3279,7 +3921,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget", + "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget", "request": { "$ref": "TargetReference" }, @@ -3324,7 +3966,7 @@ "type": "string" } }, - "path": "{project}/global/addresses/{address}", + "path": "projects/{project}/global/addresses/{address}", "response": { "$ref": "Operation" }, @@ -3357,7 +3999,7 @@ "type": "string" } }, - "path": "{project}/global/addresses/{address}", + "path": "projects/{project}/global/addresses/{address}", "response": { "$ref": "Address" }, @@ -3388,7 +4030,7 @@ "type": "string" } }, - "path": "{project}/global/addresses", + "path": "projects/{project}/global/addresses", "request": { "$ref": "Address" }, @@ -3444,7 +4086,7 @@ "type": "boolean" } }, - "path": "{project}/global/addresses", + "path": "projects/{project}/global/addresses", "response": { "$ref": "AddressList" }, @@ -3487,7 +4129,7 @@ "type": "string" } }, - "path": "{project}/global/forwardingRules/{forwardingRule}", + "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "response": { "$ref": "Operation" }, @@ -3520,7 +4162,7 @@ "type": "string" } }, - "path": "{project}/global/forwardingRules/{forwardingRule}", + "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "response": { "$ref": "ForwardingRule" }, @@ -3551,7 +4193,7 @@ "type": "string" } }, - "path": "{project}/global/forwardingRules", + "path": "projects/{project}/global/forwardingRules", "request": { "$ref": "ForwardingRule" }, @@ -3607,7 +4249,7 @@ "type": "boolean" } }, - "path": "{project}/global/forwardingRules", + "path": "projects/{project}/global/forwardingRules", "response": { "$ref": "ForwardingRuleList" }, @@ -3646,7 +4288,7 @@ "type": "string" } }, - "path": "{project}/global/forwardingRules/{forwardingRule}", + "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "request": { "$ref": "ForwardingRule" }, @@ -3658,6 +4300,42 @@ "https://www.googleapis.com/auth/compute" ] }, + "setLabels": { + "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.", + "httpMethod": "POST", + "id": "compute.globalForwardingRules.setLabels", + "parameterOrder": [ + "project", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/forwardingRules/{resource}/setLabels", + "request": { + "$ref": "GlobalSetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setTarget": { "description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.", "httpMethod": "POST", @@ -3687,7 +4365,7 @@ "type": "string" } }, - "path": "{project}/global/forwardingRules/{forwardingRule}/setTarget", + "path": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", "request": { "$ref": "TargetReference" }, @@ -3731,7 +4409,7 @@ "type": "string" } }, - "path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "request": { "$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest" }, @@ -3771,7 +4449,7 @@ "type": "string" } }, - "path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", "response": { "$ref": "Operation" }, @@ -3808,7 +4486,7 @@ "type": "string" } }, - "path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "request": { "$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest" }, @@ -3843,7 +4521,7 @@ "type": "string" } }, - "path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}", + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", "response": { "$ref": "NetworkEndpointGroup" }, @@ -3874,7 +4552,7 @@ "type": "string" } }, - "path": "{project}/global/networkEndpointGroups", + "path": "projects/{project}/global/networkEndpointGroups", "request": { "$ref": "NetworkEndpointGroup" }, @@ -3930,7 +4608,7 @@ "type": "boolean" } }, - "path": "{project}/global/networkEndpointGroups", + "path": "projects/{project}/global/networkEndpointGroups", "response": { "$ref": "NetworkEndpointGroupList" }, @@ -3991,7 +4669,7 @@ "type": "boolean" } }, - "path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", + "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "response": { "$ref": "NetworkEndpointGroupsListNetworkEndpoints" }, @@ -4054,7 +4732,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/operations", + "path": "projects/{project}/aggregated/operations", "response": { "$ref": "OperationAggregatedList" }, @@ -4088,7 +4766,7 @@ "type": "string" } }, - "path": "{project}/global/operations/{operation}", + "path": "projects/{project}/global/operations/{operation}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" @@ -4118,7 +4796,7 @@ "type": "string" } }, - "path": "{project}/global/operations/{operation}", + "path": "projects/{project}/global/operations/{operation}", "response": { "$ref": "Operation" }, @@ -4172,7 +4850,7 @@ "type": "boolean" } }, - "path": "{project}/global/operations", + "path": "projects/{project}/global/operations", "response": { "$ref": "OperationList" }, @@ -4206,7 +4884,7 @@ "type": "string" } }, - "path": "{project}/global/operations/{operation}/wait", + "path": "projects/{project}/global/operations/{operation}/wait", "response": { "$ref": "Operation" }, @@ -4218,6 +4896,117 @@ } } }, + "globalOrganizationOperations": { + "methods": { + "delete": { + "description": "Deletes the specified Operations resource.", + "httpMethod": "DELETE", + "id": "compute.globalOrganizationOperations.delete", + "parameterOrder": [ + "operation" + ], + "parameters": { + "operation": { + "description": "Name of the Operations resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "parentId": { + "description": "Parent ID for this request.", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/operations/{operation}", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.", + "httpMethod": "GET", + "id": "compute.globalOrganizationOperations.get", + "parameterOrder": [ + "operation" + ], + "parameters": { + "operation": { + "description": "Name of the Operations resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "parentId": { + "description": "Parent ID for this request.", + "location": "query", + "type": "string" + } + }, + "path": "locations/global/operations/{operation}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Retrieves a list of Operation resources contained within the specified organization.", + "httpMethod": "GET", + "id": "compute.globalOrganizationOperations.list", + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "parentId": { + "description": "Parent ID for this request.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.", + "location": "query", + "type": "boolean" + } + }, + "path": "locations/global/operations", + "response": { + "$ref": "OperationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "healthChecks": { "methods": { "aggregatedList": { @@ -4269,7 +5058,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/healthChecks", + "path": "projects/{project}/aggregated/healthChecks", "response": { "$ref": "HealthChecksAggregatedList" }, @@ -4308,7 +5097,7 @@ "type": "string" } }, - "path": "{project}/global/healthChecks/{healthCheck}", + "path": "projects/{project}/global/healthChecks/{healthCheck}", "response": { "$ref": "Operation" }, @@ -4341,7 +5130,7 @@ "type": "string" } }, - "path": "{project}/global/healthChecks/{healthCheck}", + "path": "projects/{project}/global/healthChecks/{healthCheck}", "response": { "$ref": "HealthCheck" }, @@ -4372,7 +5161,7 @@ "type": "string" } }, - "path": "{project}/global/healthChecks", + "path": "projects/{project}/global/healthChecks", "request": { "$ref": "HealthCheck" }, @@ -4428,7 +5217,7 @@ "type": "boolean" } }, - "path": "{project}/global/healthChecks", + "path": "projects/{project}/global/healthChecks", "response": { "$ref": "HealthCheckList" }, @@ -4467,7 +5256,7 @@ "type": "string" } }, - "path": "{project}/global/healthChecks/{healthCheck}", + "path": "projects/{project}/global/healthChecks/{healthCheck}", "request": { "$ref": "HealthCheck" }, @@ -4508,7 +5297,7 @@ "type": "string" } }, - "path": "{project}/global/healthChecks/{healthCheck}", + "path": "projects/{project}/global/healthChecks/{healthCheck}", "request": { "$ref": "HealthCheck" }, @@ -4553,7 +5342,7 @@ "type": "string" } }, - "path": "{project}/global/httpHealthChecks/{httpHealthCheck}", + "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "response": { "$ref": "Operation" }, @@ -4586,7 +5375,7 @@ "type": "string" } }, - "path": "{project}/global/httpHealthChecks/{httpHealthCheck}", + "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "response": { "$ref": "HttpHealthCheck" }, @@ -4617,7 +5406,7 @@ "type": "string" } }, - "path": "{project}/global/httpHealthChecks", + "path": "projects/{project}/global/httpHealthChecks", "request": { "$ref": "HttpHealthCheck" }, @@ -4673,7 +5462,7 @@ "type": "boolean" } }, - "path": "{project}/global/httpHealthChecks", + "path": "projects/{project}/global/httpHealthChecks", "response": { "$ref": "HttpHealthCheckList" }, @@ -4712,7 +5501,7 @@ "type": "string" } }, - "path": "{project}/global/httpHealthChecks/{httpHealthCheck}", + "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "request": { "$ref": "HttpHealthCheck" }, @@ -4753,7 +5542,7 @@ "type": "string" } }, - "path": "{project}/global/httpHealthChecks/{httpHealthCheck}", + "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "request": { "$ref": "HttpHealthCheck" }, @@ -4798,7 +5587,7 @@ "type": "string" } }, - "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}", + "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "response": { "$ref": "Operation" }, @@ -4831,7 +5620,7 @@ "type": "string" } }, - "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}", + "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "response": { "$ref": "HttpsHealthCheck" }, @@ -4862,7 +5651,7 @@ "type": "string" } }, - "path": "{project}/global/httpsHealthChecks", + "path": "projects/{project}/global/httpsHealthChecks", "request": { "$ref": "HttpsHealthCheck" }, @@ -4918,7 +5707,7 @@ "type": "boolean" } }, - "path": "{project}/global/httpsHealthChecks", + "path": "projects/{project}/global/httpsHealthChecks", "response": { "$ref": "HttpsHealthCheckList" }, @@ -4957,7 +5746,7 @@ "type": "string" } }, - "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}", + "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "request": { "$ref": "HttpsHealthCheck" }, @@ -4998,7 +5787,7 @@ "type": "string" } }, - "path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}", + "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "request": { "$ref": "HttpsHealthCheck" }, @@ -5043,7 +5832,7 @@ "type": "string" } }, - "path": "{project}/global/images/{image}", + "path": "projects/{project}/global/images/{image}", "response": { "$ref": "Operation" }, @@ -5081,7 +5870,7 @@ "type": "string" } }, - "path": "{project}/global/images/{image}/deprecate", + "path": "projects/{project}/global/images/{image}/deprecate", "request": { "$ref": "DeprecationStatus" }, @@ -5117,7 +5906,7 @@ "type": "string" } }, - "path": "{project}/global/images/{image}", + "path": "projects/{project}/global/images/{image}", "response": { "$ref": "Image" }, @@ -5151,7 +5940,7 @@ "type": "string" } }, - "path": "{project}/global/images/family/{family}", + "path": "projects/{project}/global/images/family/{family}", "response": { "$ref": "Image" }, @@ -5191,7 +5980,7 @@ "type": "string" } }, - "path": "{project}/global/images/{resource}/getIamPolicy", + "path": "projects/{project}/global/images/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -5227,7 +6016,7 @@ "type": "string" } }, - "path": "{project}/global/images", + "path": "projects/{project}/global/images", "request": { "$ref": "Image" }, @@ -5286,7 +6075,7 @@ "type": "boolean" } }, - "path": "{project}/global/images", + "path": "projects/{project}/global/images", "response": { "$ref": "ImageList" }, @@ -5325,7 +6114,7 @@ "type": "string" } }, - "path": "{project}/global/images/{image}", + "path": "projects/{project}/global/images/{image}", "request": { "$ref": "Image" }, @@ -5361,7 +6150,7 @@ "type": "string" } }, - "path": "{project}/global/images/{resource}/setIamPolicy", + "path": "projects/{project}/global/images/{resource}/setIamPolicy", "request": { "$ref": "GlobalSetPolicyRequest" }, @@ -5397,7 +6186,7 @@ "type": "string" } }, - "path": "{project}/global/images/{resource}/setLabels", + "path": "projects/{project}/global/images/{resource}/setLabels", "request": { "$ref": "GlobalSetLabelsRequest" }, @@ -5433,7 +6222,7 @@ "type": "string" } }, - "path": "{project}/global/images/{resource}/testIamPermissions", + "path": "projects/{project}/global/images/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -5485,7 +6274,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", "request": { "$ref": "InstanceGroupManagersAbandonInstancesRequest" }, @@ -5546,7 +6335,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/instanceGroupManagers", + "path": "projects/{project}/aggregated/instanceGroupManagers", "response": { "$ref": "InstanceGroupManagerAggregatedList" }, @@ -5586,7 +6375,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", "request": { "$ref": "InstanceGroupManagersApplyUpdatesRequest" }, @@ -5633,7 +6422,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", "request": { "$ref": "InstanceGroupManagersCreateInstancesRequest" }, @@ -5680,7 +6469,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "response": { "$ref": "Operation" }, @@ -5724,7 +6513,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", "request": { "$ref": "InstanceGroupManagersDeleteInstancesRequest" }, @@ -5766,7 +6555,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", "request": { "$ref": "InstanceGroupManagersDeletePerInstanceConfigsReq" }, @@ -5808,7 +6597,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "response": { "$ref": "InstanceGroupManager" }, @@ -5846,7 +6635,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers", "request": { "$ref": "InstanceGroupManager" }, @@ -5909,7 +6698,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers", "response": { "$ref": "InstanceGroupManagerList" }, @@ -5977,7 +6766,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors", "response": { "$ref": "InstanceGroupManagersListErrorsResponse" }, @@ -6045,7 +6834,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "response": { "$ref": "InstanceGroupManagersListManagedInstancesResponse" }, @@ -6113,7 +6902,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", "response": { "$ref": "InstanceGroupManagersListPerInstanceConfigsResp" }, @@ -6158,7 +6947,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "request": { "$ref": "InstanceGroupManager" }, @@ -6205,7 +6994,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", "request": { "$ref": "InstanceGroupManagersPatchPerInstanceConfigsReq" }, @@ -6252,7 +7041,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", "request": { "$ref": "InstanceGroupManagersRecreateInstancesRequest" }, @@ -6307,7 +7096,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize", "response": { "$ref": "Operation" }, @@ -6317,7 +7106,7 @@ ] }, "setInstanceTemplate": { - "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.", + "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "httpMethod": "POST", "id": "compute.instanceGroupManagers.setInstanceTemplate", "parameterOrder": [ @@ -6351,7 +7140,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", "request": { "$ref": "InstanceGroupManagersSetInstanceTemplateRequest" }, @@ -6398,7 +7187,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", "request": { "$ref": "InstanceGroupManagersSetTargetPoolsRequest" }, @@ -6445,7 +7234,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "request": { "$ref": "InstanceGroupManagersUpdatePerInstanceConfigsReq" }, @@ -6496,7 +7285,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", "request": { "$ref": "InstanceGroupsAddInstancesRequest" }, @@ -6557,7 +7346,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/instanceGroups", + "path": "projects/{project}/aggregated/instanceGroups", "response": { "$ref": "InstanceGroupAggregatedList" }, @@ -6602,7 +7391,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}", + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "response": { "$ref": "Operation" }, @@ -6641,7 +7430,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}", + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "response": { "$ref": "InstanceGroup" }, @@ -6679,7 +7468,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups", + "path": "projects/{project}/zones/{zone}/instanceGroups", "request": { "$ref": "InstanceGroup" }, @@ -6742,7 +7531,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups", + "path": "projects/{project}/zones/{zone}/instanceGroups", "response": { "$ref": "InstanceGroupList" }, @@ -6810,7 +7599,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances", + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances", "request": { "$ref": "InstanceGroupsListInstancesRequest" }, @@ -6858,7 +7647,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances", + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances", "request": { "$ref": "InstanceGroupsRemoveInstancesRequest" }, @@ -6905,7 +7694,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", + "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", "request": { "$ref": "InstanceGroupsSetNamedPortsRequest" }, @@ -6950,7 +7739,7 @@ "type": "string" } }, - "path": "{project}/global/instanceTemplates/{instanceTemplate}", + "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", "response": { "$ref": "Operation" }, @@ -6983,7 +7772,7 @@ "type": "string" } }, - "path": "{project}/global/instanceTemplates/{instanceTemplate}", + "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", "response": { "$ref": "InstanceTemplate" }, @@ -7023,7 +7812,7 @@ "type": "string" } }, - "path": "{project}/global/instanceTemplates/{resource}/getIamPolicy", + "path": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -7054,7 +7843,7 @@ "type": "string" } }, - "path": "{project}/global/instanceTemplates", + "path": "projects/{project}/global/instanceTemplates", "request": { "$ref": "InstanceTemplate" }, @@ -7110,7 +7899,7 @@ "type": "boolean" } }, - "path": "{project}/global/instanceTemplates", + "path": "projects/{project}/global/instanceTemplates", "response": { "$ref": "InstanceTemplateList" }, @@ -7144,7 +7933,7 @@ "type": "string" } }, - "path": "{project}/global/instanceTemplates/{resource}/setIamPolicy", + "path": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy", "request": { "$ref": "GlobalSetPolicyRequest" }, @@ -7180,7 +7969,7 @@ "type": "string" } }, - "path": "{project}/global/instanceTemplates/{resource}/testIamPermissions", + "path": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -7241,7 +8030,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/addAccessConfig", + "path": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig", "request": { "$ref": "AccessConfig" }, @@ -7290,7 +8079,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/addResourcePolicies", + "path": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", "request": { "$ref": "InstancesAddResourcePoliciesRequest" }, @@ -7351,7 +8140,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/instances", + "path": "projects/{project}/aggregated/instances", "response": { "$ref": "InstanceAggregatedList" }, @@ -7403,7 +8192,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/attachDisk", + "path": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk", "request": { "$ref": "AttachedDisk" }, @@ -7452,7 +8241,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}", + "path": "projects/{project}/zones/{zone}/instances/{instance}", "response": { "$ref": "Operation" }, @@ -7512,7 +8301,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig", + "path": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig", "response": { "$ref": "Operation" }, @@ -7565,7 +8354,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/detachDisk", + "path": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk", "response": { "$ref": "Operation" }, @@ -7606,7 +8395,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}", + "path": "projects/{project}/zones/{zone}/instances/{instance}", "response": { "$ref": "Instance" }, @@ -7658,7 +8447,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/getGuestAttributes", + "path": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes", "response": { "$ref": "GuestAttributes" }, @@ -7706,7 +8495,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{resource}/getIamPolicy", + "path": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -7748,7 +8537,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/screenshot", + "path": "projects/{project}/zones/{zone}/instances/{instance}/screenshot", "response": { "$ref": "Screenshot" }, @@ -7805,7 +8594,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/serialPort", + "path": "projects/{project}/zones/{zone}/instances/{instance}/serialPort", "response": { "$ref": "SerialPortOutput" }, @@ -7847,7 +8636,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity", + "path": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity", "response": { "$ref": "ShieldedInstanceIdentity" }, @@ -7891,7 +8680,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances", + "path": "projects/{project}/zones/{zone}/instances", "request": { "$ref": "Instance" }, @@ -7955,7 +8744,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances", + "path": "projects/{project}/zones/{zone}/instances", "response": { "$ref": "InstanceList" }, @@ -7966,7 +8755,7 @@ ] }, "listReferrers": { - "description": "Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed instance group, the referrers list includes the managed instance group. For more information, read Viewing Referrers to VM Instances.", + "description": "Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.", "httpMethod": "GET", "id": "compute.instances.listReferrers", "parameterOrder": [ @@ -8025,7 +8814,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/referrers", + "path": "projects/{project}/zones/{zone}/instances/{instance}/referrers", "response": { "$ref": "InstanceListReferrers" }, @@ -8072,7 +8861,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/removeResourcePolicies", + "path": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies", "request": { "$ref": "InstancesRemoveResourcePoliciesRequest" }, @@ -8121,7 +8910,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/reset", + "path": "projects/{project}/zones/{zone}/instances/{instance}/reset", "response": { "$ref": "Operation" }, @@ -8173,7 +8962,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{resource}/setDeletionProtection", + "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection", "response": { "$ref": "Operation" }, @@ -8234,7 +9023,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", "response": { "$ref": "Operation" }, @@ -8275,7 +9064,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{resource}/setIamPolicy", + "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", "request": { "$ref": "ZoneSetPolicyRequest" }, @@ -8324,7 +9113,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setLabels", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels", "request": { "$ref": "InstancesSetLabelsRequest" }, @@ -8373,7 +9162,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setMachineResources", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources", "request": { "$ref": "InstancesSetMachineResourcesRequest" }, @@ -8422,7 +9211,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setMachineType", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType", "request": { "$ref": "InstancesSetMachineTypeRequest" }, @@ -8471,7 +9260,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setMetadata", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata", "request": { "$ref": "Metadata" }, @@ -8520,7 +9309,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform", "request": { "$ref": "InstancesSetMinCpuPlatformRequest" }, @@ -8569,7 +9358,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setScheduling", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling", "request": { "$ref": "Scheduling" }, @@ -8618,7 +9407,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setServiceAccount", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount", "request": { "$ref": "InstancesSetServiceAccountRequest" }, @@ -8667,7 +9456,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy", "request": { "$ref": "ShieldedInstanceIntegrityPolicy" }, @@ -8716,7 +9505,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/setTags", + "path": "projects/{project}/zones/{zone}/instances/{instance}/setTags", "request": { "$ref": "Tags" }, @@ -8760,7 +9549,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent", + "path": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent", "response": { "$ref": "Operation" }, @@ -8806,7 +9595,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/start", + "path": "projects/{project}/zones/{zone}/instances/{instance}/start", "response": { "$ref": "Operation" }, @@ -8852,7 +9641,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey", + "path": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey", "request": { "$ref": "InstancesStartWithEncryptionKeyRequest" }, @@ -8901,7 +9690,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/stop", + "path": "projects/{project}/zones/{zone}/instances/{instance}/stop", "response": { "$ref": "Operation" }, @@ -8942,7 +9731,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{resource}/testIamPermissions", + "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -9026,7 +9815,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}", + "path": "projects/{project}/zones/{zone}/instances/{instance}", "request": { "$ref": "Instance" }, @@ -9082,7 +9871,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/updateAccessConfig", + "path": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig", "request": { "$ref": "AccessConfig" }, @@ -9131,7 +9920,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/updateDisplayDevice", + "path": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice", "request": { "$ref": "DisplayDevice" }, @@ -9144,7 +9933,7 @@ ] }, "updateNetworkInterface": { - "description": "Updates an instance's network interface. This method follows PATCH semantics.", + "description": "Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.", "httpMethod": "PATCH", "id": "compute.instances.updateNetworkInterface", "parameterOrder": [ @@ -9187,7 +9976,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/updateNetworkInterface", + "path": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface", "request": { "$ref": "NetworkInterface" }, @@ -9236,7 +10025,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig", + "path": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig", "request": { "$ref": "ShieldedInstanceConfig" }, @@ -9301,7 +10090,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/interconnectAttachments", + "path": "projects/{project}/aggregated/interconnectAttachments", "response": { "$ref": "InterconnectAttachmentAggregatedList" }, @@ -9348,7 +10137,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", + "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "response": { "$ref": "Operation" }, @@ -9389,7 +10178,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", + "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "response": { "$ref": "InterconnectAttachment" }, @@ -9433,7 +10222,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/interconnectAttachments", + "path": "projects/{project}/regions/{region}/interconnectAttachments", "request": { "$ref": "InterconnectAttachment" }, @@ -9497,7 +10286,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/interconnectAttachments", + "path": "projects/{project}/regions/{region}/interconnectAttachments", "response": { "$ref": "InterconnectAttachmentList" }, @@ -9544,7 +10333,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", + "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "request": { "$ref": "InterconnectAttachment" }, @@ -9584,7 +10373,7 @@ "type": "string" } }, - "path": "{project}/global/interconnectLocations/{interconnectLocation}", + "path": "projects/{project}/global/interconnectLocations/{interconnectLocation}", "response": { "$ref": "InterconnectLocation" }, @@ -9638,7 +10427,7 @@ "type": "boolean" } }, - "path": "{project}/global/interconnectLocations", + "path": "projects/{project}/global/interconnectLocations", "response": { "$ref": "InterconnectLocationList" }, @@ -9681,7 +10470,7 @@ "type": "string" } }, - "path": "{project}/global/interconnects/{interconnect}", + "path": "projects/{project}/global/interconnects/{interconnect}", "response": { "$ref": "Operation" }, @@ -9714,7 +10503,7 @@ "type": "string" } }, - "path": "{project}/global/interconnects/{interconnect}", + "path": "projects/{project}/global/interconnects/{interconnect}", "response": { "$ref": "Interconnect" }, @@ -9748,7 +10537,7 @@ "type": "string" } }, - "path": "{project}/global/interconnects/{interconnect}/getDiagnostics", + "path": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics", "response": { "$ref": "InterconnectsGetDiagnosticsResponse" }, @@ -9779,7 +10568,7 @@ "type": "string" } }, - "path": "{project}/global/interconnects", + "path": "projects/{project}/global/interconnects", "request": { "$ref": "Interconnect" }, @@ -9835,7 +10624,7 @@ "type": "boolean" } }, - "path": "{project}/global/interconnects", + "path": "projects/{project}/global/interconnects", "response": { "$ref": "InterconnectList" }, @@ -9874,7 +10663,7 @@ "type": "string" } }, - "path": "{project}/global/interconnects/{interconnect}", + "path": "projects/{project}/global/interconnects/{interconnect}", "request": { "$ref": "Interconnect" }, @@ -9914,7 +10703,7 @@ "type": "string" } }, - "path": "{project}/global/licenseCodes/{licenseCode}", + "path": "projects/{project}/global/licenseCodes/{licenseCode}", "response": { "$ref": "LicenseCode" }, @@ -9948,7 +10737,7 @@ "type": "string" } }, - "path": "{project}/global/licenseCodes/{resource}/testIamPermissions", + "path": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -9994,7 +10783,7 @@ "type": "string" } }, - "path": "{project}/global/licenses/{license}", + "path": "projects/{project}/global/licenses/{license}", "response": { "$ref": "Operation" }, @@ -10027,7 +10816,7 @@ "type": "string" } }, - "path": "{project}/global/licenses/{license}", + "path": "projects/{project}/global/licenses/{license}", "response": { "$ref": "License" }, @@ -10067,7 +10856,7 @@ "type": "string" } }, - "path": "{project}/global/licenses/{resource}/getIamPolicy", + "path": "projects/{project}/global/licenses/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -10098,7 +10887,7 @@ "type": "string" } }, - "path": "{project}/global/licenses", + "path": "projects/{project}/global/licenses", "request": { "$ref": "License" }, @@ -10157,7 +10946,7 @@ "type": "boolean" } }, - "path": "{project}/global/licenses", + "path": "projects/{project}/global/licenses", "response": { "$ref": "LicensesListResponse" }, @@ -10191,7 +10980,7 @@ "type": "string" } }, - "path": "{project}/global/licenses/{resource}/setIamPolicy", + "path": "projects/{project}/global/licenses/{resource}/setIamPolicy", "request": { "$ref": "GlobalSetPolicyRequest" }, @@ -10227,7 +11016,7 @@ "type": "string" } }, - "path": "{project}/global/licenses/{resource}/testIamPermissions", + "path": "projects/{project}/global/licenses/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -10293,7 +11082,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/machineTypes", + "path": "projects/{project}/aggregated/machineTypes", "response": { "$ref": "MachineTypeAggregatedList" }, @@ -10335,7 +11124,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/machineTypes/{machineType}", + "path": "projects/{project}/zones/{zone}/machineTypes/{machineType}", "response": { "$ref": "MachineType" }, @@ -10397,7 +11186,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/machineTypes", + "path": "projects/{project}/zones/{zone}/machineTypes", "response": { "$ref": "MachineTypeList" }, @@ -10460,7 +11249,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/networkEndpointGroups", + "path": "projects/{project}/aggregated/networkEndpointGroups", "response": { "$ref": "NetworkEndpointGroupAggregatedList" }, @@ -10505,7 +11294,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "request": { "$ref": "NetworkEndpointGroupsAttachEndpointsRequest" }, @@ -10552,7 +11341,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", "response": { "$ref": "Operation" }, @@ -10596,7 +11385,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "request": { "$ref": "NetworkEndpointGroupsDetachEndpointsRequest" }, @@ -10638,7 +11427,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", "response": { "$ref": "NetworkEndpointGroup" }, @@ -10676,7 +11465,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups", "request": { "$ref": "NetworkEndpointGroup" }, @@ -10739,7 +11528,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups", "response": { "$ref": "NetworkEndpointGroupList" }, @@ -10807,7 +11596,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "request": { "$ref": "NetworkEndpointGroupsListEndpointsRequest" }, @@ -10852,7 +11641,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions", + "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -10898,7 +11687,7 @@ "type": "string" } }, - "path": "{project}/global/networks/{network}/addPeering", + "path": "projects/{project}/global/networks/{network}/addPeering", "request": { "$ref": "NetworksAddPeeringRequest" }, @@ -10939,7 +11728,7 @@ "type": "string" } }, - "path": "{project}/global/networks/{network}", + "path": "projects/{project}/global/networks/{network}", "response": { "$ref": "Operation" }, @@ -10972,7 +11761,7 @@ "type": "string" } }, - "path": "{project}/global/networks/{network}", + "path": "projects/{project}/global/networks/{network}", "response": { "$ref": "Network" }, @@ -11003,7 +11792,7 @@ "type": "string" } }, - "path": "{project}/global/networks", + "path": "projects/{project}/global/networks", "request": { "$ref": "Network" }, @@ -11059,7 +11848,7 @@ "type": "boolean" } }, - "path": "{project}/global/networks", + "path": "projects/{project}/global/networks", "response": { "$ref": "NetworkList" }, @@ -11144,7 +11933,7 @@ "type": "boolean" } }, - "path": "{project}/global/networks/{network}/listPeeringRoutes", + "path": "projects/{project}/global/networks/{network}/listPeeringRoutes", "response": { "$ref": "ExchangedPeeringRoutesList" }, @@ -11183,7 +11972,7 @@ "type": "string" } }, - "path": "{project}/global/networks/{network}", + "path": "projects/{project}/global/networks/{network}", "request": { "$ref": "Network" }, @@ -11224,7 +12013,7 @@ "type": "string" } }, - "path": "{project}/global/networks/{network}/removePeering", + "path": "projects/{project}/global/networks/{network}/removePeering", "request": { "$ref": "NetworksRemovePeeringRequest" }, @@ -11265,7 +12054,7 @@ "type": "string" } }, - "path": "{project}/global/networks/{network}/switchToCustomMode", + "path": "projects/{project}/global/networks/{network}/switchToCustomMode", "response": { "$ref": "Operation" }, @@ -11303,7 +12092,7 @@ "type": "string" } }, - "path": "{project}/global/networks/{network}/updatePeering", + "path": "projects/{project}/global/networks/{network}/updatePeering", "request": { "$ref": "NetworksUpdatePeeringRequest" }, @@ -11356,7 +12145,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes", + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes", "request": { "$ref": "NodeGroupsAddNodesRequest" }, @@ -11417,7 +12206,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/nodeGroups", + "path": "projects/{project}/aggregated/nodeGroups", "response": { "$ref": "NodeGroupAggregatedList" }, @@ -11464,7 +12253,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}", + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "response": { "$ref": "Operation" }, @@ -11510,7 +12299,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes", + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes", "request": { "$ref": "NodeGroupsDeleteNodesRequest" }, @@ -11554,7 +12343,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}", + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "response": { "$ref": "NodeGroup" }, @@ -11602,7 +12391,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy", + "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -11649,7 +12438,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups", + "path": "projects/{project}/zones/{zone}/nodeGroups", "request": { "$ref": "NodeGroup" }, @@ -11713,7 +12502,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups", + "path": "projects/{project}/zones/{zone}/nodeGroups", "response": { "$ref": "NodeGroupList" }, @@ -11783,7 +12572,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes", + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes", "response": { "$ref": "NodeGroupsListNodes" }, @@ -11830,7 +12619,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}", + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "request": { "$ref": "NodeGroup" }, @@ -11874,7 +12663,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", + "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", "request": { "$ref": "ZoneSetPolicyRequest" }, @@ -11923,7 +12712,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate", + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate", "request": { "$ref": "NodeGroupsSetNodeTemplateRequest" }, @@ -11967,7 +12756,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions", + "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -12033,7 +12822,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/nodeTemplates", + "path": "projects/{project}/aggregated/nodeTemplates", "response": { "$ref": "NodeTemplateAggregatedList" }, @@ -12080,7 +12869,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/nodeTemplates/{nodeTemplate}", + "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", "response": { "$ref": "Operation" }, @@ -12121,7 +12910,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/nodeTemplates/{nodeTemplate}", + "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", "response": { "$ref": "NodeTemplate" }, @@ -12169,7 +12958,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy", + "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -12208,7 +12997,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/nodeTemplates", + "path": "projects/{project}/regions/{region}/nodeTemplates", "request": { "$ref": "NodeTemplate" }, @@ -12272,7 +13061,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/nodeTemplates", + "path": "projects/{project}/regions/{region}/nodeTemplates", "response": { "$ref": "NodeTemplateList" }, @@ -12314,7 +13103,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy", + "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy", "request": { "$ref": "RegionSetPolicyRequest" }, @@ -12358,7 +13147,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -12424,7 +13213,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/nodeTypes", + "path": "projects/{project}/aggregated/nodeTypes", "response": { "$ref": "NodeTypeAggregatedList" }, @@ -12466,7 +13255,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeTypes/{nodeType}", + "path": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}", "response": { "$ref": "NodeType" }, @@ -12528,7 +13317,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/nodeTypes", + "path": "projects/{project}/zones/{zone}/nodeTypes", "response": { "$ref": "NodeTypeList" }, @@ -12591,7 +13380,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/packetMirrorings", + "path": "projects/{project}/aggregated/packetMirrorings", "response": { "$ref": "PacketMirroringAggregatedList" }, @@ -12638,7 +13427,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "response": { "$ref": "Operation" }, @@ -12679,7 +13468,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "response": { "$ref": "PacketMirroring" }, @@ -12718,7 +13507,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/packetMirrorings", + "path": "projects/{project}/regions/{region}/packetMirrorings", "request": { "$ref": "PacketMirroring" }, @@ -12782,7 +13571,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/packetMirrorings", + "path": "projects/{project}/regions/{region}/packetMirrorings", "response": { "$ref": "PacketMirroringList" }, @@ -12829,7 +13618,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/packetMirrorings/{packetMirroring}", + "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "request": { "$ref": "PacketMirroring" }, @@ -12873,7 +13662,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -12911,7 +13700,7 @@ "type": "string" } }, - "path": "{project}/disableXpnHost", + "path": "projects/{project}/disableXpnHost", "response": { "$ref": "Operation" }, @@ -12941,7 +13730,7 @@ "type": "string" } }, - "path": "{project}/disableXpnResource", + "path": "projects/{project}/disableXpnResource", "request": { "$ref": "ProjectsDisableXpnResourceRequest" }, @@ -12974,7 +13763,7 @@ "type": "string" } }, - "path": "{project}/enableXpnHost", + "path": "projects/{project}/enableXpnHost", "response": { "$ref": "Operation" }, @@ -13004,7 +13793,7 @@ "type": "string" } }, - "path": "{project}/enableXpnResource", + "path": "projects/{project}/enableXpnResource", "request": { "$ref": "ProjectsEnableXpnResourceRequest" }, @@ -13032,7 +13821,7 @@ "type": "string" } }, - "path": "{project}", + "path": "projects/{project}", "response": { "$ref": "Project" }, @@ -13058,7 +13847,7 @@ "type": "string" } }, - "path": "{project}/getXpnHost", + "path": "projects/{project}/getXpnHost", "response": { "$ref": "Project" }, @@ -13111,7 +13900,7 @@ "type": "boolean" } }, - "path": "{project}/getXpnResources", + "path": "projects/{project}/getXpnResources", "response": { "$ref": "ProjectsGetXpnResources" }, @@ -13164,7 +13953,7 @@ "type": "boolean" } }, - "path": "{project}/listXpnHosts", + "path": "projects/{project}/listXpnHosts", "request": { "$ref": "ProjectsListXpnHostsRequest" }, @@ -13197,7 +13986,7 @@ "type": "string" } }, - "path": "{project}/moveDisk", + "path": "projects/{project}/moveDisk", "request": { "$ref": "DiskMoveRequest" }, @@ -13230,7 +14019,7 @@ "type": "string" } }, - "path": "{project}/moveInstance", + "path": "projects/{project}/moveInstance", "request": { "$ref": "InstanceMoveRequest" }, @@ -13263,7 +14052,7 @@ "type": "string" } }, - "path": "{project}/setCommonInstanceMetadata", + "path": "projects/{project}/setCommonInstanceMetadata", "request": { "$ref": "Metadata" }, @@ -13296,7 +14085,7 @@ "type": "string" } }, - "path": "{project}/setDefaultNetworkTier", + "path": "projects/{project}/setDefaultNetworkTier", "request": { "$ref": "ProjectsSetDefaultNetworkTierRequest" }, @@ -13329,7 +14118,7 @@ "type": "string" } }, - "path": "{project}/setUsageExportBucket", + "path": "projects/{project}/setUsageExportBucket", "request": { "$ref": "UsageExportLocation" }, @@ -13385,7 +14174,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/autoscalers/{autoscaler}", + "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", "response": { "$ref": "Operation" }, @@ -13426,7 +14215,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/autoscalers/{autoscaler}", + "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", "response": { "$ref": "Autoscaler" }, @@ -13465,7 +14254,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/autoscalers", + "path": "projects/{project}/regions/{region}/autoscalers", "request": { "$ref": "Autoscaler" }, @@ -13529,7 +14318,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/autoscalers", + "path": "projects/{project}/regions/{region}/autoscalers", "response": { "$ref": "RegionAutoscalerList" }, @@ -13574,7 +14363,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/autoscalers", + "path": "projects/{project}/regions/{region}/autoscalers", "request": { "$ref": "Autoscaler" }, @@ -13621,7 +14410,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/autoscalers", + "path": "projects/{project}/regions/{region}/autoscalers", "request": { "$ref": "Autoscaler" }, @@ -13674,7 +14463,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/backendServices/{backendService}", + "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "response": { "$ref": "Operation" }, @@ -13715,7 +14504,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/backendServices/{backendService}", + "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "response": { "$ref": "BackendService" }, @@ -13756,7 +14545,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/backendServices/{backendService}/getHealth", + "path": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth", "request": { "$ref": "ResourceGroupReference" }, @@ -13798,7 +14587,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/backendServices", + "path": "projects/{project}/regions/{region}/backendServices", "request": { "$ref": "BackendService" }, @@ -13862,7 +14651,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/backendServices", + "path": "projects/{project}/regions/{region}/backendServices", "response": { "$ref": "BackendServiceList" }, @@ -13909,7 +14698,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/backendServices/{backendService}", + "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "request": { "$ref": "BackendService" }, @@ -13958,7 +14747,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/backendServices/{backendService}", + "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "request": { "$ref": "BackendService" }, @@ -14023,7 +14812,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/commitments", + "path": "projects/{project}/aggregated/commitments", "response": { "$ref": "CommitmentAggregatedList" }, @@ -14065,7 +14854,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/commitments/{commitment}", + "path": "projects/{project}/regions/{region}/commitments/{commitment}", "response": { "$ref": "Commitment" }, @@ -14104,7 +14893,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/commitments", + "path": "projects/{project}/regions/{region}/commitments", "request": { "$ref": "Commitment" }, @@ -14168,7 +14957,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/commitments", + "path": "projects/{project}/regions/{region}/commitments", "response": { "$ref": "CommitmentList" }, @@ -14214,7 +15003,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/diskTypes/{diskType}", + "path": "projects/{project}/regions/{region}/diskTypes/{diskType}", "response": { "$ref": "DiskType" }, @@ -14276,7 +15065,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/diskTypes", + "path": "projects/{project}/regions/{region}/diskTypes", "response": { "$ref": "RegionDiskTypeList" }, @@ -14327,7 +15116,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{disk}/addResourcePolicies", + "path": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", "request": { "$ref": "RegionDisksAddResourcePoliciesRequest" }, @@ -14376,7 +15165,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{disk}/createSnapshot", + "path": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", "request": { "$ref": "Snapshot" }, @@ -14424,7 +15213,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{disk}", + "path": "projects/{project}/regions/{region}/disks/{disk}", "response": { "$ref": "Operation" }, @@ -14465,7 +15254,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{disk}", + "path": "projects/{project}/regions/{region}/disks/{disk}", "response": { "$ref": "Disk" }, @@ -14513,7 +15302,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{resource}/getIamPolicy", + "path": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -14552,12 +15341,12 @@ "type": "string" }, "sourceImage": { - "description": "Optional. Source image to restore onto a disk.", + "description": "Source image to restore onto a disk. This field is optional.", "location": "query", "type": "string" } }, - "path": "{project}/regions/{region}/disks", + "path": "projects/{project}/regions/{region}/disks", "request": { "$ref": "Disk" }, @@ -14621,7 +15410,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/disks", + "path": "projects/{project}/regions/{region}/disks", "response": { "$ref": "DiskList" }, @@ -14668,7 +15457,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{disk}/removeResourcePolicies", + "path": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies", "request": { "$ref": "RegionDisksRemoveResourcePoliciesRequest" }, @@ -14717,7 +15506,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{disk}/resize", + "path": "projects/{project}/regions/{region}/disks/{disk}/resize", "request": { "$ref": "RegionDisksResizeRequest" }, @@ -14761,7 +15550,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{resource}/setIamPolicy", + "path": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy", "request": { "$ref": "RegionSetPolicyRequest" }, @@ -14810,7 +15599,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{resource}/setLabels", + "path": "projects/{project}/regions/{region}/disks/{resource}/setLabels", "request": { "$ref": "RegionSetLabelsRequest" }, @@ -14854,7 +15643,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/disks/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -14907,7 +15696,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "response": { "$ref": "Operation" }, @@ -14947,7 +15736,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "response": { "$ref": "HealthCheckService" }, @@ -14986,7 +15775,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthCheckServices", + "path": "projects/{project}/regions/{region}/healthCheckServices", "request": { "$ref": "HealthCheckService" }, @@ -15050,7 +15839,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/healthCheckServices", + "path": "projects/{project}/regions/{region}/healthCheckServices", "response": { "$ref": "HealthCheckServicesList" }, @@ -15096,7 +15885,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthCheckServices/{healthCheckService}", + "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "request": { "$ref": "HealthCheckService" }, @@ -15149,7 +15938,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthChecks/{healthCheck}", + "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "response": { "$ref": "Operation" }, @@ -15190,7 +15979,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthChecks/{healthCheck}", + "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "response": { "$ref": "HealthCheck" }, @@ -15229,7 +16018,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthChecks", + "path": "projects/{project}/regions/{region}/healthChecks", "request": { "$ref": "HealthCheck" }, @@ -15293,7 +16082,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/healthChecks", + "path": "projects/{project}/regions/{region}/healthChecks", "response": { "$ref": "HealthCheckList" }, @@ -15340,7 +16129,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthChecks/{healthCheck}", + "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "request": { "$ref": "HealthCheck" }, @@ -15389,7 +16178,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/healthChecks/{healthCheck}", + "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "request": { "$ref": "HealthCheck" }, @@ -15440,7 +16229,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", "request": { "$ref": "RegionInstanceGroupManagersAbandonInstancesRequest" }, @@ -15482,7 +16271,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", "request": { "$ref": "RegionInstanceGroupManagersApplyUpdatesRequest" }, @@ -15529,7 +16318,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", "request": { "$ref": "RegionInstanceGroupManagersCreateInstancesRequest" }, @@ -15576,7 +16365,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "response": { "$ref": "Operation" }, @@ -15620,7 +16409,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", "request": { "$ref": "RegionInstanceGroupManagersDeleteInstancesRequest" }, @@ -15662,7 +16451,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", "request": { "$ref": "RegionInstanceGroupManagerDeleteInstanceConfigReq" }, @@ -15704,7 +16493,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "response": { "$ref": "InstanceGroupManager" }, @@ -15742,7 +16531,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers", + "path": "projects/{project}/regions/{region}/instanceGroupManagers", "request": { "$ref": "InstanceGroupManager" }, @@ -15805,7 +16594,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/instanceGroupManagers", + "path": "projects/{project}/regions/{region}/instanceGroupManagers", "response": { "$ref": "RegionInstanceGroupManagerList" }, @@ -15873,7 +16662,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors", "response": { "$ref": "RegionInstanceGroupManagersListErrorsResponse" }, @@ -15941,7 +16730,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "response": { "$ref": "RegionInstanceGroupManagersListInstancesResponse" }, @@ -16009,7 +16798,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", "response": { "$ref": "RegionInstanceGroupManagersListInstanceConfigsResp" }, @@ -16054,7 +16843,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "request": { "$ref": "InstanceGroupManager" }, @@ -16067,7 +16856,7 @@ ] }, "patchPerInstanceConfigs": { - "description": "Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch.", + "description": "Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.", "httpMethod": "POST", "id": "compute.regionInstanceGroupManagers.patchPerInstanceConfigs", "parameterOrder": [ @@ -16101,7 +16890,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", "request": { "$ref": "RegionInstanceGroupManagerPatchInstanceConfigReq" }, @@ -16148,7 +16937,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", "request": { "$ref": "RegionInstanceGroupManagersRecreateRequest" }, @@ -16204,7 +16993,7 @@ "type": "integer" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize", "response": { "$ref": "Operation" }, @@ -16248,7 +17037,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", "request": { "$ref": "RegionInstanceGroupManagersSetTemplateRequest" }, @@ -16295,7 +17084,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", "request": { "$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest" }, @@ -16308,7 +17097,7 @@ ] }, "updatePerInstanceConfigs": { - "description": "Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch.", + "description": "Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.", "httpMethod": "POST", "id": "compute.regionInstanceGroupManagers.updatePerInstanceConfigs", "parameterOrder": [ @@ -16342,7 +17131,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "request": { "$ref": "RegionInstanceGroupManagerUpdateInstanceConfigReq" }, @@ -16388,7 +17177,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroups/{instanceGroup}", + "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}", "response": { "$ref": "InstanceGroup" }, @@ -16449,7 +17238,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/instanceGroups", + "path": "projects/{project}/regions/{region}/instanceGroups", "response": { "$ref": "RegionInstanceGroupList" }, @@ -16517,7 +17306,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances", + "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances", "request": { "$ref": "RegionInstanceGroupsListInstancesRequest" }, @@ -16565,7 +17354,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts", + "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts", "request": { "$ref": "RegionInstanceGroupsSetNamedPortsRequest" }, @@ -16616,7 +17405,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", "response": { "$ref": "Operation" }, @@ -16655,7 +17444,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", "response": { "$ref": "NetworkEndpointGroup" }, @@ -16693,7 +17482,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/networkEndpointGroups", + "path": "projects/{project}/regions/{region}/networkEndpointGroups", "request": { "$ref": "NetworkEndpointGroup" }, @@ -16756,7 +17545,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/networkEndpointGroups", + "path": "projects/{project}/regions/{region}/networkEndpointGroups", "response": { "$ref": "NetworkEndpointGroupList" }, @@ -16807,7 +17596,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "response": { "$ref": "Operation" }, @@ -16848,7 +17637,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", + "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "response": { "$ref": "NotificationEndpoint" }, @@ -16887,7 +17676,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/notificationEndpoints", + "path": "projects/{project}/regions/{region}/notificationEndpoints", "request": { "$ref": "NotificationEndpoint" }, @@ -16951,7 +17740,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/notificationEndpoints", + "path": "projects/{project}/regions/{region}/notificationEndpoints", "response": { "$ref": "NotificationEndpointList" }, @@ -16997,7 +17786,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/operations/{operation}", + "path": "projects/{project}/regions/{region}/operations/{operation}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" @@ -17035,7 +17824,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/operations/{operation}", + "path": "projects/{project}/regions/{region}/operations/{operation}", "response": { "$ref": "Operation" }, @@ -17097,7 +17886,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/operations", + "path": "projects/{project}/regions/{region}/operations", "response": { "$ref": "OperationList" }, @@ -17139,7 +17928,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/operations/{operation}/wait", + "path": "projects/{project}/regions/{region}/operations/{operation}/wait", "response": { "$ref": "Operation" }, @@ -17190,7 +17979,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/sslCertificates/{sslCertificate}", + "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "response": { "$ref": "Operation" }, @@ -17231,7 +18020,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/sslCertificates/{sslCertificate}", + "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "response": { "$ref": "SslCertificate" }, @@ -17270,7 +18059,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/sslCertificates", + "path": "projects/{project}/regions/{region}/sslCertificates", "request": { "$ref": "SslCertificate" }, @@ -17334,7 +18123,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/sslCertificates", + "path": "projects/{project}/regions/{region}/sslCertificates", "response": { "$ref": "SslCertificateList" }, @@ -17385,7 +18174,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "Operation" }, @@ -17426,7 +18215,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "TargetHttpProxy" }, @@ -17465,7 +18254,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpProxies", + "path": "projects/{project}/regions/{region}/targetHttpProxies", "request": { "$ref": "TargetHttpProxy" }, @@ -17529,7 +18318,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/targetHttpProxies", + "path": "projects/{project}/regions/{region}/targetHttpProxies", "response": { "$ref": "TargetHttpProxyList" }, @@ -17576,7 +18365,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "request": { "$ref": "UrlMapReference" }, @@ -17629,7 +18418,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "Operation" }, @@ -17670,7 +18459,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "TargetHttpsProxy" }, @@ -17709,7 +18498,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpsProxies", + "path": "projects/{project}/regions/{region}/targetHttpsProxies", "request": { "$ref": "TargetHttpsProxy" }, @@ -17773,7 +18562,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/targetHttpsProxies", + "path": "projects/{project}/regions/{region}/targetHttpsProxies", "response": { "$ref": "TargetHttpsProxyList" }, @@ -17820,7 +18609,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "request": { "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" }, @@ -17869,7 +18658,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "request": { "$ref": "UrlMapReference" }, @@ -17922,7 +18711,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "response": { "$ref": "Operation" }, @@ -17963,7 +18752,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "response": { "$ref": "UrlMap" }, @@ -18002,7 +18791,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/urlMaps", + "path": "projects/{project}/regions/{region}/urlMaps", "request": { "$ref": "UrlMap" }, @@ -18066,7 +18855,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/urlMaps", + "path": "projects/{project}/regions/{region}/urlMaps", "response": { "$ref": "UrlMapList" }, @@ -18113,7 +18902,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "request": { "$ref": "UrlMap" }, @@ -18162,7 +18951,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/urlMaps/{urlMap}", + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "request": { "$ref": "UrlMap" }, @@ -18206,7 +18995,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/urlMaps/{urlMap}/validate", + "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", "request": { "$ref": "RegionUrlMapsValidateRequest" }, @@ -18246,7 +19035,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}", + "path": "projects/{project}/regions/{region}", "response": { "$ref": "Region" }, @@ -18300,7 +19089,7 @@ "type": "boolean" } }, - "path": "{project}/regions", + "path": "projects/{project}/regions", "response": { "$ref": "RegionList" }, @@ -18363,7 +19152,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/reservations", + "path": "projects/{project}/aggregated/reservations", "response": { "$ref": "ReservationAggregatedList" }, @@ -18410,7 +19199,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations/{reservation}", + "path": "projects/{project}/zones/{zone}/reservations/{reservation}", "response": { "$ref": "Operation" }, @@ -18451,7 +19240,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations/{reservation}", + "path": "projects/{project}/zones/{zone}/reservations/{reservation}", "response": { "$ref": "Reservation" }, @@ -18499,7 +19288,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations/{resource}/getIamPolicy", + "path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -18538,7 +19327,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations", + "path": "projects/{project}/zones/{zone}/reservations", "request": { "$ref": "Reservation" }, @@ -18602,7 +19391,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations", + "path": "projects/{project}/zones/{zone}/reservations", "response": { "$ref": "ReservationList" }, @@ -18649,7 +19438,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations/{reservation}/resize", + "path": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", "request": { "$ref": "ReservationsResizeRequest" }, @@ -18693,7 +19482,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations/{resource}/setIamPolicy", + "path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", "request": { "$ref": "ZoneSetPolicyRequest" }, @@ -18737,7 +19526,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/reservations/{resource}/testIamPermissions", + "path": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -18803,7 +19592,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/resourcePolicies", + "path": "projects/{project}/aggregated/resourcePolicies", "response": { "$ref": "ResourcePolicyAggregatedList" }, @@ -18850,7 +19639,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "response": { "$ref": "Operation" }, @@ -18891,7 +19680,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/resourcePolicies/{resourcePolicy}", + "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "response": { "$ref": "ResourcePolicy" }, @@ -18939,7 +19728,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", + "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -18978,7 +19767,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/resourcePolicies", + "path": "projects/{project}/regions/{region}/resourcePolicies", "request": { "$ref": "ResourcePolicy" }, @@ -19042,7 +19831,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/resourcePolicies", + "path": "projects/{project}/regions/{region}/resourcePolicies", "response": { "$ref": "ResourcePolicyList" }, @@ -19084,7 +19873,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", + "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", "request": { "$ref": "RegionSetPolicyRequest" }, @@ -19128,7 +19917,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -19194,7 +19983,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/routers", + "path": "projects/{project}/aggregated/routers", "response": { "$ref": "RouterAggregatedList" }, @@ -19241,7 +20030,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers/{router}", + "path": "projects/{project}/regions/{region}/routers/{router}", "response": { "$ref": "Operation" }, @@ -19282,7 +20071,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers/{router}", + "path": "projects/{project}/regions/{region}/routers/{router}", "response": { "$ref": "Router" }, @@ -19352,7 +20141,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers/{router}/getNatMappingInfo", + "path": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", "response": { "$ref": "VmEndpointNatMappingsList" }, @@ -19394,7 +20183,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers/{router}/getRouterStatus", + "path": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", "response": { "$ref": "RouterStatusResponse" }, @@ -19433,7 +20222,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers", + "path": "projects/{project}/regions/{region}/routers", "request": { "$ref": "Router" }, @@ -19497,7 +20286,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/routers", + "path": "projects/{project}/regions/{region}/routers", "response": { "$ref": "RouterList" }, @@ -19544,7 +20333,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers/{router}", + "path": "projects/{project}/regions/{region}/routers/{router}", "request": { "$ref": "Router" }, @@ -19588,7 +20377,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers/{router}/preview", + "path": "projects/{project}/regions/{region}/routers/{router}/preview", "request": { "$ref": "Router" }, @@ -19638,7 +20427,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/routers/{router}", + "path": "projects/{project}/regions/{region}/routers/{router}", "request": { "$ref": "Router" }, @@ -19683,7 +20472,7 @@ "type": "string" } }, - "path": "{project}/global/routes/{route}", + "path": "projects/{project}/global/routes/{route}", "response": { "$ref": "Operation" }, @@ -19716,7 +20505,7 @@ "type": "string" } }, - "path": "{project}/global/routes/{route}", + "path": "projects/{project}/global/routes/{route}", "response": { "$ref": "Route" }, @@ -19747,7 +20536,7 @@ "type": "string" } }, - "path": "{project}/global/routes", + "path": "projects/{project}/global/routes", "request": { "$ref": "Route" }, @@ -19803,7 +20592,7 @@ "type": "boolean" } }, - "path": "{project}/global/routes", + "path": "projects/{project}/global/routes", "response": { "$ref": "RouteList" }, @@ -19841,7 +20630,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies/{securityPolicy}/addRule", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule", "request": { "$ref": "SecurityPolicyRule" }, @@ -19882,7 +20671,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies/{securityPolicy}", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}", "response": { "$ref": "Operation" }, @@ -19915,7 +20704,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies/{securityPolicy}", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}", "response": { "$ref": "SecurityPolicy" }, @@ -19955,7 +20744,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies/{securityPolicy}/getRule", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule", "response": { "$ref": "SecurityPolicyRule" }, @@ -19986,7 +20775,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies", + "path": "projects/{project}/global/securityPolicies", "request": { "$ref": "SecurityPolicy" }, @@ -20042,7 +20831,7 @@ "type": "boolean" } }, - "path": "{project}/global/securityPolicies", + "path": "projects/{project}/global/securityPolicies", "response": { "$ref": "SecurityPolicyList" }, @@ -20096,7 +20885,7 @@ "type": "boolean" } }, - "path": "{project}/global/securityPolicies/listPreconfiguredExpressionSets", + "path": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", "response": { "$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" }, @@ -20106,7 +20895,7 @@ ] }, "patch": { - "description": "Patches the specified policy with the data included in the request.", + "description": "Patches the specified policy with the data included in the request. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.", "httpMethod": "PATCH", "id": "compute.securityPolicies.patch", "parameterOrder": [ @@ -20134,7 +20923,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies/{securityPolicy}", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}", "request": { "$ref": "SecurityPolicy" }, @@ -20176,7 +20965,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies/{securityPolicy}/patchRule", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", "request": { "$ref": "SecurityPolicyRule" }, @@ -20218,7 +21007,7 @@ "type": "string" } }, - "path": "{project}/global/securityPolicies/{securityPolicy}/removeRule", + "path": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule", "response": { "$ref": "Operation" }, @@ -20260,7 +21049,7 @@ "type": "string" } }, - "path": "{project}/global/snapshots/{snapshot}", + "path": "projects/{project}/global/snapshots/{snapshot}", "response": { "$ref": "Operation" }, @@ -20293,7 +21082,7 @@ "type": "string" } }, - "path": "{project}/global/snapshots/{snapshot}", + "path": "projects/{project}/global/snapshots/{snapshot}", "response": { "$ref": "Snapshot" }, @@ -20333,7 +21122,7 @@ "type": "string" } }, - "path": "{project}/global/snapshots/{resource}/getIamPolicy", + "path": "projects/{project}/global/snapshots/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -20387,7 +21176,7 @@ "type": "boolean" } }, - "path": "{project}/global/snapshots", + "path": "projects/{project}/global/snapshots", "response": { "$ref": "SnapshotList" }, @@ -20421,7 +21210,7 @@ "type": "string" } }, - "path": "{project}/global/snapshots/{resource}/setIamPolicy", + "path": "projects/{project}/global/snapshots/{resource}/setIamPolicy", "request": { "$ref": "GlobalSetPolicyRequest" }, @@ -20457,7 +21246,7 @@ "type": "string" } }, - "path": "{project}/global/snapshots/{resource}/setLabels", + "path": "projects/{project}/global/snapshots/{resource}/setLabels", "request": { "$ref": "GlobalSetLabelsRequest" }, @@ -20493,7 +21282,7 @@ "type": "string" } }, - "path": "{project}/global/snapshots/{resource}/testIamPermissions", + "path": "projects/{project}/global/snapshots/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -20559,7 +21348,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/sslCertificates", + "path": "projects/{project}/aggregated/sslCertificates", "response": { "$ref": "SslCertificateAggregatedList" }, @@ -20598,7 +21387,7 @@ "type": "string" } }, - "path": "{project}/global/sslCertificates/{sslCertificate}", + "path": "projects/{project}/global/sslCertificates/{sslCertificate}", "response": { "$ref": "Operation" }, @@ -20631,7 +21420,7 @@ "type": "string" } }, - "path": "{project}/global/sslCertificates/{sslCertificate}", + "path": "projects/{project}/global/sslCertificates/{sslCertificate}", "response": { "$ref": "SslCertificate" }, @@ -20662,7 +21451,7 @@ "type": "string" } }, - "path": "{project}/global/sslCertificates", + "path": "projects/{project}/global/sslCertificates", "request": { "$ref": "SslCertificate" }, @@ -20718,7 +21507,7 @@ "type": "boolean" } }, - "path": "{project}/global/sslCertificates", + "path": "projects/{project}/global/sslCertificates", "response": { "$ref": "SslCertificateList" }, @@ -20760,7 +21549,7 @@ "type": "string" } }, - "path": "{project}/global/sslPolicies/{sslPolicy}", + "path": "projects/{project}/global/sslPolicies/{sslPolicy}", "response": { "$ref": "Operation" }, @@ -20792,7 +21581,7 @@ "type": "string" } }, - "path": "{project}/global/sslPolicies/{sslPolicy}", + "path": "projects/{project}/global/sslPolicies/{sslPolicy}", "response": { "$ref": "SslPolicy" }, @@ -20823,7 +21612,7 @@ "type": "string" } }, - "path": "{project}/global/sslPolicies", + "path": "projects/{project}/global/sslPolicies", "request": { "$ref": "SslPolicy" }, @@ -20879,7 +21668,7 @@ "type": "boolean" } }, - "path": "{project}/global/sslPolicies", + "path": "projects/{project}/global/sslPolicies", "response": { "$ref": "SslPoliciesList" }, @@ -20933,7 +21722,7 @@ "type": "boolean" } }, - "path": "{project}/global/sslPolicies/listAvailableFeatures", + "path": "projects/{project}/global/sslPolicies/listAvailableFeatures", "response": { "$ref": "SslPoliciesListAvailableFeaturesResponse" }, @@ -20971,7 +21760,7 @@ "type": "string" } }, - "path": "{project}/global/sslPolicies/{sslPolicy}", + "path": "projects/{project}/global/sslPolicies/{sslPolicy}", "request": { "$ref": "SslPolicy" }, @@ -21036,7 +21825,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/subnetworks", + "path": "projects/{project}/aggregated/subnetworks", "response": { "$ref": "SubnetworkAggregatedList" }, @@ -21083,7 +21872,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{subnetwork}", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "response": { "$ref": "Operation" }, @@ -21129,7 +21918,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", "request": { "$ref": "SubnetworksExpandIpCidrRangeRequest" }, @@ -21173,7 +21962,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{subnetwork}", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "response": { "$ref": "Subnetwork" }, @@ -21221,7 +22010,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -21260,7 +22049,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks", + "path": "projects/{project}/regions/{region}/subnetworks", "request": { "$ref": "Subnetwork" }, @@ -21324,7 +22113,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/subnetworks", + "path": "projects/{project}/regions/{region}/subnetworks", "response": { "$ref": "SubnetworkList" }, @@ -21378,7 +22167,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/subnetworks/listUsable", + "path": "projects/{project}/aggregated/subnetworks/listUsable", "response": { "$ref": "UsableSubnetworksAggregatedList" }, @@ -21389,7 +22178,7 @@ ] }, "patch": { - "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.", + "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.", "httpMethod": "PATCH", "id": "compute.subnetworks.patch", "parameterOrder": [ @@ -21431,7 +22220,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{subnetwork}", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "request": { "$ref": "Subnetwork" }, @@ -21475,7 +22264,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", "request": { "$ref": "RegionSetPolicyRequest" }, @@ -21524,7 +22313,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", + "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", "request": { "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest" }, @@ -21568,7 +22357,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -21614,7 +22403,7 @@ "type": "string" } }, - "path": "{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "response": { "$ref": "Operation" }, @@ -21647,7 +22436,7 @@ "type": "string" } }, - "path": "{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "response": { "$ref": "TargetGrpcProxy" }, @@ -21678,7 +22467,7 @@ "type": "string" } }, - "path": "{project}/global/targetGrpcProxies", + "path": "projects/{project}/global/targetGrpcProxies", "request": { "$ref": "TargetGrpcProxy" }, @@ -21734,7 +22523,7 @@ "type": "boolean" } }, - "path": "{project}/global/targetGrpcProxies", + "path": "projects/{project}/global/targetGrpcProxies", "response": { "$ref": "TargetGrpcProxyList" }, @@ -21773,7 +22562,7 @@ "type": "string" } }, - "path": "{project}/global/targetGrpcProxies/{targetGrpcProxy}", + "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "request": { "$ref": "TargetGrpcProxy" }, @@ -21838,7 +22627,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/targetHttpProxies", + "path": "projects/{project}/aggregated/targetHttpProxies", "response": { "$ref": "TargetHttpProxyAggregatedList" }, @@ -21877,7 +22666,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "Operation" }, @@ -21910,7 +22699,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "response": { "$ref": "TargetHttpProxy" }, @@ -21941,7 +22730,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpProxies", + "path": "projects/{project}/global/targetHttpProxies", "request": { "$ref": "TargetHttpProxy" }, @@ -21997,7 +22786,7 @@ "type": "boolean" } }, - "path": "{project}/global/targetHttpProxies", + "path": "projects/{project}/global/targetHttpProxies", "response": { "$ref": "TargetHttpProxyList" }, @@ -22036,7 +22825,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpProxies/{targetHttpProxy}", + "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "request": { "$ref": "TargetHttpProxy" }, @@ -22077,7 +22866,7 @@ "type": "string" } }, - "path": "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", + "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "request": { "$ref": "UrlMapReference" }, @@ -22142,7 +22931,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/targetHttpsProxies", + "path": "projects/{project}/aggregated/targetHttpsProxies", "response": { "$ref": "TargetHttpsProxyAggregatedList" }, @@ -22181,7 +22970,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "Operation" }, @@ -22214,7 +23003,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "response": { "$ref": "TargetHttpsProxy" }, @@ -22245,7 +23034,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpsProxies", + "path": "projects/{project}/global/targetHttpsProxies", "request": { "$ref": "TargetHttpsProxy" }, @@ -22301,7 +23090,7 @@ "type": "boolean" } }, - "path": "{project}/global/targetHttpsProxies", + "path": "projects/{project}/global/targetHttpsProxies", "response": { "$ref": "TargetHttpsProxyList" }, @@ -22311,6 +23100,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "patch": { + "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)", + "httpMethod": "PATCH", + "id": "compute.targetHttpsProxies.patch", + "parameterOrder": [ + "project", + "targetHttpsProxy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "targetHttpsProxy": { + "description": "Name of the TargetHttpsProxy resource to patch.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", + "request": { + "$ref": "TargetHttpsProxy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setQuicOverride": { "description": "Sets the QUIC override policy for TargetHttpsProxy.", "httpMethod": "POST", @@ -22339,7 +23169,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", "request": { "$ref": "TargetHttpsProxiesSetQuicOverrideRequest" }, @@ -22380,7 +23210,7 @@ "type": "string" } }, - "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", + "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "request": { "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" }, @@ -22420,7 +23250,7 @@ "type": "string" } }, - "path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", + "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", "request": { "$ref": "SslPolicyReference" }, @@ -22461,7 +23291,7 @@ "type": "string" } }, - "path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", + "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "request": { "$ref": "UrlMapReference" }, @@ -22526,7 +23356,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/targetInstances", + "path": "projects/{project}/aggregated/targetInstances", "response": { "$ref": "TargetInstanceAggregatedList" }, @@ -22573,7 +23403,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/targetInstances/{targetInstance}", + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "response": { "$ref": "Operation" }, @@ -22614,7 +23444,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/targetInstances/{targetInstance}", + "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "response": { "$ref": "TargetInstance" }, @@ -22653,7 +23483,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/targetInstances", + "path": "projects/{project}/zones/{zone}/targetInstances", "request": { "$ref": "TargetInstance" }, @@ -22717,7 +23547,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/targetInstances", + "path": "projects/{project}/zones/{zone}/targetInstances", "response": { "$ref": "TargetInstanceList" }, @@ -22768,7 +23598,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", "request": { "$ref": "TargetPoolsAddHealthCheckRequest" }, @@ -22817,7 +23647,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", "request": { "$ref": "TargetPoolsAddInstanceRequest" }, @@ -22878,7 +23708,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/targetPools", + "path": "projects/{project}/aggregated/targetPools", "response": { "$ref": "TargetPoolAggregatedList" }, @@ -22925,7 +23755,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", "response": { "$ref": "Operation" }, @@ -22966,7 +23796,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", "response": { "$ref": "TargetPool" }, @@ -23008,7 +23838,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", "request": { "$ref": "InstanceReference" }, @@ -23050,7 +23880,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools", + "path": "projects/{project}/regions/{region}/targetPools", "request": { "$ref": "TargetPool" }, @@ -23114,7 +23944,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/targetPools", + "path": "projects/{project}/regions/{region}/targetPools", "response": { "$ref": "TargetPoolList" }, @@ -23161,7 +23991,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", "request": { "$ref": "TargetPoolsRemoveHealthCheckRequest" }, @@ -23210,7 +24040,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", "request": { "$ref": "TargetPoolsRemoveInstanceRequest" }, @@ -23265,7 +24095,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup", + "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", "request": { "$ref": "TargetReference" }, @@ -23310,7 +24140,7 @@ "type": "string" } }, - "path": "{project}/global/targetSslProxies/{targetSslProxy}", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", "response": { "$ref": "Operation" }, @@ -23343,7 +24173,7 @@ "type": "string" } }, - "path": "{project}/global/targetSslProxies/{targetSslProxy}", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", "response": { "$ref": "TargetSslProxy" }, @@ -23374,7 +24204,7 @@ "type": "string" } }, - "path": "{project}/global/targetSslProxies", + "path": "projects/{project}/global/targetSslProxies", "request": { "$ref": "TargetSslProxy" }, @@ -23430,7 +24260,7 @@ "type": "boolean" } }, - "path": "{project}/global/targetSslProxies", + "path": "projects/{project}/global/targetSslProxies", "response": { "$ref": "TargetSslProxyList" }, @@ -23469,7 +24299,7 @@ "type": "string" } }, - "path": "{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", "request": { "$ref": "TargetSslProxiesSetBackendServiceRequest" }, @@ -23510,7 +24340,7 @@ "type": "string" } }, - "path": "{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", "request": { "$ref": "TargetSslProxiesSetProxyHeaderRequest" }, @@ -23551,7 +24381,7 @@ "type": "string" } }, - "path": "{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", "request": { "$ref": "TargetSslProxiesSetSslCertificatesRequest" }, @@ -23591,7 +24421,7 @@ "type": "string" } }, - "path": "{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", + "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", "request": { "$ref": "SslPolicyReference" }, @@ -23636,7 +24466,7 @@ "type": "string" } }, - "path": "{project}/global/targetTcpProxies/{targetTcpProxy}", + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", "response": { "$ref": "Operation" }, @@ -23669,7 +24499,7 @@ "type": "string" } }, - "path": "{project}/global/targetTcpProxies/{targetTcpProxy}", + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", "response": { "$ref": "TargetTcpProxy" }, @@ -23700,7 +24530,7 @@ "type": "string" } }, - "path": "{project}/global/targetTcpProxies", + "path": "projects/{project}/global/targetTcpProxies", "request": { "$ref": "TargetTcpProxy" }, @@ -23756,7 +24586,7 @@ "type": "boolean" } }, - "path": "{project}/global/targetTcpProxies", + "path": "projects/{project}/global/targetTcpProxies", "response": { "$ref": "TargetTcpProxyList" }, @@ -23795,7 +24625,7 @@ "type": "string" } }, - "path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", "request": { "$ref": "TargetTcpProxiesSetBackendServiceRequest" }, @@ -23836,7 +24666,7 @@ "type": "string" } }, - "path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", + "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", "request": { "$ref": "TargetTcpProxiesSetProxyHeaderRequest" }, @@ -23901,7 +24731,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/targetVpnGateways", + "path": "projects/{project}/aggregated/targetVpnGateways", "response": { "$ref": "TargetVpnGatewayAggregatedList" }, @@ -23948,7 +24778,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", + "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "response": { "$ref": "Operation" }, @@ -23989,7 +24819,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", + "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "response": { "$ref": "TargetVpnGateway" }, @@ -24028,7 +24858,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/targetVpnGateways", + "path": "projects/{project}/regions/{region}/targetVpnGateways", "request": { "$ref": "TargetVpnGateway" }, @@ -24092,7 +24922,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/targetVpnGateways", + "path": "projects/{project}/regions/{region}/targetVpnGateways", "response": { "$ref": "TargetVpnGatewayList" }, @@ -24155,7 +24985,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/urlMaps", + "path": "projects/{project}/aggregated/urlMaps", "response": { "$ref": "UrlMapsAggregatedList" }, @@ -24194,7 +25024,7 @@ "type": "string" } }, - "path": "{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/urlMaps/{urlMap}", "response": { "$ref": "Operation" }, @@ -24227,7 +25057,7 @@ "type": "string" } }, - "path": "{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/urlMaps/{urlMap}", "response": { "$ref": "UrlMap" }, @@ -24258,7 +25088,7 @@ "type": "string" } }, - "path": "{project}/global/urlMaps", + "path": "projects/{project}/global/urlMaps", "request": { "$ref": "UrlMap" }, @@ -24271,7 +25101,7 @@ ] }, "invalidateCache": { - "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.", + "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.\n\nFor more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).", "httpMethod": "POST", "id": "compute.urlMaps.invalidateCache", "parameterOrder": [ @@ -24299,7 +25129,7 @@ "type": "string" } }, - "path": "{project}/global/urlMaps/{urlMap}/invalidateCache", + "path": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", "request": { "$ref": "CacheInvalidationRule" }, @@ -24355,7 +25185,7 @@ "type": "boolean" } }, - "path": "{project}/global/urlMaps", + "path": "projects/{project}/global/urlMaps", "response": { "$ref": "UrlMapList" }, @@ -24394,7 +25224,7 @@ "type": "string" } }, - "path": "{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/urlMaps/{urlMap}", "request": { "$ref": "UrlMap" }, @@ -24435,7 +25265,7 @@ "type": "string" } }, - "path": "{project}/global/urlMaps/{urlMap}", + "path": "projects/{project}/global/urlMaps/{urlMap}", "request": { "$ref": "UrlMap" }, @@ -24471,7 +25301,7 @@ "type": "string" } }, - "path": "{project}/global/urlMaps/{urlMap}/validate", + "path": "projects/{project}/global/urlMaps/{urlMap}/validate", "request": { "$ref": "UrlMapsValidateRequest" }, @@ -24536,7 +25366,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/vpnGateways", + "path": "projects/{project}/aggregated/vpnGateways", "response": { "$ref": "VpnGatewayAggregatedList" }, @@ -24583,7 +25413,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnGateways/{vpnGateway}", + "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", "response": { "$ref": "Operation" }, @@ -24624,7 +25454,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnGateways/{vpnGateway}", + "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", "response": { "$ref": "VpnGateway" }, @@ -24666,7 +25496,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", + "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", "response": { "$ref": "VpnGatewaysGetStatusResponse" }, @@ -24705,7 +25535,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnGateways", + "path": "projects/{project}/regions/{region}/vpnGateways", "request": { "$ref": "VpnGateway" }, @@ -24769,7 +25599,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/vpnGateways", + "path": "projects/{project}/regions/{region}/vpnGateways", "response": { "$ref": "VpnGatewayList" }, @@ -24816,7 +25646,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnGateways/{resource}/setLabels", + "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", "request": { "$ref": "RegionSetLabelsRequest" }, @@ -24860,7 +25690,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", + "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -24926,7 +25756,7 @@ "type": "boolean" } }, - "path": "{project}/aggregated/vpnTunnels", + "path": "projects/{project}/aggregated/vpnTunnels", "response": { "$ref": "VpnTunnelAggregatedList" }, @@ -24973,7 +25803,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "response": { "$ref": "Operation" }, @@ -25014,7 +25844,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}", + "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "response": { "$ref": "VpnTunnel" }, @@ -25053,7 +25883,7 @@ "type": "string" } }, - "path": "{project}/regions/{region}/vpnTunnels", + "path": "projects/{project}/regions/{region}/vpnTunnels", "request": { "$ref": "VpnTunnel" }, @@ -25117,7 +25947,7 @@ "type": "boolean" } }, - "path": "{project}/regions/{region}/vpnTunnels", + "path": "projects/{project}/regions/{region}/vpnTunnels", "response": { "$ref": "VpnTunnelList" }, @@ -25163,7 +25993,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/operations/{operation}", + "path": "projects/{project}/zones/{zone}/operations/{operation}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" @@ -25201,7 +26031,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/operations/{operation}", + "path": "projects/{project}/zones/{zone}/operations/{operation}", "response": { "$ref": "Operation" }, @@ -25263,7 +26093,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/operations", + "path": "projects/{project}/zones/{zone}/operations", "response": { "$ref": "OperationList" }, @@ -25305,7 +26135,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}/operations/{operation}/wait", + "path": "projects/{project}/zones/{zone}/operations/{operation}/wait", "response": { "$ref": "Operation" }, @@ -25343,7 +26173,7 @@ "type": "string" } }, - "path": "{project}/zones/{zone}", + "path": "projects/{project}/zones/{zone}", "response": { "$ref": "Zone" }, @@ -25397,7 +26227,7 @@ "type": "boolean" } }, - "path": "{project}/zones", + "path": "projects/{project}/zones", "response": { "$ref": "ZoneList" }, @@ -25410,7 +26240,7 @@ } } }, - "revision": "20200901", + "revision": "20210111", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -25525,6 +26355,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -25566,6 +26397,7 @@ "", "", "", + "", "" ], "type": "string" @@ -25639,6 +26471,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -25680,6 +26513,7 @@ "", "", "", + "", "" ], "type": "string" @@ -25735,6 +26569,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -25776,6 +26611,7 @@ "", "", "", + "", "" ], "type": "string" @@ -25944,7 +26780,7 @@ "type": "integer" }, "purpose": { - "description": "The purpose of this resource, which can be one of the following values: \n- `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. \n- `DNS_RESOLVER` for a DNS resolver address in a subnetwork \n- `VPC_PEERING` for addresses that are reserved for VPC peer networks. \n- `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.", + "description": "The purpose of this resource, which can be one of the following values: \n- `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. \n- `DNS_RESOLVER` for a DNS resolver address in a subnetwork \n- `VPC_PEERING` for addresses that are reserved for VPC peer networks. \n- `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT. \n- `IPSEC_INTERCONNECT` for addresses created from a private IP range that are reserved for a VLAN attachment in an IPsec encrypted Interconnect configuration. These addresses are regional resources.", "enum": [ "DNS_RESOLVER", "GCE_ENDPOINT", @@ -26046,6 +26882,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -26087,6 +26924,7 @@ "", "", "", + "", "" ], "type": "string" @@ -26160,6 +26998,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -26201,6 +27040,7 @@ "", "", "", + "", "" ], "type": "string" @@ -26256,6 +27096,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -26297,6 +27138,7 @@ "", "", "", + "", "" ], "type": "string" @@ -26328,6 +27170,17 @@ }, "type": "object" }, + "AdvancedMachineFeatures": { + "description": "Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled).", + "id": "AdvancedMachineFeatures", + "properties": { + "enableNestedVirtualization": { + "description": "Whether to enable nested virtualization or not (default is false).", + "type": "boolean" + } + }, + "type": "object" + }, "AliasIpRange": { "description": "An alias IP range attached to an instance's network interface.", "id": "AliasIpRange", @@ -26669,7 +27522,7 @@ "type": "object" }, "Autoscaler": { - "description": "Represents an Autoscaler resource.\n\nGoogle Compute Engine has two Autoscaler resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)\n\nUse autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.\n\nFor zonal managed instance groups resource, use the autoscaler resource.\n\nFor regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)", + "description": "Represents an Autoscaler resource.\n\nGoogle Compute Engine has two Autoscaler resources:\n\n* [Zonal](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)\n\nUse autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.\n\nFor zonal managed instance groups resource, use the autoscaler resource.\n\nFor regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)", "id": "Autoscaler", "properties": { "autoscalingPolicy": { @@ -26705,7 +27558,7 @@ "type": "string" }, "recommendedSize": { - "description": "[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.", + "description": "[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.", "format": "int32", "type": "integer" }, @@ -26741,7 +27594,7 @@ "type": "array" }, "target": { - "description": "URL of the managed instance group that this autoscaler will scale.", + "description": "URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.", "type": "string" }, "zone": { @@ -26800,6 +27653,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -26841,6 +27695,7 @@ "", "", "", + "", "" ], "type": "string" @@ -26914,6 +27769,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -26955,6 +27811,7 @@ "", "", "", + "", "" ], "type": "string" @@ -26994,7 +27851,7 @@ "type": "string" }, "type": { - "description": "The type of error, warning, or notice returned. Current set of possible values: \n- ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). \n- BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. \n- CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. \n- CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. \n- CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. \n- MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. \n- MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. \n- MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. \n- MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. \n- MODE_ONLY_UP (WARNING): Autoscaling is in the \"Autoscale only up\" mode. The autoscaler can add instances but not remove any. \n- MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. \n- NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. \n- REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. \n- SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. \n- UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. \n- ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.", + "description": "The type of error, warning, or notice returned. Current set of possible values: \n- ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). \n- BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. \n- CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. \n- CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. \n- CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. \n- MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. \n- MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. \n- MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. \n- MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. \n- MODE_ONLY_UP (WARNING): Autoscaling is in the \"Autoscale only out\" mode. The autoscaler can add instances but not remove any. \n- MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. \n- NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. \n- REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. \n- SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. \n- UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. \n- ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.", "enum": [ "ALL_INSTANCES_UNHEALTHY", "BACKEND_SERVICE_DOES_NOT_EXIST", @@ -27064,6 +27921,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -27105,6 +27963,7 @@ "", "", "", + "", "" ], "type": "string" @@ -27141,7 +28000,7 @@ "id": "AutoscalingPolicy", "properties": { "coolDownPeriodSec": { - "description": "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.", + "description": "The number of seconds that the autoscaler waits before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.", "format": "int32", "type": "integer" }, @@ -27161,12 +28020,12 @@ "description": "Configuration parameters of autoscaling based on load balancer." }, "maxNumReplicas": { - "description": "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.", + "description": "The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.", "format": "int32", "type": "integer" }, "minNumReplicas": { - "description": "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.", + "description": "The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.", "format": "int32", "type": "integer" }, @@ -27197,7 +28056,7 @@ "id": "AutoscalingPolicyCpuUtilization", "properties": { "utilizationTarget": { - "description": "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.", + "description": "The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales in the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.\n\nIf the average CPU is above the target utilization, the autoscaler scales out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.", "format": "double", "type": "number" } @@ -27208,12 +28067,21 @@ "description": "Custom utilization metric policy.", "id": "AutoscalingPolicyCustomMetricUtilization", "properties": { + "filter": { + "description": "A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data.\n\nFor the filter to be valid for autoscaling purposes, the following rules apply: \n- You can only use the AND operator for joining selectors. \n- You can only use direct equality comparison operator (=) without any functions for each selector. \n- You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. \n- The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels.\nIf the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling.\n\nIf not specified, the type defaults to gce_instance. \n\nTry to provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.", + "type": "string" + }, "metric": { "description": "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.", "type": "string" }, + "singleInstanceAssignment": { + "description": "If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler keeps the number of instances proportional to the value of this metric. The metric itself does not change value due to group resizing.\n\nA good metric to use with the target is for example pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances.\n\nA bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.", + "format": "double", + "type": "number" + }, "utilizationTarget": { - "description": "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.", + "description": "The target value of the metric that autoscaler maintains. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is https://www.googleapis.com/compute/v1/instance/network/received_bytes_count. The autoscaler works to keep this value constant for each of the instances.", "format": "double", "type": "number" }, @@ -27239,7 +28107,7 @@ "id": "AutoscalingPolicyLoadBalancingUtilization", "properties": { "utilizationTarget": { - "description": "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.", + "description": "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that the autoscaler maintains. Must be a positive float value. If not defined, the default is 0.8.", "format": "double", "type": "number" } @@ -27255,7 +28123,7 @@ "description": "Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step." }, "timeWindowSec": { - "description": "How long back autoscaling should look when computing recommendations to include directives regarding slower scale in, as described above.", + "description": "How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.", "format": "int32", "type": "integer" } @@ -27267,7 +28135,7 @@ "id": "Backend", "properties": { "balancingMode": { - "description": "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.", + "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode.", "enum": [ "CONNECTION", "RATE", @@ -27281,7 +28149,7 @@ "type": "string" }, "capacityScaler": { - "description": "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. Valid range is 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.\n\nThis cannot be used for internal load balancing.", + "description": "A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service.\n\nNot supported by:\n\n- Internal TCP/UDP Load Balancing - Network Load Balancing", "format": "float", "type": "number" }, @@ -27294,41 +28162,40 @@ "type": "boolean" }, "group": { - "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. \n\nYou must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.", + "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL (except Network Load Balancing), INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED , the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is EXTERNAL for Network Load Balancing or INTERNAL for Internal TCP/UDP Load Balancing, the backend must be an instance group. NEGs are not supported. \n\nFor regional services, the backend must be in the same region as the backend service.\n\nYou must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.", "type": "string" }, "maxConnections": { - "description": "Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.", + "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. Not supported by:\n\n- Internal TCP/UDP Load Balancing - Network Load Balancing", "format": "int32", "type": "integer" }, "maxConnectionsPerEndpoint": { - "description": "Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.", + "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.\n\nNot available if the backend's balancingMode is RATE. Not supported by:\n\n- Internal TCP/UDP Load Balancing - Network Load Balancing.", "format": "int32", "type": "integer" }, "maxConnectionsPerInstance": { - "description": "Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.", + "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode.\n\nNot available if the backend's balancingMode is RATE. Not supported by:\n\n- Internal TCP/UDP Load Balancing - Network Load Balancing.", "format": "int32", "type": "integer" }, "maxRate": { - "description": "Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.", + "description": "Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.\n\nNot available if the backend's balancingMode is CONNECTION.", "format": "int32", "type": "integer" }, "maxRatePerEndpoint": { - "description": "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.", + "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.\n\nNot available if the backend's balancingMode is CONNECTION.", "format": "float", "type": "number" }, "maxRatePerInstance": { - "description": "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.", + "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode.\n\nNot available if the backend's balancingMode is CONNECTION.", "format": "float", "type": "number" }, "maxUtilization": { - "description": "Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.", "format": "float", "type": "number" } @@ -27351,6 +28218,13 @@ "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "customResponseHeaders": { + "description": "Headers that the HTTP/S load balancer should add to proxied responses.", + "items": { + "type": "string" + }, + "type": "array" + }, "description": { "description": "An optional textual description of the resource; provided by the client when the resource is created.", "type": "string" @@ -27385,6 +28259,37 @@ "description": "Message containing Cloud CDN configuration for a backend bucket.", "id": "BackendBucketCdnPolicy", "properties": { + "cacheMode": { + "description": "Specifies the cache setting for all responses from this backend. The possible values are:\n\nUSE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.\n\nFORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.\n\nCACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.", + "enum": [ + "CACHE_ALL_STATIC", + "FORCE_CACHE_ALL", + "INVALID_CACHE_MODE", + "USE_ORIGIN_HEADERS" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "clientTtl": { + "description": "Specifies a separate client (e.g. browser client) TTL, separate from the TTL for Cloud CDN's edge caches. Leaving this empty will use the same cache TTL for both Cloud CDN and the client-facing response. The maximum allowed value is 86400s (1 day).", + "format": "int32", + "type": "integer" + }, + "defaultTtl": { + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "format": "int32", + "type": "integer" + }, + "maxTtl": { + "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "format": "int32", + "type": "integer" + }, "signedUrlCacheMaxAgeSec": { "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.", "format": "int64", @@ -27442,6 +28347,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -27483,6 +28389,7 @@ "", "", "", + "", "" ], "type": "string" @@ -27532,7 +28439,7 @@ }, "cdnPolicy": { "$ref": "BackendServiceCdnPolicy", - "description": "Cloud CDN configuration for this BackendService." + "description": "Cloud CDN configuration for this BackendService. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing." }, "circuitBreakers": { "$ref": "CircuitBreakers", @@ -27556,6 +28463,13 @@ }, "type": "array" }, + "customResponseHeaders": { + "description": "Headers that the HTTP/S load balancer should add to proxied responses.", + "items": { + "type": "string" + }, + "type": "array" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -27566,7 +28480,7 @@ }, "failoverPolicy": { "$ref": "BackendServiceFailoverPolicy", - "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend." + "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend." }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.", @@ -27582,7 +28496,7 @@ }, "iap": { "$ref": "BackendServiceIAP", - "description": "The configurations for Identity-Aware Proxy on this resource." + "description": "The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing." }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", @@ -27595,7 +28509,7 @@ "type": "string" }, "loadBalancingScheme": { - "description": "Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.", + "description": "Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.", "enum": [ "EXTERNAL", "INTERNAL", @@ -27644,7 +28558,7 @@ "type": "string" }, "network": { - "description": "The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.", + "description": "The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.", "type": "string" }, "outlierDetection": { @@ -27657,7 +28571,7 @@ "type": "integer" }, "portName": { - "description": "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).", + "description": "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL (except Network Load Balancing), INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nBackend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name.", "type": "string" }, "protocol": { @@ -27690,12 +28604,16 @@ "description": "[Output Only] The resource URL for the security policy associated with this backend service.", "type": "string" }, + "securitySettings": { + "$ref": "SecuritySettings", + "description": "This field specifies the security policy that applies to this backend service. This field is applicable to either: \n- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. \n- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED." + }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "sessionAffinity": { - "description": "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.\n\nNot supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "Type of session affinity to use. The default is NONE.\n\nWhen the loadBalancingScheme is EXTERNAL: * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO. * For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.\n\nNot supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "CLIENT_IP", "CLIENT_IP_PORT_PROTO", @@ -27717,7 +28635,7 @@ "type": "string" }, "timeoutSec": { - "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings The default is 30 seconds.", + "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings The default is 30 seconds. The full range of timeout values allowed is 1 - 2,147,483,647 seconds.", "format": "int32", "type": "integer" } @@ -27774,6 +28692,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -27815,6 +28734,7 @@ "", "", "", + "", "" ], "type": "string" @@ -27854,6 +28774,37 @@ "$ref": "CacheKeyPolicy", "description": "The CacheKeyPolicy for this CdnPolicy." }, + "cacheMode": { + "description": "Specifies the cache setting for all responses from this backend. The possible values are:\n\nUSE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server.\n\nFORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.\n\nCACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.", + "enum": [ + "CACHE_ALL_STATIC", + "FORCE_CACHE_ALL", + "INVALID_CACHE_MODE", + "USE_ORIGIN_HEADERS" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" + }, + "clientTtl": { + "description": "Specifies a separate client (e.g. browser client) TTL, separate from the TTL for Cloud CDN's edge caches. Leaving this empty will use the same cache TTL for both Cloud CDN and the client-facing response. The maximum allowed value is 86400s (1 day).", + "format": "int32", + "type": "integer" + }, + "defaultTtl": { + "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "format": "int32", + "type": "integer" + }, + "maxTtl": { + "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", + "format": "int32", + "type": "integer" + }, "signedUrlCacheMaxAgeSec": { "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.", "format": "int64", @@ -27870,7 +28821,7 @@ "type": "object" }, "BackendServiceFailoverPolicy": { - "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", + "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", "id": "BackendServiceFailoverPolicy", "properties": { "disableConnectionDrainOnFailover": { @@ -27878,11 +28829,11 @@ "type": "boolean" }, "dropTrafficIfUnhealthy": { - "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.\n\nThe default is false.", + "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false.", "type": "boolean" }, "failoverRatio": { - "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.", + "description": "Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.", "format": "float", "type": "number" } @@ -27979,6 +28930,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -28020,6 +28972,7 @@ "", "", "", + "", "" ], "type": "string" @@ -28100,6 +29053,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -28141,6 +29095,7 @@ "", "", "", + "", "" ], "type": "string" @@ -28177,7 +29132,7 @@ "id": "Binding", "properties": { "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", + "description": "", "type": "string" }, "condition": { @@ -28437,6 +29392,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -28478,6 +29434,7 @@ "", "", "", + "", "" ], "type": "string" @@ -28551,6 +29508,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -28592,6 +29550,7 @@ "", "", "", + "", "" ], "type": "string" @@ -28647,6 +29606,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -28688,6 +29648,7 @@ "", "", "", + "", "" ], "type": "string" @@ -28815,7 +29776,7 @@ "id": "ConnectionDraining", "properties": { "drainingTimeoutSec": { - "description": "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].", + "description": "Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.", "format": "int32", "type": "integer" } @@ -28884,7 +29845,7 @@ "type": "array" }, "allowOriginRegexes": { - "description": "Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript \nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.", + "description": "Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax \nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.", "items": { "type": "string" }, @@ -29059,6 +30020,10 @@ }, "type": "array" }, + "locationHint": { + "description": "An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.", + "type": "string" + }, "name": { "annotations": { "required": [ @@ -29096,6 +30061,10 @@ }, "type": "array" }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" @@ -29137,8 +30106,12 @@ "description": "[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.", "type": "string" }, + "sourceStorageObject": { + "description": "The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.", + "type": "string" + }, "status": { - "description": "[Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.", + "description": "[Output Only] The status of disk creation. \n- CREATING: Disk is provisioning. \n- RESTORING: Source data is being copied into the disk. \n- FAILED: Disk creation failed. \n- READY: Disk is ready for use. \n- DELETING: Disk is deleting.", "enum": [ "CREATING", "DELETING", @@ -29222,6 +30195,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -29263,6 +30237,7 @@ "", "", "", + "", "" ], "type": "string" @@ -29377,6 +30352,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -29418,6 +30394,7 @@ "", "", "", + "", "" ], "type": "string" @@ -29567,6 +30544,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -29608,6 +30586,7 @@ "", "", "", + "", "" ], "type": "string" @@ -29681,6 +30660,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -29722,6 +30702,7 @@ "", "", "", + "", "" ], "type": "string" @@ -29777,6 +30758,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -29818,6 +30800,7 @@ "", "", "", + "", "" ], "type": "string" @@ -29910,6 +30893,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -29951,6 +30935,7 @@ "", "", "", + "", "" ], "type": "string" @@ -29997,7 +30982,7 @@ "id": "DistributionPolicy", "properties": { "zones": { - "description": "Zones where the regional managed instance group will create and manage instances.", + "description": "Zones where the regional managed instance group will create and manage its instances.", "items": { "$ref": "DistributionPolicyZoneConfiguration" }, @@ -30116,6 +31101,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -30157,6 +31143,7 @@ "", "", "", + "", "" ], "type": "string" @@ -30344,6 +31331,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -30385,6 +31373,7 @@ "", "", "", + "", "" ], "type": "string" @@ -30634,6 +31623,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -30675,6 +31665,7 @@ "", "", "", + "", "" ], "type": "string" @@ -30729,6 +31720,354 @@ }, "type": "object" }, + "FirewallPoliciesListAssociationsResponse": { + "id": "FirewallPoliciesListAssociationsResponse", + "properties": { + "associations": { + "description": "A list of associations.", + "items": { + "$ref": "FirewallPolicyAssociation" + }, + "type": "array" + }, + "kind": { + "default": "compute#firewallPoliciesListAssociationsResponse", + "description": "[Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations.", + "type": "string" + } + }, + "type": "object" + }, + "FirewallPolicy": { + "description": "Represents a Firewall Policy resource. (== resource_for {$api_version}.firewallPolicies ==)", + "id": "FirewallPolicy", + "properties": { + "associations": { + "description": "A list of associations that belong to this firewall policy.", + "items": { + "$ref": "FirewallPolicyAssociation" + }, + "type": "array" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "displayName": { + "description": "User-provided name of the Organization firewall plicy. The name should be unique in the organization in which the firewall policy is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "fingerprint": { + "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make get() request to the firewall policy.", + "format": "byte", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#firewallPolicy", + "description": "[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies", + "type": "string" + }, + "name": { + "description": "[Output Only] Name of the resource. It is a numeric ID allocated by GCP which uniquely identifies the Firewall Policy.", + "type": "string" + }, + "parent": { + "description": "[Output Only] The parent of the firewall policy.", + "type": "string" + }, + "ruleTupleCount": { + "description": "[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.", + "format": "int32", + "type": "integer" + }, + "rules": { + "description": "A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + } + }, + "type": "object" + }, + "FirewallPolicyAssociation": { + "id": "FirewallPolicyAssociation", + "properties": { + "attachmentTarget": { + "description": "The target that the firewall policy is attached to.", + "type": "string" + }, + "displayName": { + "description": "[Output Only] The display name of the firewall policy of the association.", + "type": "string" + }, + "firewallPolicyId": { + "description": "[Output Only] The firewall policy ID of the association.", + "type": "string" + }, + "name": { + "description": "The name for an association.", + "type": "string" + } + }, + "type": "object" + }, + "FirewallPolicyList": { + "id": "FirewallPolicyList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of FirewallPolicy resources.", + "items": { + "$ref": "FirewallPolicy" + }, + "type": "array" + }, + "kind": { + "default": "compute#firewallPolicyList", + "description": "[Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "FirewallPolicyRule": { + "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).", + "id": "FirewallPolicyRule", + "properties": { + "action": { + "description": "The Action to perform when the client connection triggers the rule. Can currently be either \"allow\" or \"deny()\" where valid values for status are 403, 404, and 502.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "direction": { + "description": "The direction in which this rule applies.", + "enum": [ + "EGRESS", + "INGRESS" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "disabled": { + "description": "Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.", + "type": "boolean" + }, + "enableLogging": { + "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules.", + "type": "boolean" + }, + "kind": { + "default": "compute#firewallPolicyRule", + "description": "[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules", + "type": "string" + }, + "match": { + "$ref": "FirewallPolicyRuleMatcher", + "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." + }, + "priority": { + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.", + "format": "int32", + "type": "integer" + }, + "ruleTupleCount": { + "description": "[Output Only] Calculation of the complexity of a single firewall policy rule.", + "format": "int32", + "type": "integer" + }, + "targetResources": { + "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetSecureLabels": { + "description": "A list of secure labels that controls which instances the firewall rule applies to. If targetSecureLabel are specified, then the firewall rule applies only to instances in the VPC network that have one of those secure labels. targetSecureLabel may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureLabel are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label values allowed is 256.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetServiceAccounts": { + "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FirewallPolicyRuleMatcher": { + "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", + "id": "FirewallPolicyRuleMatcher", + "properties": { + "destIpRanges": { + "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.", + "items": { + "type": "string" + }, + "type": "array" + }, + "layer4Configs": { + "description": "Pairs of IP protocols and ports that the rule should match.", + "items": { + "$ref": "FirewallPolicyRuleMatcherLayer4Config" + }, + "type": "array" + }, + "srcIpRanges": { + "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.", + "items": { + "type": "string" + }, + "type": "array" + }, + "srcSecureLabels": { + "description": "List of firewall label values, which should be matched at the source of the traffic. Maximum number of source label values allowed is 256.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FirewallPolicyRuleMatcherLayer4Config": { + "id": "FirewallPolicyRuleMatcherLayer4Config", + "properties": { + "ipProtocol": { + "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", + "type": "string" + }, + "ports": { + "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.\n\nExample inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "FixedOrPercent": { "description": "Encapsulates numeric value that can be either absolute or relative.", "id": "FixedOrPercent", @@ -30756,11 +32095,11 @@ "id": "ForwardingRule", "properties": { "IPAddress": { - "description": "IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.\n\nIf you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:\n\n* IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: * projects/project_id/regions/region/addresses/address-name * regions/region/addresses/address-name * global/addresses/address-name * address-name \n\nThe loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n\nMust be set to `0.0.0.0` when the target is targetGrpcProxy that has validateForProxyless field set to true.", + "description": "IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.\n\nIf you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:\n\n* IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: \n- projects/project_id/regions/region/addresses/address-name \n- regions/region/addresses/address-name \n- global/addresses/address-name \n- address-name \n\nThe loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n\nMust be set to `0.0.0.0` when the target is targetGrpcProxy that has validateForProxyless field set to true.", "type": "string" }, "IPProtocol": { - "description": "The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP or ICMP.\n\nFor Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid.", + "description": "The IP protocol to which this rule applies.\n\nFor protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP and ICMP.\n\nThe valid IP protocols are different for different load balancing products: \n- Internal TCP/UDP Load Balancing: The load balancing scheme is INTERNAL, and one of TCP, UDP or ALL is valid. \n- Traffic Director: The load balancing scheme is INTERNAL_SELF_MANAGED, and only TCP is valid. \n- Internal HTTP(S) Load Balancing: The load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. \n- HTTP(S), SSL Proxy, and TCP Proxy Load Balancing: The load balancing scheme is EXTERNAL and only TCP is valid. \n- Network Load Balancing: The load balancing scheme is EXTERNAL, and one of TCP or UDP is valid.", "enum": [ "AH", "ESP", @@ -30788,7 +32127,7 @@ "type": "boolean" }, "backendService": { - "description": "This field is only used for INTERNAL load balancing.\n\nFor internal load balancing, this field identifies the BackendService resource to receive the matched traffic.", + "description": "Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.", "type": "string" }, "creationTimestamp": { @@ -30832,8 +32171,20 @@ "description": "[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.", "type": "string" }, + "labelFingerprint": { + "description": "A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a ForwardingRule.", + "format": "byte", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.", + "type": "object" + }, "loadBalancingScheme": { - "description": "Specifies the forwarding rule type.\n\n \n- EXTERNAL is used for: \n- Classic Cloud VPN gateways \n- Protocol forwarding to VMs from an external IP address \n- The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP \n- INTERNAL is used for: \n- Protocol forwarding to VMs from an internal IP address \n- Internal TCP/UDP load balancers \n- INTERNAL_MANAGED is used for: \n- Internal HTTP(S) load balancers \n- INTERNAL_SELF_MANAGED is used for: \n- Traffic Director \n\nFor more information about forwarding rules, refer to Forwarding rule concepts.", + "description": "Specifies the forwarding rule type.\n\n \n- EXTERNAL is used for: \n- Classic Cloud VPN gateways \n- Protocol forwarding to VMs from an external IP address \n- HTTP(S), SSL Proxy, TCP Proxy, and Network Load Balancing \n- INTERNAL is used for: \n- Protocol forwarding to VMs from an internal IP address \n- Internal TCP/UDP Load Balancing \n- INTERNAL_MANAGED is used for: \n- Internal HTTP(S) Load Balancing \n- INTERNAL_SELF_MANAGED is used for: \n- Traffic Director \n\nFor more information about forwarding rules, refer to Forwarding rule concepts.", "enum": [ "EXTERNAL", "INTERNAL", @@ -30863,7 +32214,7 @@ "type": "string" }, "network": { - "description": "This field is not used for external load balancing.\n\nFor internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.", + "description": "This field is not used for external load balancing.\n\nFor Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.", "type": "string" }, "networkTier": { @@ -30879,11 +32230,11 @@ "type": "string" }, "portRange": { - "description": "When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and INTERNAL_MANAGED, you can specify a port_range. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetGrpcProxy, TargetVpnGateway, TargetPool, TargetInstance.\n\nApplicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.\n\nSome types of forwarding target have constraints on the acceptable ports: \n- TargetHttpProxy: 80, 8080 \n- TargetHttpsProxy: 443 \n- TargetGrpcProxy: Any ports \n- TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 \n- TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 \n- TargetVpnGateway: 500, 4500", + "description": "This field can be used only if: * Load balancing scheme is one of EXTERNAL, INTERNAL_SELF_MANAGED or INTERNAL_MANAGED, and * IPProtocol is one of TCP, UDP, or SCTP.\n\nPackets addressed to ports in the specified range will be forwarded to target or backend_service. You can only use one of ports, port_range, or allPorts. The three are mutually exclusive. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.\n\nSome types of forwarding target have constraints on the acceptable ports: \n- TargetHttpProxy: 80, 8080 \n- TargetHttpsProxy: 443 \n- TargetGrpcProxy: no constraints \n- TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 \n- TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 \n- TargetVpnGateway: 500, 4500", "type": "string" }, "ports": { - "description": "This field is used along with the backend_service field for internal load balancing.\n\nWhen the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule.\n\nIf the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways:\n\n* A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol.", + "description": "The ports field is only supported when the forwarding rule references a backend_service directly. Supported load balancing products are Internal TCP/UDP Load Balancing and Network Load Balancing. Only packets addressed to the specified list of ports are forwarded to backends.\n\nYou can only use one of ports and port_range, or allPorts. The three are mutually exclusive.\n\nYou can specify a list of up to five ports, which can be non-contiguous.\n\nFor Internal TCP/UDP Load Balancing, if you specify allPorts, you should not specify ports.\n\nFor more information, see [Port specifications](/load-balancing/docs/forwarding-rule-concepts#port_specifications).", "items": { "type": "string" }, @@ -30911,7 +32262,7 @@ "type": "string" }, "target": { - "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only targetHttpProxy and targetGrpcProxy are valid, not targetHttpsProxy.", + "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the \"Target\" column in [Port specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).", "type": "string" } }, @@ -30966,6 +32317,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -31007,6 +32359,7 @@ "", "", "", + "", "" ], "type": "string" @@ -31080,6 +32433,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -31121,6 +32475,7 @@ "", "", "", + "", "" ], "type": "string" @@ -31185,6 +32540,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -31226,6 +32582,7 @@ "", "", "", + "", "" ], "type": "string" @@ -31316,6 +32673,28 @@ }, "type": "object" }, + "GlobalOrganizationSetPolicyRequest": { + "id": "GlobalOrganizationSetPolicyRequest", + "properties": { + "bindings": { + "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", + "format": "byte", + "type": "string" + }, + "policy": { + "$ref": "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 in general a valid policy but certain services (like Projects) might reject them." + } + }, + "type": "object" + }, "GlobalSetLabelsRequest": { "id": "GlobalSetLabelsRequest", "properties": { @@ -31428,6 +32807,7 @@ "description": "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.", "enum": [ "FEATURE_TYPE_UNSPECIFIED", + "GVNIC", "MULTI_IP_SUBNET", "SECURE_BOOT", "SEV_CAPABLE", @@ -31442,6 +32822,7 @@ "", "", "", + "", "" ], "type": "string" @@ -31609,7 +32990,7 @@ "type": "object" }, "HealthCheck": { - "description": "Represents a Health Check resource.\n\nGoogle Compute Engine has two Health Check resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)\n\nInternal HTTP(S) load balancers must use regional health checks. Internal TCP/UDP load balancers can use either regional or global health checks. All other types of GCP load balancers and managed instance group auto-healing must use global health checks. For more information, read Health Check Concepts.\n\nTo perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.", + "description": "Represents a Health Check resource.\n\nGoogle Compute Engine has two Health Check resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)\n\nInternal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`).\n\nTraffic Director must use global health checks (`compute.v1.HealthChecks`).\n\nInternal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.HealthChecks`).\n\nExternal HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.HealthChecks`).\n\nNetwork load balancers must use legacy HTTP health checks (httpHealthChecks).\n\nFor more information, see Health checks overview.", "id": "HealthCheck", "properties": { "checkIntervalSec": { @@ -31652,6 +33033,10 @@ "description": "Type of the resource.", "type": "string" }, + "logConfig": { + "$ref": "HealthCheckLogConfig", + "description": "Configure logging on this health check." + }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", @@ -31748,6 +33133,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -31789,6 +33175,7 @@ "", "", "", + "", "" ], "type": "string" @@ -31820,6 +33207,17 @@ }, "type": "object" }, + "HealthCheckLogConfig": { + "description": "Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.", + "id": "HealthCheckLogConfig", + "properties": { + "enable": { + "description": "Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.", + "type": "boolean" + } + }, + "type": "object" + }, "HealthCheckReference": { "description": "A full or valid partial URL to a health check. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check \n- projects/project-id/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check", "id": "HealthCheckReference", @@ -31957,6 +33355,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -31998,6 +33397,7 @@ "", "", "", + "", "" ], "type": "string" @@ -32078,6 +33478,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -32119,6 +33520,7 @@ "", "", "", + "", "" ], "type": "string" @@ -32174,6 +33576,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -32215,6 +33618,7 @@ "", "", "", + "", "" ], "type": "string" @@ -32280,6 +33684,24 @@ "description": "The named port of the instance group, not necessarily the port that is health-checked.", "format": "int32", "type": "integer" + }, + "weight": { + "type": "string" + }, + "weightError": { + "enum": [ + "INVALID_WEIGHT", + "MISSING_WEIGHT", + "UNAVAILABLE_WEIGHT", + "WEIGHT_NONE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -32456,7 +33878,7 @@ "description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.\nFor example for a range [-5, 0] \n- -3 will match. \n- 0 will not match. \n- 0.25 will not match. \n- -3someString will not match. \nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.\nNote that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL." }, "regexMatch": { - "description": "The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript \nFor matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.\nNote that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.", + "description": "The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax \nFor matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.\nNote that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.", "type": "string" }, "suffixMatch": { @@ -32594,6 +34016,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -32635,6 +34058,7 @@ "", "", "", + "", "" ], "type": "string" @@ -32683,7 +34107,7 @@ "type": "boolean" }, "regexMatch": { - "description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript \nOnly one of presentMatch, exactMatch or regexMatch must be set.\nNote that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", + "description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see github.com/google/re2/wiki/Syntax \nOnly one of presentMatch, exactMatch or regexMatch must be set.\nNote that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -32871,7 +34295,7 @@ "type": "array" }, "regexMatch": { - "description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript \nOnly one of prefixMatch, fullPathMatch or regexMatch must be specified.\nNote that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.", + "description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see github.com/google/re2/wiki/Syntax \nOnly one of prefixMatch, fullPathMatch or regexMatch must be specified.\nNote that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -32986,6 +34410,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -33027,6 +34452,7 @@ "", "", "", + "", "" ], "type": "string" @@ -33299,6 +34725,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -33340,6 +34767,7 @@ "", "", "", + "", "" ], "type": "string" @@ -33407,6 +34835,10 @@ "description": "Represents an Instance resource.\n\nAn instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)", "id": "Instance", "properties": { + "advancedMachineFeatures": { + "$ref": "AdvancedMachineFeatures", + "description": "Controls for advanced machine-related behavior features." + }, "canIpForward": { "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.", "type": "boolean" @@ -33479,6 +34911,18 @@ "description": "Labels to apply to this instance. These can be later modified by the setLabels method.", "type": "object" }, + "lastStartTimestamp": { + "description": "[Output Only] Last start timestamp in RFC3339 text format.", + "type": "string" + }, + "lastStopTimestamp": { + "description": "[Output Only] Last stop timestamp in RFC3339 text format.", + "type": "string" + }, + "lastSuspendedTimestamp": { + "description": "[Output Only] Last suspended timestamp in RFC3339 text format.", + "type": "string" + }, "machineType": { "annotations": { "required": [ @@ -33538,6 +34982,10 @@ }, "type": "array" }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, "scheduling": { "$ref": "Scheduling", "description": "Sets the scheduling options for this instance." @@ -33564,7 +35012,7 @@ "type": "boolean" }, "status": { - "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED.", + "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.", "enum": [ "DEPROVISIONING", "PROVISIONING", @@ -33655,6 +35103,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -33696,6 +35145,7 @@ "", "", "", + "", "" ], "type": "string" @@ -33848,6 +35298,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -33889,6 +35340,7 @@ "", "", "", + "", "" ], "type": "string" @@ -33962,6 +35414,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -34003,6 +35456,7 @@ "", "", "", + "", "" ], "type": "string" @@ -34069,7 +35523,7 @@ }, "distributionPolicy": { "$ref": "DistributionPolicy", - "description": "Policy specifying intended distribution of instances in regional managed instance group." + "description": "Policy specifying the intended distribution of managed instances across zones in a regional managed instance group." }, "fingerprint": { "description": "Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.", @@ -34086,7 +35540,7 @@ "type": "string" }, "instanceTemplate": { - "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.", + "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "type": "string" }, "kind": { @@ -34158,7 +35612,7 @@ "type": "array" }, "zone": { - "description": "[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).", + "description": "[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).", "type": "string" } }, @@ -34264,6 +35718,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -34305,6 +35760,7 @@ "", "", "", + "", "" ], "type": "string" @@ -34394,6 +35850,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -34435,6 +35892,7 @@ "", "", "", + "", "" ], "type": "string" @@ -34539,11 +35997,11 @@ }, "maxSurge": { "$ref": "FixedOrPercent", - "description": "The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.\n\nAt least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge." + "description": "The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded up if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates.\n\nAt least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge." }, "maxUnavailable": { "$ref": "FixedOrPercent", - "description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:\n\n \n- The instance's status is RUNNING. \n- If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.\n\nAt least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable." + "description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:\n\n \n- The instance's status is RUNNING. \n- If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded up if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates.\n\nAt least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable." }, "minimalAction": { "description": "Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.", @@ -34592,7 +36050,7 @@ "id": "InstanceGroupManagerVersion", "properties": { "instanceTemplate": { - "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached.", + "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.", "type": "string" }, "name": { @@ -34623,6 +36081,10 @@ "description": "InstanceGroupManagers.applyUpdatesToInstances", "id": "InstanceGroupManagersApplyUpdatesRequest", "properties": { + "allInstances": { + "description": "Flag to update all instances instead of specified list of ?instances?. If the flag is set to true then the instances may not be specified in the request.", + "type": "boolean" + }, "instances": { "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", "items": { @@ -34768,6 +36230,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -34809,6 +36272,7 @@ "", "", "", + "", "" ], "type": "string" @@ -34891,6 +36355,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -34932,6 +36397,7 @@ "", "", "", + "", "" ], "type": "string" @@ -34967,7 +36433,7 @@ "id": "InstanceGroupManagersSetInstanceTemplateRequest", "properties": { "instanceTemplate": { - "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.", + "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "type": "string" } }, @@ -35059,6 +36525,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -35100,6 +36567,7 @@ "", "", "", + "", "" ], "type": "string" @@ -35186,6 +36654,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -35227,6 +36696,7 @@ "", "", "", + "", "" ], "type": "string" @@ -35318,6 +36788,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -35359,6 +36830,7 @@ "", "", "", + "", "" ], "type": "string" @@ -35432,6 +36904,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -35473,6 +36946,7 @@ "", "", "", + "", "" ], "type": "string" @@ -35594,6 +37068,10 @@ "description": "", "id": "InstanceProperties", "properties": { + "advancedMachineFeatures": { + "$ref": "AdvancedMachineFeatures", + "description": "Controls for advanced machine-related behavior features." + }, "canIpForward": { "description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", "type": "boolean" @@ -35800,6 +37278,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -35841,6 +37320,7 @@ "", "", "", + "", "" ], "type": "string" @@ -35967,6 +37447,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -36008,6 +37489,7 @@ "", "", "", + "", "" ], "type": "string" @@ -36343,6 +37825,11 @@ "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", "type": "string" }, + "dataplaneVersion": { + "description": "[Output Only] Dataplane version for this InterconnectAttachment.", + "format": "int32", + "type": "integer" + }, "description": { "description": "An optional description of this resource.", "type": "string" @@ -36379,6 +37866,11 @@ "description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.", "type": "string" }, + "mtu": { + "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", + "format": "int32", + "type": "integer" + }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", @@ -36518,6 +38010,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -36559,6 +38052,7 @@ "", "", "", + "", "" ], "type": "string" @@ -36632,6 +38126,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -36673,6 +38168,7 @@ "", "", "", + "", "" ], "type": "string" @@ -36759,6 +38255,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -36800,6 +38297,7 @@ "", "", "", + "", "" ], "type": "string" @@ -37019,6 +38517,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -37060,6 +38559,7 @@ "", "", "", + "", "" ], "type": "string" @@ -37237,6 +38737,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -37278,6 +38779,7 @@ "", "", "", + "", "" ], "type": "string" @@ -37638,6 +39140,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -37679,6 +39182,7 @@ "", "", "", + "", "" ], "type": "string" @@ -37710,6 +39214,26 @@ }, "type": "object" }, + "LocalDisk": { + "id": "LocalDisk", + "properties": { + "diskCount": { + "description": "Specifies the number of such disks.", + "format": "int32", + "type": "integer" + }, + "diskSizeGb": { + "description": "Specifies the size of the disk in base-2 GB.", + "format": "int32", + "type": "integer" + }, + "diskType": { + "description": "Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL.", + "type": "string" + } + }, + "type": "object" + }, "LogConfig": { "description": "Specifies what kind of log the caller must write", "id": "LogConfig", @@ -37962,6 +39486,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -38003,6 +39528,7 @@ "", "", "", + "", "" ], "type": "string" @@ -38076,6 +39602,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -38117,6 +39644,7 @@ "", "", "", + "", "" ], "type": "string" @@ -38172,6 +39700,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -38213,6 +39742,7 @@ "", "", "", + "", "" ], "type": "string" @@ -38618,7 +40148,7 @@ "type": "string" }, "port": { - "description": "Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.", + "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.", "format": "int32", "type": "integer" } @@ -38626,7 +40156,7 @@ "type": "object" }, "NetworkEndpointGroup": { - "description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)", + "description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)", "id": "NetworkEndpointGroup", "properties": { "annotations": { @@ -38770,6 +40300,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -38811,6 +40342,7 @@ "", "", "", + "", "" ], "type": "string" @@ -38847,7 +40379,7 @@ "id": "NetworkEndpointGroupAppEngine", "properties": { "service": { - "description": "Optional serving service.\n\nThe service name must be 1-63 characters long, and comply with RFC1035.\n\nExample value: \"default\", \"my-service\".", + "description": "Optional serving service.\n\nThe service name is case-sensitive and must be 1-63 characters long.\n\nExample value: \"default\", \"my-service\".", "type": "string" }, "urlMask": { @@ -38855,7 +40387,7 @@ "type": "string" }, "version": { - "description": "Optional serving version.\n\nThe version must be 1-63 characters long, and comply with RFC1035.\n\nExample value: \"v1\", \"v2\".", + "description": "Optional serving version.\n\nThe version name is case-sensitive and must be 1-100 characters long.\n\nExample value: \"v1\", \"v2\".", "type": "string" } }, @@ -38936,6 +40468,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -38977,6 +40510,7 @@ "", "", "", + "", "" ], "type": "string" @@ -39089,6 +40623,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -39130,6 +40665,7 @@ "", "", "", + "", "" ], "type": "string" @@ -39185,6 +40721,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -39226,6 +40763,7 @@ "", "", "", + "", "" ], "type": "string" @@ -39318,6 +40856,20 @@ "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", "type": "string" }, + "nicType": { + "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", + "enum": [ + "GVNIC", + "UNSPECIFIED_NIC_TYPE", + "VIRTIO_NET" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, "subnetwork": { "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork \n- regions/region/subnetworks/subnetwork", "type": "string" @@ -39367,6 +40919,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -39408,6 +40961,7 @@ "", "", "", + "", "" ], "type": "string" @@ -39610,6 +41164,9 @@ ], "type": "string" }, + "maintenanceWindow": { + "$ref": "NodeGroupMaintenanceWindow" + }, "name": { "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "string" @@ -39698,6 +41255,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -39739,6 +41297,7 @@ "", "", "", + "", "" ], "type": "string" @@ -39774,7 +41333,7 @@ "id": "NodeGroupAutoscalingPolicy", "properties": { "maxNodes": { - "description": "The maximum number of nodes that the group should have.", + "description": "The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.", "format": "int32", "type": "integer" }, @@ -39844,6 +41403,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -39885,6 +41445,7 @@ "", "", "", + "", "" ], "type": "string" @@ -39916,9 +41477,31 @@ }, "type": "object" }, + "NodeGroupMaintenanceWindow": { + "description": "Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.", + "id": "NodeGroupMaintenanceWindow", + "properties": { + "maintenanceDuration": { + "$ref": "Duration", + "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario." + }, + "startTime": { + "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.", + "type": "string" + } + }, + "type": "object" + }, "NodeGroupNode": { "id": "NodeGroupNode", "properties": { + "accelerators": { + "description": "Accelerators for this node.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + }, "cpuOvercommitType": { "description": "CPU overcommit.", "enum": [ @@ -39933,6 +41516,13 @@ ], "type": "string" }, + "disks": { + "description": "Local disk configurations.", + "items": { + "$ref": "LocalDisk" + }, + "type": "array" + }, "instances": { "description": "Instances scheduled on this node.", "items": { @@ -40041,6 +41631,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -40082,6 +41673,7 @@ "", "", "", + "", "" ], "type": "string" @@ -40137,6 +41729,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -40178,6 +41771,7 @@ "", "", "", + "", "" ], "type": "string" @@ -40223,6 +41817,12 @@ "description": "Represent a sole-tenant Node Template resource.\n\nYou can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for {$api_version}.nodeTemplates ==)", "id": "NodeTemplate", "properties": { + "accelerators": { + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + }, "cpuOvercommitType": { "description": "CPU overcommit.", "enum": [ @@ -40245,6 +41845,12 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "disks": { + "items": { + "$ref": "LocalDisk" + }, + "type": "array" + }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -40358,6 +41964,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -40399,6 +42006,7 @@ "", "", "", + "", "" ], "type": "string" @@ -40472,6 +42080,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -40513,6 +42122,7 @@ "", "", "", + "", "" ], "type": "string" @@ -40583,6 +42193,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -40624,6 +42235,7 @@ "", "", "", + "", "" ], "type": "string" @@ -40765,6 +42377,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -40806,6 +42419,7 @@ "", "", "", + "", "" ], "type": "string" @@ -40879,6 +42493,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -40920,6 +42535,7 @@ "", "", "", + "", "" ], "type": "string" @@ -40975,6 +42591,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -41016,6 +42633,7 @@ "", "", "", + "", "" ], "type": "string" @@ -41158,6 +42776,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -41199,6 +42818,7 @@ "", "", "", + "", "" ], "type": "string" @@ -41371,6 +42991,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -41412,6 +43033,7 @@ "", "", "", + "", "" ], "type": "string" @@ -41498,6 +43120,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -41539,6 +43162,7 @@ "", "", "", + "", "" ], "type": "string" @@ -41612,6 +43236,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -41653,6 +43278,7 @@ "", "", "", + "", "" ], "type": "string" @@ -41708,6 +43334,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -41749,6 +43376,7 @@ "", "", "", + "", "" ], "type": "string" @@ -41971,6 +43599,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -42012,6 +43641,7 @@ "", "", "", + "", "" ], "type": "string" @@ -42059,6 +43689,20 @@ "type": "string" }, "type": "array" + }, + "direction": { + "description": "Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH.", + "enum": [ + "BOTH", + "EGRESS", + "INGRESS" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -42119,6 +43763,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -42160,6 +43805,7 @@ "", "", "", + "", "" ], "type": "string" @@ -42284,6 +43930,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -42325,6 +43972,7 @@ "", "", "", + "", "" ], "type": "string" @@ -42765,6 +44413,7 @@ "CPUS", "CPUS_ALL_REGIONS", "DISKS_TOTAL_GB", + "E2_CPUS", "EXTERNAL_NETWORK_LB_FORWARDING_RULES", "EXTERNAL_PROTOCOL_FORWARDING_RULES", "EXTERNAL_VPN_GATEWAYS", @@ -42809,6 +44458,7 @@ "NVIDIA_T4_VWS_GPUS", "NVIDIA_V100_GPUS", "PACKET_MIRRORINGS", + "PD_EXTREME_TOTAL_PROVISIONED_IOPS", "PREEMPTIBLE_CPUS", "PREEMPTIBLE_LOCAL_SSD_GB", "PREEMPTIBLE_NVIDIA_A100_GPUS", @@ -42820,6 +44470,7 @@ "PREEMPTIBLE_NVIDIA_T4_GPUS", "PREEMPTIBLE_NVIDIA_T4_VWS_GPUS", "PREEMPTIBLE_NVIDIA_V100_GPUS", + "PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK", "PUBLIC_ADVERTISED_PREFIXES", "PUBLIC_DELEGATED_PREFIXES", "REGIONAL_AUTOSCALERS", @@ -42846,7 +44497,8 @@ "TARGET_VPN_GATEWAYS", "URL_MAPS", "VPN_GATEWAYS", - "VPN_TUNNELS" + "VPN_TUNNELS", + "XPN_SERVICE_PROJECTS" ], "enumDescriptions": [ "", @@ -42954,6 +44606,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -43047,6 +44703,10 @@ ], "type": "string" }, + "supportsPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, "zones": { "description": "[Output Only] A list of zones available in this region, in the form of resource URLs.", "items": { @@ -43099,6 +44759,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -43140,6 +44801,7 @@ "", "", "", + "", "" ], "type": "string" @@ -43212,6 +44874,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -43253,6 +44916,7 @@ "", "", "", + "", "" ], "type": "string" @@ -43363,6 +45027,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -43404,6 +45069,7 @@ "", "", "", + "", "" ], "type": "string" @@ -43491,6 +45157,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -43532,6 +45199,7 @@ "", "", "", + "", "" ], "type": "string" @@ -43608,6 +45276,10 @@ "description": "RegionInstanceGroupManagers.applyUpdatesToInstances", "id": "RegionInstanceGroupManagersApplyUpdatesRequest", "properties": { + "allInstances": { + "description": "Flag to update all instances instead of specified list of ?instances?. If the flag is set to true then the instances may not be specified in the request.", + "type": "boolean" + }, "instances": { "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", "items": { @@ -43722,6 +45394,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -43763,6 +45436,7 @@ "", "", "", + "", "" ], "type": "string" @@ -43893,6 +45567,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -43934,6 +45609,7 @@ "", "", "", + "", "" ], "type": "string" @@ -44048,6 +45724,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -44089,6 +45766,7 @@ "", "", "", + "", "" ], "type": "string" @@ -44351,6 +46029,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -44392,6 +46071,7 @@ "", "", "", + "", "" ], "type": "string" @@ -44464,6 +46144,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -44505,6 +46186,7 @@ "", "", "", + "", "" ], "type": "string" @@ -44571,6 +46253,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -44612,6 +46295,7 @@ "", "", "", + "", "" ], "type": "string" @@ -44711,6 +46395,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -44752,6 +46437,7 @@ "", "", "", + "", "" ], "type": "string" @@ -44796,7 +46482,7 @@ }, "groupPlacementPolicy": { "$ref": "ResourcePolicyGroupPlacementPolicy", - "description": "Resource policy for instacnes for placement configuration." + "description": "Resource policy for instances for placement configuration." }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", @@ -44901,6 +46587,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -44942,6 +46629,7 @@ "", "", "", + "", "" ], "type": "string" @@ -45086,6 +46774,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -45127,6 +46816,7 @@ "", "", "", + "", "" ], "type": "string" @@ -45223,6 +46913,10 @@ "description": "Specified snapshot properties for scheduled snapshots created by this policy.", "id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", "properties": { + "chainName": { + "description": "Chain name that the snapshot is created in.", + "type": "string" + }, "guestFlush": { "description": "Indication to perform a 'guest aware' snapshot.", "type": "boolean" @@ -45314,7 +47008,7 @@ "compute.routes.insert" ] }, - "description": "The destination range of outgoing packets that this route applies to. Only IPv4 is supported.", + "description": "The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.", "type": "string" }, "id": { @@ -45351,7 +47045,7 @@ "type": "string" }, "nextHopIlb": { - "description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule \n- regions/region/forwardingRules/forwardingRule", + "description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: \n- 10.128.0.56 \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule \n- regions/region/forwardingRules/forwardingRule", "type": "string" }, "nextHopInstance": { @@ -45415,6 +47109,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -45456,6 +47151,7 @@ "", "", "", + "", "" ], "type": "string" @@ -45531,6 +47227,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -45572,6 +47269,7 @@ "", "", "", + "", "" ], "type": "string" @@ -45746,6 +47444,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -45787,6 +47486,7 @@ "", "", "", + "", "" ], "type": "string" @@ -46030,6 +47730,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -46071,6 +47772,7 @@ "", "", "", + "", "" ], "type": "string" @@ -46113,6 +47815,9 @@ }, "type": "array" }, + "enableEndpointIndependentMapping": { + "type": "boolean" + }, "icmpIdleTimeoutSec": { "description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.", "format": "int32", @@ -46450,6 +48155,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -46491,6 +48197,7 @@ "", "", "", + "", "" ], "type": "string" @@ -46645,6 +48352,10 @@ "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.\n\nBy default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, + "locationHint": { + "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.", + "type": "string" + }, "minNodeCpus": { "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.", "format": "int32", @@ -46743,7 +48454,7 @@ "type": "object" }, "SecurityPolicy": { - "description": "Represents a Cloud Armor Security Policy resource.\n\nOnly external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.securityPolicies ==)", + "description": "Represents a Google Cloud Armor security policy resource.\n\nOnly external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview. (== resource_for {$api_version}.securityPolicies ==)", "id": "SecurityPolicy", "properties": { "creationTimestamp": { @@ -46825,6 +48536,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -46866,6 +48578,7 @@ "", "", "", + "", "" ], "type": "string" @@ -46932,7 +48645,7 @@ "type": "boolean" }, "priority": { - "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.", + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", "format": "int32", "type": "integer" } @@ -46977,6 +48690,24 @@ }, "type": "object" }, + "SecuritySettings": { + "description": "The authentication and authorization settings for a BackendService.", + "id": "SecuritySettings", + "properties": { + "clientTlsPolicy": { + "description": "Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends.\nclientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.\nIf left blank, communications are not encrypted.\nNote: This field currently has no impact.", + "type": "string" + }, + "subjectAltNames": { + "description": "Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service.\nNote that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities.\nOnly applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).\nNote: This field currently has no impact.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SerialPortOutput": { "description": "An instance's serial console output.", "id": "SerialPortOutput", @@ -47133,6 +48864,10 @@ "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.", "type": "boolean" }, + "chainName": { + "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.", + "type": "string" + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -47188,11 +48923,19 @@ }, "type": "array" }, + "locationHint": { + "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.", + "type": "string" + }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "satisfiesPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" + }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" @@ -47300,6 +49043,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -47341,6 +49085,7 @@ "", "", "", + "", "" ], "type": "string" @@ -47514,6 +49259,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -47555,6 +49301,7 @@ "", "", "", + "", "" ], "type": "string" @@ -47628,6 +49375,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -47669,6 +49417,7 @@ "", "", "", + "", "" ], "type": "string" @@ -47730,7 +49479,7 @@ "type": "object" }, "domains": { - "description": "The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.", + "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](/load-balancing/docs/quotas#ssl_certificates).", "items": { "type": "string" }, @@ -47798,6 +49547,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -47839,6 +49589,7 @@ "", "", "", + "", "" ], "type": "string" @@ -47911,6 +49662,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -47952,6 +49704,7 @@ "", "", "", + "", "" ], "type": "string" @@ -47996,7 +49749,7 @@ "type": "object" }, "SslPolicy": { - "description": "Represents a Cloud Armor Security Policy resource.\n\nOnly external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)", + "description": "Represents an SSL Policy resource.\n\nUse SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)", "id": "SslPolicy", "properties": { "creationTimestamp": { @@ -48090,6 +49843,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -48131,6 +49885,7 @@ "", "", "", + "", "" ], "type": "string" @@ -48331,7 +50086,7 @@ "type": "string" }, "state": { - "description": "[Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY.", + "description": "[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY CREATING: Subnetwork is provisioning DELETING: Subnetwork is being deleted UPDATING: Subnetwork is being updated", "enum": [ "DRAINING", "READY" @@ -48394,6 +50149,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -48435,6 +50191,7 @@ "", "", "", + "", "" ], "type": "string" @@ -48508,6 +50265,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -48549,6 +50307,7 @@ "", "", "", + "", "" ], "type": "string" @@ -48690,6 +50449,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -48731,6 +50491,7 @@ "", "", "", + "", "" ], "type": "string" @@ -48840,7 +50601,7 @@ "type": "object" }, "TargetGrpcProxy": { - "description": "Represents a Target gRPC Proxy resource.\n\nA target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Global forwarding rules reference a target gRPC proxy. The Target gRPC Proxy references a URL map which specifies how traffic routes to gRPC backend services. (== resource_for {$api_version}.targetGrpcProxies ==)", + "description": "Represents a Target gRPC Proxy resource.\n\nA target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Only global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target gRPC Proxy references a URL map that specifies how traffic is routed to gRPC backend services. (== resource_for {$api_version}.targetGrpcProxies ==)", "id": "TargetGrpcProxy", "properties": { "creationTimestamp": { @@ -48936,6 +50697,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -48977,6 +50739,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49032,6 +50795,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -49073,6 +50837,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49136,6 +50901,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "proxyBind": { + "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.\n\nWhen this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.\n\nThe default is false.", + "type": "boolean" + }, "region": { "description": "[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.", "type": "string" @@ -49231,6 +51000,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -49272,6 +51042,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49327,6 +51098,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -49368,6 +51140,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49436,6 +51209,10 @@ "description": "Represents a Target HTTPS Proxy resource.\n\nGoogle Compute Engine has two Target HTTPS Proxy resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)\n\nA target HTTPS proxy is a component of GCP HTTPS load balancers.\n\n* targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.\n\nForwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)", "id": "TargetHttpsProxy", "properties": { + "authorizationPolicy": { + "description": "Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.\nRefer to the AuthorizationPolicy resource for additional details.\nauthorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.\nNote: This field currently has no impact.", + "type": "string" + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -49459,8 +51236,12 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "proxyBind": { + "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.\n\nWhen this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.\n\nThe default is false.", + "type": "boolean" + }, "quicOverride": { - "description": "Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. \n- When quic-override is set to NONE, Google manages whether QUIC is used. \n- When quic-override is set to ENABLE, the load balancer uses QUIC when possible. \n- When quic-override is set to DISABLE, the load balancer doesn't use QUIC. \n- If the quic-override flag is not specified, NONE is implied.\n-", + "description": "Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. \n- When quic-override is set to NONE, Google manages whether QUIC is used. \n- When quic-override is set to ENABLE, the load balancer uses QUIC when possible. \n- When quic-override is set to DISABLE, the load balancer doesn't use QUIC. \n- If the quic-override flag is not specified, NONE is implied.", "enum": [ "DISABLE", "ENABLE", @@ -49481,6 +51262,10 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "serverTlsPolicy": { + "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.\nserverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.\nIf left blank, communications are not encrypted.\nNote: This field currently has no impact.", + "type": "string" + }, "sslCertificates": { "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.", "items": { @@ -49548,6 +51333,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -49589,6 +51375,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49662,6 +51449,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -49703,6 +51491,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49835,6 +51624,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -49876,6 +51666,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49949,6 +51740,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -49990,6 +51782,7 @@ "", "", "", + "", "" ], "type": "string" @@ -50045,6 +51838,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -50086,6 +51880,7 @@ "", "", "", + "", "" ], "type": "string" @@ -50122,7 +51917,7 @@ "id": "TargetPool", "properties": { "backupPool": { - "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].\n\nbackupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.", + "description": "The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].\n\nbackupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.", "type": "string" }, "creationTimestamp": { @@ -50139,7 +51934,7 @@ "type": "number" }, "healthChecks": { - "description": "The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only legacy HttpHealthChecks are supported. Only one health check may be specified.", + "description": "The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.", "items": { "type": "string" }, @@ -50249,6 +52044,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -50290,6 +52086,7 @@ "", "", "", + "", "" ], "type": "string" @@ -50380,6 +52177,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -50421,6 +52219,7 @@ "", "", "", + "", "" ], "type": "string" @@ -50528,6 +52327,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -50569,6 +52369,7 @@ "", "", "", + "", "" ], "type": "string" @@ -50753,6 +52554,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -50794,6 +52596,7 @@ "", "", "", + "", "" ], "type": "string" @@ -50945,6 +52748,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -50986,6 +52790,7 @@ "", "", "", + "", "" ], "type": "string" @@ -51148,6 +52953,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -51189,6 +52995,7 @@ "", "", "", + "", "" ], "type": "string" @@ -51262,6 +53069,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -51303,6 +53111,7 @@ "", "", "", + "", "" ], "type": "string" @@ -51358,6 +53167,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -51399,6 +53209,7 @@ "", "", "", + "", "" ], "type": "string" @@ -51433,14 +53244,39 @@ "TestFailure": { "id": "TestFailure", "properties": { + "actualOutputUrl": { + "description": "The actual output URL evaluated by load balancer containing the scheme, host, path and query parameters.", + "type": "string" + }, + "actualRedirectResponseCode": { + "description": "Actual HTTP status code for rule with `urlRedirect` calculated by load balancer", + "format": "int32", + "type": "integer" + }, "actualService": { "description": "BackendService or BackendBucket returned by load balancer.", "type": "string" }, + "expectedOutputUrl": { + "description": "The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters.", + "type": "string" + }, + "expectedRedirectResponseCode": { + "description": "Expected HTTP status code for rule with `urlRedirect` calculated by load balancer", + "format": "int32", + "type": "integer" + }, "expectedService": { "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to.", "type": "string" }, + "headers": { + "description": "HTTP headers of the request.", + "items": { + "$ref": "UrlMapTestHeader" + }, + "type": "array" + }, "host": { "description": "Host portion of the URL.", "type": "string" @@ -51600,6 +53436,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -51641,6 +53478,7 @@ "", "", "", + "", "" ], "type": "string" @@ -51689,6 +53527,22 @@ "description": "Description of this test case.", "type": "string" }, + "expectedOutputUrl": { + "description": "The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters.\nFor rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored.\nFor rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters.\nexpectedOutputUrl is optional when service is specified.", + "type": "string" + }, + "expectedRedirectResponseCode": { + "description": "For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response.\nexpectedRedirectResponseCode cannot be set when service is set.", + "format": "int32", + "type": "integer" + }, + "headers": { + "description": "HTTP headers for this request. If headers contains a host header, then host must also match the header value.", + "items": { + "$ref": "UrlMapTestHeader" + }, + "type": "array" + }, "host": { "description": "Host portion of the URL. If headers contains a host header, then host must also match the header value.", "type": "string" @@ -51704,6 +53558,21 @@ }, "type": "object" }, + "UrlMapTestHeader": { + "description": "HTTP headers used in UrlMapTests.", + "id": "UrlMapTestHeader", + "properties": { + "name": { + "description": "Header name.", + "type": "string" + }, + "value": { + "description": "Header value.", + "type": "string" + } + }, + "type": "object" + }, "UrlMapValidationResult": { "description": "Message representing the validation result for a UrlMap.", "id": "UrlMapValidationResult", @@ -51780,6 +53649,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -51821,6 +53691,7 @@ "", "", "", + "", "" ], "type": "string" @@ -51876,6 +53747,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -51917,6 +53789,7 @@ "", "", "", + "", "" ], "type": "string" @@ -52064,6 +53937,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -52105,6 +53979,7 @@ "", "", "", + "", "" ], "type": "string" @@ -52249,6 +54124,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -52290,6 +54166,7 @@ "", "", "", + "", "" ], "type": "string" @@ -52441,6 +54318,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -52482,6 +54360,7 @@ "", "", "", + "", "" ], "type": "string" @@ -52555,6 +54434,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -52596,6 +54476,7 @@ "", "", "", + "", "" ], "type": "string" @@ -52765,6 +54646,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -52806,6 +54688,7 @@ "", "", "", + "", "" ], "type": "string" @@ -53028,6 +54911,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -53069,6 +54953,7 @@ "", "", "", + "", "" ], "type": "string" @@ -53142,6 +55027,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -53183,6 +55069,7 @@ "", "", "", + "", "" ], "type": "string" @@ -53238,6 +55125,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -53279,6 +55167,7 @@ "", "", "", + "", "" ], "type": "string" @@ -53405,6 +55294,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -53446,6 +55336,7 @@ "", "", "", + "", "" ], "type": "string" @@ -53556,6 +55447,10 @@ "" ], "type": "string" + }, + "supportsPzs": { + "description": "[Output Only] Reserved for future use.", + "type": "boolean" } }, "type": "object" @@ -53602,6 +55497,7 @@ "EXTERNAL_API_WARNING", "FIELD_VALUE_OVERRIDEN", "INJECTED_KERNELS_DEPRECATED", + "LARGE_DEPLOYMENT_WARNING", "MISSING_TYPE_DEPENDENCY", "NEXT_HOP_ADDRESS_NOT_ASSIGNED", "NEXT_HOP_CANNOT_IP_FORWARD", @@ -53643,6 +55539,7 @@ "", "", "", + "", "" ], "type": "string" @@ -53715,7 +55612,7 @@ "type": "object" } }, - "servicePath": "compute/v1/projects/", + "servicePath": "compute/v1/", "title": "Compute Engine API", "version": "v1" } \ No newline at end of file
diff --git a/discovery/googleapis/container__v1.json b/discovery/googleapis/container__v1.json index 6887751..ecd4cef 100644 --- a/discovery/googleapis/container__v1.json +++ b/discovery/googleapis/container__v1.json
@@ -944,7 +944,7 @@ ] }, "setSize": { - "description": "Sets the size for a specific node pool.", + "description": "Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.", "httpMethod": "POST", "id": "container.projects.locations.clusters.nodePools.setSize", "parameterOrder": [ @@ -2171,7 +2171,7 @@ ] }, "setSize": { - "description": "Sets the size for a specific node pool.", + "description": "Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.", "httpMethod": "POST", "id": "container.projects.zones.clusters.nodePools.setSize", "parameterOrder": [ @@ -2394,7 +2394,7 @@ } } }, - "revision": "20200928", + "revision": "20210119", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2429,6 +2429,10 @@ "$ref": "DnsCacheConfig", "description": "Configuration for NodeLocalDNS, a dns cache running on cluster nodes" }, + "gcePersistentDiskCsiDriverConfig": { + "$ref": "GcePersistentDiskCsiDriverConfig", + "description": "Configuration for the Compute Engine Persistent Disk CSI driver." + }, "horizontalPodAutoscaling": { "$ref": "HorizontalPodAutoscaling", "description": "Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods." @@ -2492,7 +2496,7 @@ "type": "integer" }, "diskType": { - "description": "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'", + "description": "Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'", "type": "string" }, "management": { @@ -2730,7 +2734,7 @@ "type": "string" }, "locations": { - "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -2788,6 +2792,10 @@ }, "type": "array" }, + "notificationConfig": { + "$ref": "NotificationConfig", + "description": "Notification configuration of the cluster." + }, "privateClusterConfig": { "$ref": "PrivateClusterConfig", "description": "Configuration for private cluster." @@ -2842,7 +2850,7 @@ "type": "string" }, "statusMessage": { - "description": "[Output only] Additional information about the current status of this cluster, if available.", + "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", "type": "string" }, "subnetwork": { @@ -2930,7 +2938,7 @@ "description": "The desired config of Intra-node visibility." }, "desiredLocations": { - "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", + "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -2964,10 +2972,30 @@ "description": "The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"-\": picks the Kubernetes master version", "type": "string" }, + "desiredNotificationConfig": { + "$ref": "NotificationConfig", + "description": "The desired notification configuration." + }, "desiredPrivateClusterConfig": { "$ref": "PrivateClusterConfig", "description": "The desired private cluster configuration." }, + "desiredPrivateIpv6GoogleAccess": { + "description": "The desired state of IPv6 connectivity to Google Services.", + "enum": [ + "PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", + "PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED", + "PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE", + "PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL" + ], + "enumDescriptions": [ + "Default value. Same as DISABLED", + "No private access to or from Google Services", + "Enables private IPv6 access to Google Services from GKE", + "Enables priate IPv6 access to and from Google Services" + ], + "type": "string" + }, "desiredReleaseChannel": { "$ref": "ReleaseChannel", "description": "The desired release channel configuration." @@ -3154,6 +3182,17 @@ "properties": {}, "type": "object" }, + "GcePersistentDiskCsiDriverConfig": { + "description": "Configuration for the Compute Engine PD CSI driver.", + "id": "GcePersistentDiskCsiDriverConfig", + "properties": { + "enabled": { + "description": "Whether the Compute Engine PD CSI driver is enabled for this cluster.", + "type": "boolean" + } + }, + "type": "object" + }, "GetJSONWebKeysResponse": { "description": "GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517", "id": "GetJSONWebKeysResponse", @@ -3616,6 +3655,22 @@ "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "type": "string" }, + "privateIpv6GoogleAccess": { + "description": "The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)", + "enum": [ + "PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", + "PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED", + "PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE", + "PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL" + ], + "enumDescriptions": [ + "Default value. Same as DISABLED", + "No private access to or from Google Services", + "Enables private IPv6 access to Google Services from GKE", + "Enables priate IPv6 access to and from Google Services" + ], + "type": "string" + }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "type": "string" @@ -3678,7 +3733,7 @@ "type": "integer" }, "diskType": { - "description": "Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard'", + "description": "Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'", "type": "string" }, "imageType": { @@ -3705,7 +3760,7 @@ "additionalProperties": { "type": "string" }, - "description": "The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - \"cluster-location\" - \"cluster-name\" - \"cluster-uid\" - \"configure-sh\" - \"containerd-configure-sh\" - \"enable-os-login\" - \"gci-ensure-gke-docker\" - \"gci-metrics-enabled\" - \"gci-update-strategy\" - \"instance-template\" - \"kube-env\" - \"startup-script\" - \"user-data\" - \"disable-address-manager\" - \"windows-startup-script-ps1\" - \"common-psm1\" - \"k8s-node-setup-psm1\" - \"install-ssh-psm1\" - \"user-profile-psm1\" - \"serial-port-logging-enable\" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.", + "description": "The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - \"cluster-location\" - \"cluster-name\" - \"cluster-uid\" - \"configure-sh\" - \"containerd-configure-sh\" - \"enable-os-login\" - \"gci-ensure-gke-docker\" - \"gci-metrics-enabled\" - \"gci-update-strategy\" - \"instance-template\" - \"kube-env\" - \"startup-script\" - \"user-data\" - \"disable-address-manager\" - \"windows-startup-script-ps1\" - \"common-psm1\" - \"k8s-node-setup-psm1\" - \"install-ssh-psm1\" - \"user-profile-psm1\" The following keys are reserved for Windows nodes: - \"serial-port-logging-enable\" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.", "type": "object" }, "minCpuPlatform": { @@ -3815,7 +3870,7 @@ "type": "array" }, "locations": { - "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -3865,7 +3920,7 @@ "type": "string" }, "statusMessage": { - "description": "[Output only] Additional information about the current status of this node pool instance, if available.", + "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", "type": "string" }, "upgradeSettings": { @@ -3935,6 +3990,17 @@ }, "type": "object" }, + "NotificationConfig": { + "description": "NotificationConfig is the configuration of notifications.", + "id": "NotificationConfig", + "properties": { + "pubsub": { + "$ref": "PubSub", + "description": "Notification config for Pub/Sub." + } + }, + "type": "object" + }, "Operation": { "description": "This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.", "id": "Operation", @@ -4147,6 +4213,21 @@ }, "type": "object" }, + "PubSub": { + "description": "Pub/Sub specific notification config.", + "id": "PubSub", + "properties": { + "enabled": { + "description": "Enable notifications for Pub/Sub.", + "type": "boolean" + }, + "topic": { + "description": "The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.", + "type": "string" + } + }, + "type": "object" + }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", @@ -4714,7 +4795,7 @@ "type": "object" }, "SetNodePoolSizeRequest": { - "description": "SetNodePoolSizeRequest sets the size a node pool.", + "description": "SetNodePoolSizeRequest sets the size of a node pool.", "id": "SetNodePoolSizeRequest", "properties": { "clusterId": { @@ -4955,24 +5036,24 @@ "id": "UpgradeEvent", "properties": { "currentVersion": { - "description": "Required. The current version before the upgrade.", + "description": "The current version before the upgrade.", "type": "string" }, "operation": { - "description": "Required. The operation associated with this upgrade.", + "description": "The operation associated with this upgrade.", "type": "string" }, "operationStartTime": { - "description": "Required. The time when the operation was started.", + "description": "The time when the operation was started.", "format": "google-datetime", "type": "string" }, "resource": { - "description": "Optional. Optional relative path to the resource. For example in node pool upgrades, the relative path of the node pool.", + "description": "Optional relative path to the resource. For example in node pool upgrades, the relative path of the node pool.", "type": "string" }, "resourceType": { - "description": "Required. The resource type that is upgrading.", + "description": "The resource type that is upgrading.", "enum": [ "UPGRADE_RESOURCE_TYPE_UNSPECIFIED", "MASTER", @@ -4986,7 +5067,7 @@ "type": "string" }, "targetVersion": { - "description": "Required. The target version for the upgrade.", + "description": "The target version for the upgrade.", "type": "string" } },
diff --git a/discovery/googleapis/content__v2.1.json b/discovery/googleapis/content__v2.1.json index 73988ba..e7b5f86 100644 --- a/discovery/googleapis/content__v2.1.json +++ b/discovery/googleapis/content__v2.1.json
@@ -8,17 +8,16 @@ } } }, - "basePath": "/content/v2.1/", - "baseUrl": "https://www.googleapis.com/content/v2.1/", - "batchPath": "batch/content/v2.1", + "basePath": "", + "baseUrl": "https://shoppingcontent.googleapis.com/", + "batchPath": "batch", "canonicalName": "Shopping Content", - "description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.", + "description": "Manage your product listings and accounts for Google Shopping", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/shopping-content", - "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/ddORqCNPE80KZPQB362t_vez4eE\"", + "documentationLink": "https://developers.google.com/shopping-content/v2/", "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "content:v2.1", "kind": "discovery#restDescription", @@ -26,18 +25,45 @@ "ownerDomain": "google.com", "ownerName": "Google", "parameters": { - "alt": { - "default": "json", - "description": "Data format for the response.", + "$.xgafv": { + "description": "V1 error format.", "enum": [ - "json" + "1", + "2" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "v1 error format", + "v2 error format" ], "location": "query", "type": "string" }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -60,12 +86,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "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", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -78,7 +109,9 @@ "description": "Returns information about the authenticated user.", "httpMethod": "GET", "id": "content.accounts.authinfo", - "path": "accounts/authinfo", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/accounts/authinfo", "response": { "$ref": "AccountsAuthInfoResponse" }, @@ -115,7 +148,7 @@ "type": "boolean" } }, - "path": "{merchantId}/accounts/{accountId}/claimwebsite", + "path": "content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite", "response": { "$ref": "AccountsClaimWebsiteResponse" }, @@ -127,7 +160,9 @@ "description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.", "httpMethod": "POST", "id": "content.accounts.custombatch", - "path": "accounts/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/accounts/batch", "request": { "$ref": "AccountsCustomBatchRequest" }, @@ -168,7 +203,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts/{accountId}", + "path": "content/v2.1/{merchantId}/accounts/{accountId}", "scopes": [ "https://www.googleapis.com/auth/content" ] @@ -199,8 +234,8 @@ "view": { "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".", "enum": [ - "css", - "merchant" + "MERCHANT", + "CSS" ], "enumDescriptions": [ "", @@ -210,7 +245,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts/{accountId}", + "path": "content/v2.1/{merchantId}/accounts/{accountId}", "response": { "$ref": "Account" }, @@ -234,7 +269,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts", + "path": "content/v2.1/{merchantId}/accounts", "request": { "$ref": "Account" }, @@ -269,7 +304,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts/{accountId}/link", + "path": "content/v2.1/{merchantId}/accounts/{accountId}/link", "request": { "$ref": "AccountsLinkRequest" }, @@ -315,8 +350,8 @@ "view": { "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".", "enum": [ - "css", - "merchant" + "MERCHANT", + "CSS" ], "enumDescriptions": [ "", @@ -326,7 +361,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts", + "path": "content/v2.1/{merchantId}/accounts", "response": { "$ref": "AccountsListResponse" }, @@ -369,7 +404,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts/{accountId}/listlinks", + "path": "content/v2.1/{merchantId}/accounts/{accountId}/listlinks", "response": { "$ref": "AccountsListLinksResponse" }, @@ -401,7 +436,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts/{accountId}", + "path": "content/v2.1/{merchantId}/accounts/{accountId}", "request": { "$ref": "Account" }, @@ -436,7 +471,7 @@ "type": "string" } }, - "path": "{merchantId}/accounts/{accountId}/updatelabels", + "path": "content/v2.1/{merchantId}/accounts/{accountId}/updatelabels", "request": { "$ref": "AccountsUpdateLabelsRequest" }, @@ -447,6 +482,257 @@ "https://www.googleapis.com/auth/content" ] } + }, + "resources": { + "labels": { + "methods": { + "create": { + "description": "Creates a new label, not assigned to any account.", + "httpMethod": "POST", + "id": "content.accounts.labels.create", + "parameterOrder": [ + "accountId" + ], + "parameters": { + "accountId": { + "description": "Required. The id of the account this label belongs to.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/labels", + "request": { + "$ref": "AccountLabel" + }, + "response": { + "$ref": "AccountLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "delete": { + "description": "Deletes a label and removes it from all accounts to which it was assigned.", + "httpMethod": "DELETE", + "id": "content.accounts.labels.delete", + "parameterOrder": [ + "accountId", + "labelId" + ], + "parameters": { + "accountId": { + "description": "Required. The id of the account that owns the label.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "labelId": { + "description": "Required. The id of the label to delete.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/labels/{labelId}", + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the labels assigned to an account.", + "httpMethod": "GET", + "id": "content.accounts.labels.list", + "parameterOrder": [ + "accountId" + ], + "parameters": { + "accountId": { + "description": "Required. The account id for whose labels are to be listed.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/labels", + "response": { + "$ref": "ListAccountLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Updates a label.", + "httpMethod": "PATCH", + "id": "content.accounts.labels.patch", + "parameterOrder": [ + "accountId", + "labelId" + ], + "parameters": { + "accountId": { + "description": "Required. The id of the account this label belongs to.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "labelId": { + "description": "Required. The id of the label to update.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/labels/{labelId}", + "request": { + "$ref": "AccountLabel" + }, + "response": { + "$ref": "AccountLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "returncarrier": { + "methods": { + "create": { + "description": "Links return carrier to a merchant account.", + "httpMethod": "POST", + "id": "content.accounts.returncarrier.create", + "parameterOrder": [ + "accountId" + ], + "parameters": { + "accountId": { + "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/returncarrier", + "request": { + "$ref": "AccountReturnCarrier" + }, + "response": { + "$ref": "AccountReturnCarrier" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "delete": { + "description": "Delete a return carrier in the merchant account.", + "httpMethod": "DELETE", + "id": "content.accounts.returncarrier.delete", + "parameterOrder": [ + "accountId", + "carrierAccountId" + ], + "parameters": { + "accountId": { + "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "carrierAccountId": { + "description": "Required. The Google-provided unique carrier ID, used to update the resource.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/returncarrier/{carrierAccountId}", + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists available return carriers in the merchant account.", + "httpMethod": "GET", + "id": "content.accounts.returncarrier.list", + "parameterOrder": [ + "accountId" + ], + "parameters": { + "accountId": { + "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/returncarrier", + "response": { + "$ref": "ListAccountReturnCarrierResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Updates a return carrier in the merchant account.", + "httpMethod": "PATCH", + "id": "content.accounts.returncarrier.patch", + "parameterOrder": [ + "accountId", + "carrierAccountId" + ], + "parameters": { + "accountId": { + "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "carrierAccountId": { + "description": "Required. The Google-provided unique carrier ID, used to update the resource.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/accounts/{accountId}/returncarrier/{carrierAccountId}", + "request": { + "$ref": "AccountReturnCarrier" + }, + "response": { + "$ref": "AccountReturnCarrier" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } } }, "accountstatuses": { @@ -455,7 +741,9 @@ "description": "Retrieves multiple Merchant Center account statuses in a single request.", "httpMethod": "POST", "id": "content.accountstatuses.custombatch", - "path": "accountstatuses/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/accountstatuses/batch", "request": { "$ref": "AccountstatusesCustomBatchRequest" }, @@ -496,7 +784,7 @@ "type": "string" } }, - "path": "{merchantId}/accountstatuses/{accountId}", + "path": "content/v2.1/{merchantId}/accountstatuses/{accountId}", "response": { "$ref": "AccountStatus" }, @@ -537,7 +825,7 @@ "type": "string" } }, - "path": "{merchantId}/accountstatuses", + "path": "content/v2.1/{merchantId}/accountstatuses", "response": { "$ref": "AccountstatusesListResponse" }, @@ -553,7 +841,9 @@ "description": "Retrieves and updates tax settings of multiple accounts in a single request.", "httpMethod": "POST", "id": "content.accounttax.custombatch", - "path": "accounttax/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/accounttax/batch", "request": { "$ref": "AccounttaxCustomBatchRequest" }, @@ -588,7 +878,7 @@ "type": "string" } }, - "path": "{merchantId}/accounttax/{accountId}", + "path": "content/v2.1/{merchantId}/accounttax/{accountId}", "response": { "$ref": "AccountTax" }, @@ -623,7 +913,7 @@ "type": "string" } }, - "path": "{merchantId}/accounttax", + "path": "content/v2.1/{merchantId}/accounttax", "response": { "$ref": "AccounttaxListResponse" }, @@ -655,7 +945,7 @@ "type": "string" } }, - "path": "{merchantId}/accounttax/{accountId}", + "path": "content/v2.1/{merchantId}/accounttax/{accountId}", "request": { "$ref": "AccountTax" }, @@ -668,13 +958,316 @@ } } }, + "collections": { + "methods": { + "create": { + "description": "Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.", + "httpMethod": "POST", + "id": "content.collections.create", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "merchantId": { + "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/collections", + "request": { + "$ref": "Collection" + }, + "response": { + "$ref": "Collection" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "delete": { + "description": "Deletes a collection from your Merchant Center account.", + "httpMethod": "DELETE", + "id": "content.collections.delete", + "parameterOrder": [ + "merchantId", + "collectionId" + ], + "parameters": { + "collectionId": { + "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.", + "location": "path", + "required": true, + "type": "string" + }, + "merchantId": { + "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/collections/{collectionId}", + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "get": { + "description": "Retrieves a collection from your Merchant Center account.", + "httpMethod": "GET", + "id": "content.collections.get", + "parameterOrder": [ + "merchantId", + "collectionId" + ], + "parameters": { + "collectionId": { + "description": "Required. The REST ID of the collection.", + "location": "path", + "required": true, + "type": "string" + }, + "merchantId": { + "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/collections/{collectionId}", + "response": { + "$ref": "Collection" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.", + "httpMethod": "GET", + "id": "content.collections.list", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "merchantId": { + "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/collections", + "response": { + "$ref": "ListCollectionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "collectionstatuses": { + "methods": { + "get": { + "description": "Gets the status of a collection from your Merchant Center account.", + "httpMethod": "GET", + "id": "content.collectionstatuses.get", + "parameterOrder": [ + "merchantId", + "collectionId" + ], + "parameters": { + "collectionId": { + "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.", + "location": "path", + "required": true, + "type": "string" + }, + "merchantId": { + "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/collectionstatuses/{collectionId}", + "response": { + "$ref": "CollectionStatus" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the statuses of the collections in your Merchant Center account.", + "httpMethod": "GET", + "id": "content.collectionstatuses.list", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "merchantId": { + "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/collectionstatuses", + "response": { + "$ref": "ListCollectionStatusesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "csses": { + "methods": { + "get": { + "description": "Retrieves a single CSS domain by ID.", + "httpMethod": "GET", + "id": "content.csses.get", + "parameterOrder": [ + "cssGroupId", + "cssDomainId" + ], + "parameters": { + "cssDomainId": { + "description": "Required. The ID of the CSS domain to return.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "cssGroupId": { + "description": "Required. The ID of the managing account. If this parameter is not the same as [cssDomainId](#cssDomainId), then this ID must be a CSS group ID and `cssDomainId` must be the ID of a CSS domain affiliated with this group.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{cssGroupId}/csses/{cssDomainId}", + "response": { + "$ref": "Css" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists CSS domains affiliated with a CSS group.", + "httpMethod": "GET", + "id": "content.csses.list", + "parameterOrder": [ + "cssGroupId" + ], + "parameters": { + "cssGroupId": { + "description": "Required. The CSS group ID of CSS domains to be listed.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of CSS domains to return. The service may return fewer than this value. If unspecified, at most 50 CSS domains will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListCsses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCsses` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{cssGroupId}/csses", + "response": { + "$ref": "ListCssesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updatelabels": { + "description": "Updates labels that are assigned to a CSS domain by its CSS group.", + "httpMethod": "POST", + "id": "content.csses.updatelabels", + "parameterOrder": [ + "cssGroupId", + "cssDomainId" + ], + "parameters": { + "cssDomainId": { + "description": "Required. The ID of the updated CSS domain.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "cssGroupId": { + "description": "Required. The CSS group ID of the updated CSS domain.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{cssGroupId}/csses/{cssDomainId}/updatelabels", + "request": { + "$ref": "LabelIds" + }, + "response": { + "$ref": "Css" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, "datafeeds": { "methods": { "custombatch": { "description": "Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.", "httpMethod": "POST", "id": "content.datafeeds.custombatch", - "path": "datafeeds/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/datafeeds/batch", "request": { "$ref": "DatafeedsCustomBatchRequest" }, @@ -709,13 +1302,13 @@ "type": "string" } }, - "path": "{merchantId}/datafeeds/{datafeedId}", + "path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}", "scopes": [ "https://www.googleapis.com/auth/content" ] }, "fetchnow": { - "description": "Invokes a fetch for the datafeed in your Merchant Center account.", + "description": "Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the Products service to update your product data.", "httpMethod": "POST", "id": "content.datafeeds.fetchnow", "parameterOrder": [ @@ -738,7 +1331,7 @@ "type": "string" } }, - "path": "{merchantId}/datafeeds/{datafeedId}/fetchNow", + "path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}/fetchNow", "response": { "$ref": "DatafeedsFetchNowResponse" }, @@ -770,7 +1363,7 @@ "type": "string" } }, - "path": "{merchantId}/datafeeds/{datafeedId}", + "path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}", "response": { "$ref": "Datafeed" }, @@ -794,7 +1387,7 @@ "type": "string" } }, - "path": "{merchantId}/datafeeds", + "path": "content/v2.1/{merchantId}/datafeeds", "request": { "$ref": "Datafeed" }, @@ -832,7 +1425,7 @@ "type": "string" } }, - "path": "{merchantId}/datafeeds", + "path": "content/v2.1/{merchantId}/datafeeds", "response": { "$ref": "DatafeedsListResponse" }, @@ -864,7 +1457,7 @@ "type": "string" } }, - "path": "{merchantId}/datafeeds/{datafeedId}", + "path": "content/v2.1/{merchantId}/datafeeds/{datafeedId}", "request": { "$ref": "Datafeed" }, @@ -883,7 +1476,9 @@ "description": "Gets multiple Merchant Center datafeed statuses in a single request.", "httpMethod": "POST", "id": "content.datafeedstatuses.custombatch", - "path": "datafeedstatuses/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/datafeedstatuses/batch", "request": { "$ref": "DatafeedstatusesCustomBatchRequest" }, @@ -928,7 +1523,7 @@ "type": "string" } }, - "path": "{merchantId}/datafeedstatuses/{datafeedId}", + "path": "content/v2.1/{merchantId}/datafeedstatuses/{datafeedId}", "response": { "$ref": "DatafeedStatus" }, @@ -963,7 +1558,7 @@ "type": "string" } }, - "path": "{merchantId}/datafeedstatuses", + "path": "content/v2.1/{merchantId}/datafeedstatuses", "response": { "$ref": "DatafeedstatusesListResponse" }, @@ -979,7 +1574,9 @@ "description": "Retrieves and/or updates the LIA settings of multiple accounts in a single request.", "httpMethod": "POST", "id": "content.liasettings.custombatch", - "path": "liasettings/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/liasettings/batch", "request": { "$ref": "LiasettingsCustomBatchRequest" }, @@ -1014,7 +1611,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings/{accountId}", + "path": "content/v2.1/{merchantId}/liasettings/{accountId}", "response": { "$ref": "LiaSettings" }, @@ -1046,7 +1643,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts", + "path": "content/v2.1/{merchantId}/liasettings/{accountId}/accessiblegmbaccounts", "response": { "$ref": "LiasettingsGetAccessibleGmbAccountsResponse" }, @@ -1081,7 +1678,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings", + "path": "content/v2.1/{merchantId}/liasettings", "response": { "$ref": "LiasettingsListResponse" }, @@ -1093,7 +1690,9 @@ "description": "Retrieves the list of POS data providers that have active settings for the all eiligible countries.", "httpMethod": "GET", "id": "content.liasettings.listposdataproviders", - "path": "liasettings/posdataproviders", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/liasettings/posdataproviders", "response": { "$ref": "LiasettingsListPosDataProvidersResponse" }, @@ -1132,7 +1731,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings/{accountId}/requestgmbaccess", + "path": "content/v2.1/{merchantId}/liasettings/{accountId}/requestgmbaccess", "response": { "$ref": "LiasettingsRequestGmbAccessResponse" }, @@ -1171,7 +1770,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}", + "path": "content/v2.1/{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}", "response": { "$ref": "LiasettingsRequestInventoryVerificationResponse" }, @@ -1186,10 +1785,10 @@ "parameterOrder": [ "merchantId", "accountId", - "contactEmail", - "contactName", "country", - "language" + "language", + "contactName", + "contactEmail" ], "parameters": { "accountId": { @@ -1231,7 +1830,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact", + "path": "content/v2.1/{merchantId}/liasettings/{accountId}/setinventoryverificationcontact", "response": { "$ref": "LiasettingsSetInventoryVerificationContactResponse" }, @@ -1281,7 +1880,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings/{accountId}/setposdataprovider", + "path": "content/v2.1/{merchantId}/liasettings/{accountId}/setposdataprovider", "response": { "$ref": "LiasettingsSetPosDataProviderResponse" }, @@ -1313,7 +1912,7 @@ "type": "string" } }, - "path": "{merchantId}/liasettings/{accountId}", + "path": "content/v2.1/{merchantId}/liasettings/{accountId}", "request": { "$ref": "LiaSettings" }, @@ -1332,7 +1931,9 @@ "description": "Updates local inventory for multiple products or stores in a single request.", "httpMethod": "POST", "id": "content.localinventory.custombatch", - "path": "localinventory/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/localinventory/batch", "request": { "$ref": "LocalinventoryCustomBatchRequest" }, @@ -1366,7 +1967,7 @@ "type": "string" } }, - "path": "{merchantId}/products/{productId}/localinventory", + "path": "content/v2.1/{merchantId}/products/{productId}/localinventory", "request": { "$ref": "LocalInventory" }, @@ -1404,7 +2005,7 @@ "type": "string" } }, - "path": "{merchantId}/orderinvoices/{orderId}/createChargeInvoice", + "path": "content/v2.1/{merchantId}/orderinvoices/{orderId}/createChargeInvoice", "request": { "$ref": "OrderinvoicesCreateChargeInvoiceRequest" }, @@ -1438,7 +2039,7 @@ "type": "string" } }, - "path": "{merchantId}/orderinvoices/{orderId}/createRefundInvoice", + "path": "content/v2.1/{merchantId}/orderinvoices/{orderId}/createRefundInvoice", "request": { "$ref": "OrderinvoicesCreateRefundInvoiceRequest" }, @@ -1458,8 +2059,7 @@ "httpMethod": "GET", "id": "content.orderreports.listdisbursements", "parameterOrder": [ - "merchantId", - "disbursementStartDate" + "merchantId" ], "parameters": { "disbursementEndDate": { @@ -1470,7 +2070,6 @@ "disbursementStartDate": { "description": "The first date which disbursements occurred. In ISO 8601 format.", "location": "query", - "required": true, "type": "string" }, "maxResults": { @@ -1492,7 +2091,7 @@ "type": "string" } }, - "path": "{merchantId}/orderreports/disbursements", + "path": "content/v2.1/{merchantId}/orderreports/disbursements", "response": { "$ref": "OrderreportsListDisbursementsResponse" }, @@ -1506,8 +2105,7 @@ "id": "content.orderreports.listtransactions", "parameterOrder": [ "merchantId", - "disbursementId", - "transactionStartDate" + "disbursementId" ], "parameters": { "disbursementId": { @@ -1542,11 +2140,10 @@ "transactionStartDate": { "description": "The first date in which transaction occurred. In ISO 8601 format.", "location": "query", - "required": true, "type": "string" } }, - "path": "{merchantId}/orderreports/disbursements/{disbursementId}/transactions", + "path": "content/v2.1/{merchantId}/orderreports/disbursements/{disbursementId}/transactions", "response": { "$ref": "OrderreportsListTransactionsResponse" }, @@ -1581,7 +2178,7 @@ "type": "string" } }, - "path": "{merchantId}/orderreturns/{returnId}/acknowledge", + "path": "content/v2.1/{merchantId}/orderreturns/{returnId}/acknowledge", "request": { "$ref": "OrderreturnsAcknowledgeRequest" }, @@ -1608,7 +2205,7 @@ "type": "string" } }, - "path": "{merchantId}/orderreturns/createOrderReturn", + "path": "content/v2.1/{merchantId}/orderreturns/createOrderReturn", "request": { "$ref": "OrderreturnsCreateOrderReturnRequest" }, @@ -1642,7 +2239,7 @@ "type": "string" } }, - "path": "{merchantId}/orderreturns/{returnId}", + "path": "content/v2.1/{merchantId}/orderreturns/{returnId}", "response": { "$ref": "MerchantOrderReturn" }, @@ -1659,7 +2256,7 @@ ], "parameters": { "acknowledged": { - "description": "Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status.\nWe recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned.", + "description": "Obtains order returns that match the acknowledgement status. When set to true, obtains order returns that have been acknowledged. When false, obtains order returns that have not been acknowledged. When not provided, obtains order returns regardless of their acknowledgement status. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged order returns are returned. ", "location": "query", "type": "boolean" }, @@ -1674,7 +2271,7 @@ "type": "string" }, "googleOrderIds": { - "description": "Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set.\nNote: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.", + "description": "Obtains order returns with the specified order ids. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.", "location": "query", "repeated": true, "type": "string" @@ -1695,8 +2292,8 @@ "orderBy": { "description": "Return the results in the specified order.", "enum": [ - "returnCreationTimeAsc", - "returnCreationTimeDesc" + "RETURN_CREATION_TIME_DESC", + "RETURN_CREATION_TIME_ASC" ], "enumDescriptions": [ "", @@ -1713,11 +2310,11 @@ "shipmentStates": { "description": "Obtains order returns that match any shipment state provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment states.", "enum": [ - "completed", - "new", - "pending", - "shipped", - "undeliverable" + "NEW", + "SHIPPED", + "COMPLETED", + "UNDELIVERABLE", + "PENDING" ], "enumDescriptions": [ "", @@ -1733,9 +2330,9 @@ "shipmentStatus": { "description": "Obtains order returns that match any shipment status provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment statuses.", "enum": [ - "inProgress", - "new", - "processed" + "NEW", + "IN_PROGRESS", + "PROCESSED" ], "enumDescriptions": [ "", @@ -1747,7 +2344,7 @@ "type": "string" }, "shipmentTrackingNumbers": { - "description": "Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set.\nNote: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.", + "description": "Obtains order returns with the specified tracking numbers. If this parameter is provided, createdStartDate, createdEndDate, shipmentType, shipmentStatus, shipmentState and acknowledged parameters must be not set. Note: if googleOrderId and shipmentTrackingNumber parameters are provided, the obtained results will include all order returns that either match the specified order id or the specified tracking number.", "location": "query", "repeated": true, "type": "string" @@ -1755,9 +2352,9 @@ "shipmentTypes": { "description": "Obtains order returns that match any shipment type provided in this parameter. When this parameter is not provided, order returns are obtained regardless of their shipment types.", "enum": [ - "byMail", - "contactCustomerSupport", - "returnless" + "BY_MAIL", + "RETURNLESS", + "CONTACT_CUSTOMER_SUPPORT" ], "enumDescriptions": [ "", @@ -1769,7 +2366,7 @@ "type": "string" } }, - "path": "{merchantId}/orderreturns", + "path": "content/v2.1/{merchantId}/orderreturns", "response": { "$ref": "OrderreturnsListResponse" }, @@ -1800,7 +2397,7 @@ "type": "string" } }, - "path": "{merchantId}/orderreturns/{returnId}/process", + "path": "content/v2.1/{merchantId}/orderreturns/{returnId}/process", "request": { "$ref": "OrderreturnsProcessRequest" }, @@ -1838,7 +2435,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/acknowledge", + "path": "content/v2.1/{merchantId}/orders/{orderId}/acknowledge", "request": { "$ref": "OrdersAcknowledgeRequest" }, @@ -1872,7 +2469,7 @@ "type": "string" } }, - "path": "{merchantId}/testorders/{orderId}/advance", + "path": "content/v2.1/{merchantId}/testorders/{orderId}/advance", "response": { "$ref": "OrdersAdvanceTestOrderResponse" }, @@ -1903,7 +2500,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/cancel", + "path": "content/v2.1/{merchantId}/orders/{orderId}/cancel", "request": { "$ref": "OrdersCancelRequest" }, @@ -1937,7 +2534,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/cancelLineItem", + "path": "content/v2.1/{merchantId}/orders/{orderId}/cancelLineItem", "request": { "$ref": "OrdersCancelLineItemRequest" }, @@ -1971,7 +2568,7 @@ "type": "string" } }, - "path": "{merchantId}/testorders/{orderId}/cancelByCustomer", + "path": "content/v2.1/{merchantId}/testorders/{orderId}/cancelByCustomer", "request": { "$ref": "OrdersCancelTestOrderByCustomerRequest" }, @@ -1998,7 +2595,7 @@ "type": "string" } }, - "path": "{merchantId}/testorders", + "path": "content/v2.1/{merchantId}/testorders", "request": { "$ref": "OrdersCreateTestOrderRequest" }, @@ -2032,7 +2629,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/testreturn", + "path": "content/v2.1/{merchantId}/orders/{orderId}/testreturn", "request": { "$ref": "OrdersCreateTestReturnRequest" }, @@ -2066,7 +2663,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}", + "path": "content/v2.1/{merchantId}/orders/{orderId}", "response": { "$ref": "Order" }, @@ -2097,7 +2694,7 @@ "type": "string" } }, - "path": "{merchantId}/ordersbymerchantid/{merchantOrderId}", + "path": "content/v2.1/{merchantId}/ordersbymerchantid/{merchantOrderId}", "response": { "$ref": "OrdersGetByMerchantOrderIdResponse" }, @@ -2129,12 +2726,12 @@ "templateName": { "description": "The name of the template to retrieve.", "enum": [ - "template1", - "template1a", - "template1b", - "template2", - "template3", - "template4" + "TEMPLATE1", + "TEMPLATE2", + "TEMPLATE1A", + "TEMPLATE1B", + "TEMPLATE3", + "TEMPLATE4" ], "enumDescriptions": [ "", @@ -2149,7 +2746,7 @@ "type": "string" } }, - "path": "{merchantId}/testordertemplates/{templateName}", + "path": "content/v2.1/{merchantId}/testordertemplates/{templateName}", "response": { "$ref": "OrdersGetTestOrderTemplateResponse" }, @@ -2158,7 +2755,7 @@ ] }, "instorerefundlineitem": { - "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store).\nNote: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.", + "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.", "httpMethod": "POST", "id": "content.orders.instorerefundlineitem", "parameterOrder": [ @@ -2180,7 +2777,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/inStoreRefundLineItem", + "path": "content/v2.1/{merchantId}/orders/{orderId}/inStoreRefundLineItem", "request": { "$ref": "OrdersInStoreRefundLineItemRequest" }, @@ -2200,7 +2797,7 @@ ], "parameters": { "acknowledged": { - "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged.\nWe recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned.", + "description": "Obtains orders that match the acknowledgement status. When set to true, obtains orders that have been acknowledged. When false, obtains orders that have not been acknowledged. We recommend using this filter set to `false`, in conjunction with the `acknowledge` call, such that only un-acknowledged orders are returned. ", "location": "query", "type": "boolean" }, @@ -2218,7 +2815,7 @@ "type": "string" }, "orderBy": { - "description": "Order results by placement date in descending or ascending order.\n\nAcceptable values are:\n- placedDateAsc\n- placedDateDesc", + "description": "Order results by placement date in descending or ascending order. Acceptable values are: - placedDateAsc - placedDateDesc ", "location": "query", "type": "string" }, @@ -2240,17 +2837,17 @@ "statuses": { "description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.", "enum": [ - "active", - "canceled", - "completed", - "delivered", - "inProgress", - "partiallyDelivered", - "partiallyReturned", - "partiallyShipped", - "pendingShipment", - "returned", - "shipped" + "ACTIVE", + "COMPLETED", + "CANCELED", + "IN_PROGRESS", + "PENDING_SHIPMENT", + "PARTIALLY_SHIPPED", + "SHIPPED", + "PARTIALLY_DELIVERED", + "DELIVERED", + "PARTIALLY_RETURNED", + "RETURNED" ], "enumDescriptions": [ "", @@ -2270,7 +2867,7 @@ "type": "string" } }, - "path": "{merchantId}/orders", + "path": "content/v2.1/{merchantId}/orders", "response": { "$ref": "OrdersListResponse" }, @@ -2301,7 +2898,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/refunditem", + "path": "content/v2.1/{merchantId}/orders/{orderId}/refunditem", "request": { "$ref": "OrdersRefundItemRequest" }, @@ -2335,7 +2932,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/refundorder", + "path": "content/v2.1/{merchantId}/orders/{orderId}/refundorder", "request": { "$ref": "OrdersRefundOrderRequest" }, @@ -2369,7 +2966,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/rejectReturnLineItem", + "path": "content/v2.1/{merchantId}/orders/{orderId}/rejectReturnLineItem", "request": { "$ref": "OrdersRejectReturnLineItemRequest" }, @@ -2403,7 +3000,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/returnRefundLineItem", + "path": "content/v2.1/{merchantId}/orders/{orderId}/returnRefundLineItem", "request": { "$ref": "OrdersReturnRefundLineItemRequest" }, @@ -2437,7 +3034,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/setLineItemMetadata", + "path": "content/v2.1/{merchantId}/orders/{orderId}/setLineItemMetadata", "request": { "$ref": "OrdersSetLineItemMetadataRequest" }, @@ -2471,7 +3068,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/shipLineItems", + "path": "content/v2.1/{merchantId}/orders/{orderId}/shipLineItems", "request": { "$ref": "OrdersShipLineItemsRequest" }, @@ -2505,7 +3102,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/updateLineItemShippingDetails", + "path": "content/v2.1/{merchantId}/orders/{orderId}/updateLineItemShippingDetails", "request": { "$ref": "OrdersUpdateLineItemShippingDetailsRequest" }, @@ -2539,7 +3136,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/updateMerchantOrderId", + "path": "content/v2.1/{merchantId}/orders/{orderId}/updateMerchantOrderId", "request": { "$ref": "OrdersUpdateMerchantOrderIdRequest" }, @@ -2573,7 +3170,7 @@ "type": "string" } }, - "path": "{merchantId}/orders/{orderId}/updateShipment", + "path": "content/v2.1/{merchantId}/orders/{orderId}/updateShipment", "request": { "$ref": "OrdersUpdateShipmentRequest" }, @@ -2586,13 +3183,46 @@ } } }, + "ordertrackingsignals": { + "methods": { + "create": { + "description": "Creates new order tracking signal.", + "httpMethod": "POST", + "id": "content.ordertrackingsignals.create", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "merchantId": { + "description": "The ID of the merchant for which the order signal is created.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/ordertrackingsignals", + "request": { + "$ref": "OrderTrackingSignal" + }, + "response": { + "$ref": "OrderTrackingSignal" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, "pos": { "methods": { "custombatch": { "description": "Batches multiple POS-related calls in a single request.", "httpMethod": "POST", "id": "content.pos.custombatch", - "path": "pos/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/pos/batch", "request": { "$ref": "PosCustomBatchRequest" }, @@ -2634,7 +3264,7 @@ "type": "string" } }, - "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}", + "path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store/{storeCode}", "scopes": [ "https://www.googleapis.com/auth/content" ] @@ -2670,7 +3300,7 @@ "type": "string" } }, - "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}", + "path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store/{storeCode}", "response": { "$ref": "PosStore" }, @@ -2702,7 +3332,7 @@ "type": "string" } }, - "path": "{merchantId}/pos/{targetMerchantId}/store", + "path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store", "request": { "$ref": "PosStore" }, @@ -2737,7 +3367,7 @@ "type": "string" } }, - "path": "{merchantId}/pos/{targetMerchantId}/inventory", + "path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/inventory", "request": { "$ref": "PosInventoryRequest" }, @@ -2772,7 +3402,7 @@ "type": "string" } }, - "path": "{merchantId}/pos/{targetMerchantId}/store", + "path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/store", "response": { "$ref": "PosListResponse" }, @@ -2804,7 +3434,7 @@ "type": "string" } }, - "path": "{merchantId}/pos/{targetMerchantId}/sale", + "path": "content/v2.1/{merchantId}/pos/{targetMerchantId}/sale", "request": { "$ref": "PosSaleRequest" }, @@ -2823,7 +3453,9 @@ "description": "Retrieves, inserts, and deletes multiple products in a single request.", "httpMethod": "POST", "id": "content.products.custombatch", - "path": "products/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/products/batch", "request": { "$ref": "ProductsCustomBatchRequest" }, @@ -2863,7 +3495,7 @@ "type": "string" } }, - "path": "{merchantId}/products/{productId}", + "path": "content/v2.1/{merchantId}/products/{productId}", "scopes": [ "https://www.googleapis.com/auth/content" ] @@ -2891,7 +3523,7 @@ "type": "string" } }, - "path": "{merchantId}/products/{productId}", + "path": "content/v2.1/{merchantId}/products/{productId}", "response": { "$ref": "Product" }, @@ -2921,7 +3553,7 @@ "type": "string" } }, - "path": "{merchantId}/products", + "path": "content/v2.1/{merchantId}/products", "request": { "$ref": "Product" }, @@ -2959,7 +3591,7 @@ "type": "string" } }, - "path": "{merchantId}/products", + "path": "content/v2.1/{merchantId}/products", "response": { "$ref": "ProductsListResponse" }, @@ -2975,7 +3607,9 @@ "description": "Gets the statuses of multiple products in a single request.", "httpMethod": "POST", "id": "content.productstatuses.custombatch", - "path": "productstatuses/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/productstatuses/batch", "request": { "$ref": "ProductstatusesCustomBatchRequest" }, @@ -3015,7 +3649,7 @@ "type": "string" } }, - "path": "{merchantId}/productstatuses/{productId}", + "path": "content/v2.1/{merchantId}/productstatuses/{productId}", "response": { "$ref": "ProductStatus" }, @@ -3056,7 +3690,7 @@ "type": "string" } }, - "path": "{merchantId}/productstatuses", + "path": "content/v2.1/{merchantId}/productstatuses", "response": { "$ref": "ProductstatusesListResponse" }, @@ -3064,6 +3698,69 @@ "https://www.googleapis.com/auth/content" ] } + }, + "resources": { + "repricingreports": { + "methods": { + "list": { + "description": "Lists the metrics report for a given Repricing product.", + "httpMethod": "GET", + "id": "content.productstatuses.repricingreports.list", + "parameterOrder": [ + "merchantId", + "productId" + ], + "parameters": { + "endDate": { + "description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format is YYYY-MM-DD.", + "location": "query", + "type": "string" + }, + "merchantId": { + "description": "Required. Id of the merchant who owns the Repricing rule.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of days of reports to return. There can be more than one rule report returned per day. For example, if 3 rule types got applied to the same product within a 24-hour period, then a page_size of 1 will return 3 rule reports. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days of reports than this value, for example, if the time between your start and end date is less than the page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", + "location": "query", + "type": "string" + }, + "productId": { + "description": "Required. Id of the Repricing product. Also known as the [REST_ID](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.id)", + "location": "path", + "required": true, + "type": "string" + }, + "ruleId": { + "description": "Id of the Repricing rule. If specified, only gets this rule's reports.", + "location": "query", + "type": "string" + }, + "startDate": { + "description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format is YYYY-MM-DD.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/productstatuses/{productId}/repricingreports", + "response": { + "$ref": "ListRepricingProductReportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } } }, "pubsubnotificationsettings": { @@ -3084,7 +3781,7 @@ "type": "string" } }, - "path": "{merchantId}/pubsubnotificationsettings", + "path": "content/v2.1/{merchantId}/pubsubnotificationsettings", "response": { "$ref": "PubsubNotificationSettings" }, @@ -3108,7 +3805,7 @@ "type": "string" } }, - "path": "{merchantId}/pubsubnotificationsettings", + "path": "content/v2.1/{merchantId}/pubsubnotificationsettings", "request": { "$ref": "PubsubNotificationSettings" }, @@ -3127,7 +3824,9 @@ "description": "Updates regional inventory for multiple products or regions in a single request.", "httpMethod": "POST", "id": "content.regionalinventory.custombatch", - "path": "regionalinventory/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/regionalinventory/batch", "request": { "$ref": "RegionalinventoryCustomBatchRequest" }, @@ -3161,7 +3860,7 @@ "type": "string" } }, - "path": "{merchantId}/products/{productId}/regionalinventory", + "path": "content/v2.1/{merchantId}/products/{productId}/regionalinventory", "request": { "$ref": "RegionalInventory" }, @@ -3174,13 +3873,417 @@ } } }, + "regions": { + "methods": { + "create": { + "description": "Creates a region definition in your Merchant Center account.", + "httpMethod": "POST", + "id": "content.regions.create", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant for which to create region definition.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "regionId": { + "description": "Required. The id of the region to create.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/regions", + "request": { + "$ref": "Region" + }, + "response": { + "$ref": "Region" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "delete": { + "description": "Deletes a region definition from your Merchant Center account.", + "httpMethod": "DELETE", + "id": "content.regions.delete", + "parameterOrder": [ + "merchantId", + "regionId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant for which to delete region definition.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "regionId": { + "description": "Required. The id of the region to delete.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/regions/{regionId}", + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "get": { + "description": "Retrieves a region defined in your Merchant Center account.", + "httpMethod": "GET", + "id": "content.regions.get", + "parameterOrder": [ + "merchantId", + "regionId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant for which to retrieve region definition.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "regionId": { + "description": "Required. The id of the region to retrieve.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/regions/{regionId}", + "response": { + "$ref": "Region" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the regions in your Merchant Center account.", + "httpMethod": "GET", + "id": "content.regions.list", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant for which to list region definitions.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/regions", + "response": { + "$ref": "ListRegionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Updates a region definition in your Merchant Center account.", + "httpMethod": "PATCH", + "id": "content.regions.patch", + "parameterOrder": [ + "merchantId", + "regionId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant for which to update region definition.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "regionId": { + "description": "Required. The id of the region to update.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The field mask indicating the fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/regions/{regionId}", + "request": { + "$ref": "Region" + }, + "response": { + "$ref": "Region" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "repricingrules": { + "methods": { + "create": { + "description": "Creates a repricing rule for your Merchant Center account.", + "httpMethod": "POST", + "id": "content.repricingrules.create", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant who owns the repricing rule.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "ruleId": { + "description": "Required. The id of the rule to create.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/repricingrules", + "request": { + "$ref": "RepricingRule" + }, + "response": { + "$ref": "RepricingRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "delete": { + "description": "Deletes a repricing rule in your Merchant Center account.", + "httpMethod": "DELETE", + "id": "content.repricingrules.delete", + "parameterOrder": [ + "merchantId", + "ruleId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant who owns the repricing rule.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "ruleId": { + "description": "Required. The id of the rule to Delete.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/repricingrules/{ruleId}", + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "get": { + "description": "Retrieves a repricing rule from your Merchant Center account.", + "httpMethod": "GET", + "id": "content.repricingrules.get", + "parameterOrder": [ + "merchantId", + "ruleId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant who owns the repricing rule.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "ruleId": { + "description": "Required. The id of the rule to retrieve.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/repricingrules/{ruleId}", + "response": { + "$ref": "RepricingRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the repricing rules in your Merchant Center account.", + "httpMethod": "GET", + "id": "content.repricingrules.list", + "parameterOrder": [ + "merchantId" + ], + "parameters": { + "countryCode": { + "description": "CLDR country code (e.g. \"US\"), used as a filter on repricing rules.", + "location": "query", + "type": "string" + }, + "languageCode": { + "description": "The two-letter ISO 639-1 language code associated with the repricing rule, used as a filter.", + "location": "query", + "type": "string" + }, + "merchantId": { + "description": "Required. The id of the merchant who owns the repricing rule.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of repricing rules to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListRepricingRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepricingRules` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/repricingrules", + "response": { + "$ref": "ListRepricingRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.", + "httpMethod": "PATCH", + "id": "content.repricingrules.patch", + "parameterOrder": [ + "merchantId", + "ruleId" + ], + "parameters": { + "merchantId": { + "description": "Required. The id of the merchant who owns the repricing rule.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "ruleId": { + "description": "Required. The id of the rule to update.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/repricingrules/{ruleId}", + "request": { + "$ref": "RepricingRule" + }, + "response": { + "$ref": "RepricingRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + }, + "resources": { + "repricingreports": { + "methods": { + "list": { + "description": "Lists the metrics report for a given Repricing rule.", + "httpMethod": "GET", + "id": "content.repricingrules.repricingreports.list", + "parameterOrder": [ + "merchantId", + "ruleId" + ], + "parameters": { + "endDate": { + "description": "Gets Repricing reports on and before this date in the merchant's timezone. You can only retrieve data up to 7 days ago (default) or earlier. Format: YYYY-MM-DD.", + "location": "query", + "type": "string" + }, + "merchantId": { + "description": "Required. Id of the merchant who owns the Repricing rule.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of daily reports to return. Each report includes data from a single 24-hour period. The page size defaults to 50 and values above 1000 are coerced to 1000. This service may return fewer days than this value, for example, if the time between your start and end date is less than page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.", + "location": "query", + "type": "string" + }, + "ruleId": { + "description": "Required. Id of the Repricing rule.", + "location": "path", + "required": true, + "type": "string" + }, + "startDate": { + "description": "Gets Repricing reports on and after this date in the merchant's timezone, up to one year ago. Do not use a start date later than 7 days ago (default). Format: YYYY-MM-DD.", + "location": "query", + "type": "string" + } + }, + "path": "content/v2.1/{merchantId}/repricingrules/{ruleId}/repricingreports", + "response": { + "$ref": "ListRepricingRuleReportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } + } + }, "returnaddress": { "methods": { "custombatch": { "description": "Batches multiple return address related calls in a single request.", "httpMethod": "POST", "id": "content.returnaddress.custombatch", - "path": "returnaddress/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/returnaddress/batch", "request": { "$ref": "ReturnaddressCustomBatchRequest" }, @@ -3214,7 +4317,7 @@ "type": "string" } }, - "path": "{merchantId}/returnaddress/{returnAddressId}", + "path": "content/v2.1/{merchantId}/returnaddress/{returnAddressId}", "scopes": [ "https://www.googleapis.com/auth/content" ] @@ -3242,7 +4345,7 @@ "type": "string" } }, - "path": "{merchantId}/returnaddress/{returnAddressId}", + "path": "content/v2.1/{merchantId}/returnaddress/{returnAddressId}", "response": { "$ref": "ReturnAddress" }, @@ -3266,7 +4369,7 @@ "type": "string" } }, - "path": "{merchantId}/returnaddress", + "path": "content/v2.1/{merchantId}/returnaddress", "request": { "$ref": "ReturnAddress" }, @@ -3309,7 +4412,7 @@ "type": "string" } }, - "path": "{merchantId}/returnaddress", + "path": "content/v2.1/{merchantId}/returnaddress", "response": { "$ref": "ReturnaddressListResponse" }, @@ -3325,7 +4428,9 @@ "description": "Batches multiple return policy related calls in a single request.", "httpMethod": "POST", "id": "content.returnpolicy.custombatch", - "path": "returnpolicy/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/returnpolicy/batch", "request": { "$ref": "ReturnpolicyCustomBatchRequest" }, @@ -3359,7 +4464,7 @@ "type": "string" } }, - "path": "{merchantId}/returnpolicy/{returnPolicyId}", + "path": "content/v2.1/{merchantId}/returnpolicy/{returnPolicyId}", "scopes": [ "https://www.googleapis.com/auth/content" ] @@ -3387,7 +4492,7 @@ "type": "string" } }, - "path": "{merchantId}/returnpolicy/{returnPolicyId}", + "path": "content/v2.1/{merchantId}/returnpolicy/{returnPolicyId}", "response": { "$ref": "ReturnPolicy" }, @@ -3411,7 +4516,7 @@ "type": "string" } }, - "path": "{merchantId}/returnpolicy", + "path": "content/v2.1/{merchantId}/returnpolicy", "request": { "$ref": "ReturnPolicy" }, @@ -3438,7 +4543,7 @@ "type": "string" } }, - "path": "{merchantId}/returnpolicy", + "path": "content/v2.1/{merchantId}/returnpolicy", "response": { "$ref": "ReturnpolicyListResponse" }, @@ -3473,7 +4578,7 @@ "type": "string" } }, - "path": "{merchantId}/settlementreports/{settlementId}", + "path": "content/v2.1/{merchantId}/settlementreports/{settlementId}", "response": { "$ref": "SettlementReport" }, @@ -3518,7 +4623,7 @@ "type": "string" } }, - "path": "{merchantId}/settlementreports", + "path": "content/v2.1/{merchantId}/settlementreports", "response": { "$ref": "SettlementreportsListResponse" }, @@ -3570,7 +4675,7 @@ "type": "string" } }, - "path": "{merchantId}/settlementreports/{settlementId}/transactions", + "path": "content/v2.1/{merchantId}/settlementreports/{settlementId}/transactions", "response": { "$ref": "SettlementtransactionsListResponse" }, @@ -3586,7 +4691,9 @@ "description": "Retrieves and updates the shipping settings of multiple accounts in a single request.", "httpMethod": "POST", "id": "content.shippingsettings.custombatch", - "path": "shippingsettings/batch", + "parameterOrder": [], + "parameters": {}, + "path": "content/v2.1/shippingsettings/batch", "request": { "$ref": "ShippingsettingsCustomBatchRequest" }, @@ -3621,7 +4728,7 @@ "type": "string" } }, - "path": "{merchantId}/shippingsettings/{accountId}", + "path": "content/v2.1/{merchantId}/shippingsettings/{accountId}", "response": { "$ref": "ShippingSettings" }, @@ -3645,7 +4752,7 @@ "type": "string" } }, - "path": "{merchantId}/supportedCarriers", + "path": "content/v2.1/{merchantId}/supportedCarriers", "response": { "$ref": "ShippingsettingsGetSupportedCarriersResponse" }, @@ -3669,7 +4776,7 @@ "type": "string" } }, - "path": "{merchantId}/supportedHolidays", + "path": "content/v2.1/{merchantId}/supportedHolidays", "response": { "$ref": "ShippingsettingsGetSupportedHolidaysResponse" }, @@ -3693,7 +4800,7 @@ "type": "string" } }, - "path": "{merchantId}/supportedPickupServices", + "path": "content/v2.1/{merchantId}/supportedPickupServices", "response": { "$ref": "ShippingsettingsGetSupportedPickupServicesResponse" }, @@ -3728,7 +4835,7 @@ "type": "string" } }, - "path": "{merchantId}/shippingsettings", + "path": "content/v2.1/{merchantId}/shippingsettings", "response": { "$ref": "ShippingsettingsListResponse" }, @@ -3760,7 +4867,7 @@ "type": "string" } }, - "path": "{merchantId}/shippingsettings/{accountId}", + "path": "content/v2.1/{merchantId}/shippingsettings/{accountId}", "request": { "$ref": "ShippingSettings" }, @@ -3774,15 +4881,15 @@ } } }, - "revision": "20201008", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210128", + "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { "description": "Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.", "id": "Account", "properties": { "adsLinks": { - "description": "List of linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.", + "description": "Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.", "items": { "$ref": "AccountAdsLink" }, @@ -3792,6 +4899,14 @@ "description": "Indicates whether the merchant sells adult content.", "type": "boolean" }, + "automaticLabelIds": { + "description": "Automatically created label IDs that are assigned to the account by CSS Center.", + "items": { + "format": "uint64", + "type": "string" + }, + "type": "array" + }, "businessInformation": { "$ref": "AccountBusinessInformation", "description": "The business information of the account." @@ -3806,22 +4921,16 @@ "description": "The GMB account which is linked or in the process of being linked with the Merchant Center account." }, "id": { - "annotations": { - "required": [ - "content.accounts.update" - ] - }, "description": "Required for update. Merchant Center account ID.", "format": "uint64", "type": "string" }, "kind": { - "default": "content#account", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#account`\"", "type": "string" }, "labelIds": { - "description": "List of label IDs that are assigned to the account by CSS.", + "description": "Manually created label IDs that are assigned to the account by CSS.", "items": { "format": "uint64", "type": "string" @@ -3829,12 +4938,6 @@ "type": "array" }, "name": { - "annotations": { - "required": [ - "content.accounts.insert", - "content.accounts.update" - ] - }, "description": "Required. Display name for the account.", "type": "string" }, @@ -3854,7 +4957,7 @@ "type": "string" }, "youtubeChannelLinks": { - "description": "List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.", + "description": "Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.", "items": { "$ref": "AccountYouTubeChannelLink" }, @@ -3898,7 +5001,7 @@ "type": "string" }, "status": { - "description": "Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.\n\nAcceptable values are: \n- \"`active`\" \n- \"`pending`\"", + "description": "Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - \"`active`\" - \"`pending`\" ", "type": "string" } }, @@ -3952,7 +5055,7 @@ "type": "string" }, "status": { - "description": "Status of the link between this Merchant Center account and the GMB account.\n\nAcceptable values are: \n- \"`active`\" \n- \"`pending`\"", + "description": "Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - \"`active`\" - \"`pending`\" ", "type": "string" } }, @@ -3974,6 +5077,82 @@ }, "type": "object" }, + "AccountLabel": { + "description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.", + "id": "AccountLabel", + "properties": { + "accountId": { + "description": "Immutable. The ID of account this label belongs to.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "The description of this label.", + "type": "string" + }, + "labelId": { + "description": "Output only. The ID of the label.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "labelType": { + "description": "Output only. The type of this label.", + "enum": [ + "LABEL_TYPE_UNSPECIFIED", + "MANUAL", + "AUTOMATIC" + ], + "enumDescriptions": [ + "Unknown label type.", + "Indicates that the label was created manually.", + "Indicates that the label was created automatically by CSS Center." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The display name of this label.", + "type": "string" + } + }, + "type": "object" + }, + "AccountReturnCarrier": { + "description": " The return carrier information. This service is designed for merchants enrolled in the Buy on Google program. ", + "id": "AccountReturnCarrier", + "properties": { + "carrierAccountId": { + "description": "Output only. Immutable. The Google-provided unique carrier ID, used to update the resource.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "carrierAccountName": { + "description": "Name of the carrier account.", + "type": "string" + }, + "carrierAccountNumber": { + "description": "Number of the carrier account.", + "type": "string" + }, + "carrierCode": { + "description": "The carrier code enum. Accepts the values FEDEX or UPS.", + "enum": [ + "CARRIER_CODE_UNSPECIFIED", + "FEDEX", + "UPS" + ], + "enumDescriptions": [ + "Carrier not specified", + "FedEx carrier", + "UPS carrier" + ], + "type": "string" + } + }, + "type": "object" + }, "AccountStatus": { "description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.", "id": "AccountStatus", @@ -3990,7 +5169,6 @@ "type": "array" }, "kind": { - "default": "content#accountStatus", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountStatus`\"", "type": "string" }, @@ -4032,7 +5210,7 @@ "type": "string" }, "severity": { - "description": "Severity of the issue.\n\nAcceptable values are: \n- \"`critical`\" \n- \"`error`\" \n- \"`suggestion`\"", + "description": "Severity of the issue. Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" ", "type": "string" }, "title": { @@ -4085,7 +5263,7 @@ "id": "AccountStatusProducts", "properties": { "channel": { - "description": "The channel the data applies to.\n\nAcceptable values are: \n- \"`local`\" \n- \"`online`\"", + "description": "The channel the data applies to. Acceptable values are: - \"`local`\" - \"`online`\" ", "type": "string" }, "country": { @@ -4141,17 +5319,11 @@ "id": "AccountTax", "properties": { "accountId": { - "annotations": { - "required": [ - "content.accounttax.update" - ] - }, "description": "Required. The ID of the account to which these account tax settings belong.", "format": "uint64", "type": "string" }, "kind": { - "default": "content#accountTax", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountTax\".", "type": "string" }, @@ -4174,11 +5346,6 @@ "type": "string" }, "locationId": { - "annotations": { - "required": [ - "content.accounttax.update" - ] - }, "description": "Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).", "format": "uint64", "type": "string" @@ -4232,7 +5399,7 @@ "type": "string" }, "status": { - "description": "Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.", + "description": "Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.", "type": "string" } }, @@ -4242,14 +5409,13 @@ "id": "AccountsAuthInfoResponse", "properties": { "accountIdentifiers": { - "description": "The account identifiers corresponding to the authenticated user.\n- For an individual account: only the merchant ID is defined\n- For an aggregator: only the aggregator ID is defined\n- For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.", + "description": "The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. ", "items": { "$ref": "AccountIdentifier" }, "type": "array" }, "kind": { - "default": "content#accountsAuthInfoResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsAuthInfoResponse\".", "type": "string" } @@ -4260,7 +5426,6 @@ "id": "AccountsClaimWebsiteResponse", "properties": { "kind": { - "default": "content#accountsClaimWebsiteResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsClaimWebsiteResponse\".", "type": "string" } @@ -4320,7 +5485,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`claimWebsite`\" \n- \"`delete`\" \n- \"`get`\" \n- \"`insert`\" \n- \"`link`\" \n- \"`update`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`claimWebsite`\" - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`link`\" - \"`update`\" ", "type": "string" }, "overwrite": { @@ -4338,11 +5503,11 @@ "id": "AccountsCustomBatchRequestEntryLinkRequest", "properties": { "action": { - "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants.\n\nAcceptable values are: \n- \"`approve`\" \n- \"`remove`\" \n- \"`request`\"", + "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ", "type": "string" }, "linkType": { - "description": "Type of the link between the two accounts.\n\nAcceptable values are: \n- \"`channelPartner`\" \n- \"`eCommercePlatform`\"", + "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ", "type": "string" }, "linkedAccountId": { @@ -4350,7 +5515,7 @@ "type": "string" }, "services": { - "description": "List of provided services.", + "description": "Provided services. Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingAdsOther`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsOther`\" ", "items": { "type": "string" }, @@ -4370,7 +5535,6 @@ "type": "array" }, "kind": { - "default": "content#accountsCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsCustomBatchResponse\".", "type": "string" } @@ -4395,7 +5559,6 @@ "description": "A list of errors defined if and only if the request failed." }, "kind": { - "default": "content#accountsCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponseEntry`\"", "type": "string" } @@ -4406,11 +5569,11 @@ "id": "AccountsLinkRequest", "properties": { "action": { - "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants.\n\nAcceptable values are: \n- \"`approve`\" \n- \"`remove`\" \n- \"`request`\"", + "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ", "type": "string" }, "linkType": { - "description": "Type of the link between the two accounts.\n\nAcceptable values are: \n- \"`channelPartner`\" \n- \"`eCommercePlatform`\"", + "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" ", "type": "string" }, "linkedAccountId": { @@ -4418,7 +5581,7 @@ "type": "string" }, "services": { - "description": "List of provided services.", + "description": " Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingAdsOther`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsOther`\" ", "items": { "type": "string" }, @@ -4431,7 +5594,6 @@ "id": "AccountsLinkResponse", "properties": { "kind": { - "default": "content#accountsLinkResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsLinkResponse\".", "type": "string" } @@ -4442,7 +5604,6 @@ "id": "AccountsListLinksResponse", "properties": { "kind": { - "default": "content#accountsListLinksResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListLinksResponse\".", "type": "string" }, @@ -4464,7 +5625,6 @@ "id": "AccountsListResponse", "properties": { "kind": { - "default": "content#accountsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsListResponse\".", "type": "string" }, @@ -4499,7 +5659,6 @@ "id": "AccountsUpdateLabelsResponse", "properties": { "kind": { - "default": "content#accountsUpdateLabelsResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountsUpdateLabelsResponse\".", "type": "string" } @@ -4546,7 +5705,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`get`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ", "type": "string" } }, @@ -4563,7 +5722,6 @@ "type": "array" }, "kind": { - "default": "content#accountstatusesCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesCustomBatchResponse\".", "type": "string" } @@ -4594,7 +5752,6 @@ "id": "AccountstatusesListResponse", "properties": { "kind": { - "default": "content#accountstatusesListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accountstatusesListResponse\".", "type": "string" }, @@ -4648,7 +5805,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`get`\" \n- \"`update`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ", "type": "string" } }, @@ -4665,7 +5822,6 @@ "type": "array" }, "kind": { - "default": "content#accounttaxCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxCustomBatchResponse\".", "type": "string" } @@ -4690,7 +5846,6 @@ "description": "A list of errors defined if and only if the request failed." }, "kind": { - "default": "content#accounttaxCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponseEntry`\"", "type": "string" } @@ -4701,7 +5856,6 @@ "id": "AccounttaxListResponse", "properties": { "kind": { - "default": "content#accounttaxListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#accounttaxListResponse\".", "type": "string" }, @@ -4796,6 +5950,224 @@ }, "type": "object" }, + "Collection": { + "description": "The collection message.", + "id": "Collection", + "properties": { + "customLabel0": { + "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. Custom label", + "type": "string" + }, + "customLabel1": { + "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.", + "type": "string" + }, + "customLabel2": { + "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.", + "type": "string" + }, + "customLabel3": { + "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.", + "type": "string" + }, + "customLabel4": { + "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.", + "type": "string" + }, + "featuredProduct": { + "description": "This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. featured_product attribute", + "items": { + "$ref": "CollectionFeaturedProduct" + }, + "type": "array" + }, + "headline": { + "description": "Your collection's name. headline attribute", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. id attribute", + "type": "string" + }, + "imageLink": { + "description": "The URL of a collection’s image. image_link attribute", + "items": { + "type": "string" + }, + "type": "array" + }, + "language": { + "description": "The language of a collection and the language of any featured products linked to the collection. language attribute", + "type": "string" + }, + "link": { + "description": "A collection’s landing page. URL directly linking to your collection's page on your website. link attribute", + "type": "string" + }, + "mobileLink": { + "description": "A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. mobile_link attribute", + "type": "string" + }, + "productCountry": { + "description": "product_country attribute", + "type": "string" + } + }, + "type": "object" + }, + "CollectionFeaturedProduct": { + "description": "The message for FeaturedProduct. FeaturedProduct", + "id": "CollectionFeaturedProduct", + "properties": { + "offerId": { + "description": "The unique identifier for the product item.", + "type": "string" + }, + "x": { + "description": "Required. X-coordinate of the product callout on the Shoppable Image.", + "format": "float", + "type": "number" + }, + "y": { + "description": "Required. Y-coordinate of the product callout on the Shoppable Image.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "CollectionStatus": { + "description": "The collectionstatus message.", + "id": "CollectionStatus", + "properties": { + "collectionLevelIssuses": { + "description": "A list of all issues associated with the collection.", + "items": { + "$ref": "CollectionStatusItemLevelIssue" + }, + "type": "array" + }, + "creationDate": { + "description": "Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"", + "type": "string" + }, + "destinationStatuses": { + "description": "The intended destinations for the collection.", + "items": { + "$ref": "CollectionStatusDestinationStatus" + }, + "type": "array" + }, + "id": { + "description": "Required. The ID of the collection for which status is reported.", + "type": "string" + }, + "lastUpdateDate": { + "description": "Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, e.g. \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"", + "type": "string" + } + }, + "type": "object" + }, + "CollectionStatusDestinationStatus": { + "description": "Destination status message.", + "id": "CollectionStatusDestinationStatus", + "properties": { + "destination": { + "description": "The name of the destination", + "type": "string" + }, + "status": { + "description": "The status for the specified destination.", + "type": "string" + } + }, + "type": "object" + }, + "CollectionStatusItemLevelIssue": { + "description": "Issue associated with the collection.", + "id": "CollectionStatusItemLevelIssue", + "properties": { + "attributeName": { + "description": "The attribute's name, if the issue is caused by a single attribute.", + "type": "string" + }, + "code": { + "description": "The error code of the issue.", + "type": "string" + }, + "description": { + "description": "A short issue description in English.", + "type": "string" + }, + "destination": { + "description": "The destination the issue applies to.", + "type": "string" + }, + "detail": { + "description": "A detailed issue description in English.", + "type": "string" + }, + "documentation": { + "description": "The URL of a web page to help with resolving this issue.", + "type": "string" + }, + "resolution": { + "description": "Whether the issue can be resolved by the merchant.", + "type": "string" + }, + "servability": { + "description": "How this issue affects the serving of the collection.", + "type": "string" + } + }, + "type": "object" + }, + "Css": { + "description": "Information about CSS domain.", + "id": "Css", + "properties": { + "cssDomainId": { + "description": "Output only. Immutable. The CSS domain ID.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "cssGroupId": { + "description": "Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. Immutable. The CSS domain's display name, used when space is constrained.", + "readOnly": true, + "type": "string" + }, + "fullName": { + "description": "Output only. Immutable. The CSS domain's full name.", + "readOnly": true, + "type": "string" + }, + "homepageUri": { + "description": "Output only. Immutable. The CSS domain's homepage.", + "readOnly": true, + "type": "string" + }, + "labelIds": { + "description": "A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CustomAttribute": { "id": "CustomAttribute", "properties": { @@ -4825,7 +6197,7 @@ "type": "string" }, "reasonCode": { - "description": "Code of the return reason.\n\nAcceptable values are: \n- \"`betterPriceFound`\" \n- \"`changedMind`\" \n- \"`damagedOrDefectiveItem`\" \n- \"`didNotMatchDescription`\" \n- \"`doesNotFit`\" \n- \"`expiredItem`\" \n- \"`incorrectItemReceived`\" \n- \"`noLongerNeeded`\" \n- \"`notSpecified`\" \n- \"`orderedWrongItem`\" \n- \"`other`\" \n- \"`qualityNotExpected`\" \n- \"`receivedTooLate`\" \n- \"`undeliverable`\"", + "description": "Code of the return reason. Acceptable values are: - \"`betterPriceFound`\" - \"`changedMind`\" - \"`damagedOrDefectiveItem`\" - \"`didNotMatchDescription`\" - \"`doesNotFit`\" - \"`expiredItem`\" - \"`incorrectItemReceived`\" - \"`noLongerNeeded`\" - \"`notSpecified`\" - \"`orderedWrongItem`\" - \"`other`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`undeliverable`\" ", "type": "string" } }, @@ -4845,7 +6217,7 @@ "type": "integer" }, "timezone": { - "description": "Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.", + "description": "Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.", "type": "string" } }, @@ -4860,13 +6232,7 @@ "type": "string" }, "contentType": { - "annotations": { - "required": [ - "content.datafeeds.insert", - "content.datafeeds.update" - ] - }, - "description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.\n\nAcceptable values are: \n- \"`local products`\" \n- \"`product inventory`\" \n- \"`products`\"", + "description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - \"`local products`\" - \"`product inventory`\" - \"`products`\" ", "type": "string" }, "fetchSchedule": { @@ -4874,12 +6240,6 @@ "description": "Fetch schedule for the feed file." }, "fileName": { - "annotations": { - "required": [ - "content.datafeeds.insert", - "content.datafeeds.update" - ] - }, "description": "Required. The filename of the feed. All feeds must have a unique file name.", "type": "string" }, @@ -4888,26 +6248,15 @@ "description": "Format of the feed file." }, "id": { - "annotations": { - "required": [ - "content.datafeeds.update" - ] - }, "description": "Required for update. The ID of the data feed.", "format": "int64", "type": "string" }, "kind": { - "default": "content#datafeed", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeed`\"", "type": "string" }, "name": { - "annotations": { - "required": [ - "content.datafeeds.insert" - ] - }, "description": "Required for insert. A descriptive name of the data feed.", "type": "string" }, @@ -4961,7 +6310,7 @@ "type": "string" }, "weekday": { - "description": "The day of the week the feed file should be fetched.\n\nAcceptable values are: \n- \"`monday`\" \n- \"`tuesday`\" \n- \"`wednesday`\" \n- \"`thursday`\" \n- \"`friday`\" \n- \"`saturday`\" \n- \"`sunday`\"", + "description": "The day of the week the feed file should be fetched. Acceptable values are: - \"`monday`\" - \"`tuesday`\" - \"`wednesday`\" - \"`thursday`\" - \"`friday`\" - \"`saturday`\" - \"`sunday`\" ", "type": "string" } }, @@ -4971,15 +6320,15 @@ "id": "DatafeedFormat", "properties": { "columnDelimiter": { - "description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds.\n\nAcceptable values are: \n- \"`pipe`\" \n- \"`tab`\" \n- \"`tilde`\"", + "description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`pipe`\" - \"`tab`\" - \"`tilde`\" ", "type": "string" }, "fileEncoding": { - "description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected.\n\nAcceptable values are: \n- \"`latin-1`\" \n- \"`utf-16be`\" \n- \"`utf-16le`\" \n- \"`utf-8`\" \n- \"`windows-1252`\"", + "description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - \"`latin-1`\" - \"`utf-16be`\" - \"`utf-16le`\" - \"`utf-8`\" - \"`windows-1252`\" ", "type": "string" }, "quotingMode": { - "description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds.\n\nAcceptable values are: \n- \"`normal character`\" \n- \"`value quoting`\"", + "description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`normal character`\" - \"`value quoting`\" ", "type": "string" } }, @@ -4990,7 +6339,7 @@ "id": "DatafeedStatus", "properties": { "country": { - "description": "The country for which the status is reported, represented as a CLDR territory code.", + "description": "The country for which the status is reported, represented as a CLDR territory code.", "type": "string" }, "datafeedId": { @@ -5016,7 +6365,6 @@ "type": "string" }, "kind": { - "default": "content#datafeedStatus", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedStatus`\"", "type": "string" }, @@ -5029,7 +6377,7 @@ "type": "string" }, "processingStatus": { - "description": "The processing status of the feed.\n\nAcceptable values are: \n- \"`\"`failure`\": The feed could not be processed or all items had errors.`\" \n- \"`in progress`\": The feed is being processed. \n- \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. \n- \"`success`\": The feed was processed successfully, though some items might have had errors.", + "description": "The processing status of the feed. Acceptable values are: - \"`\"`failure`\": The feed could not be processed or all items had errors.`\" - \"`in progress`\": The feed is being processed. - \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - \"`success`\": The feed was processed successfully, though some items might have had errors. ", "type": "string" }, "warnings": { @@ -5093,7 +6441,7 @@ "id": "DatafeedTarget", "properties": { "country": { - "description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code.", + "description": "The country where the items in the feed will be included in the search index, represented as a CLDR territory code.", "type": "string" }, "excludedDestinations": { @@ -5104,7 +6452,7 @@ "type": "array" }, "includedDestinations": { - "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.\n\nList of supported destinations (if available to the account): \n- DisplayAds \n- Shopping \n- ShoppingActions \n- SurfacesAcrossGoogle", + "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle ", "items": { "type": "string" }, @@ -5154,7 +6502,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`delete`\" \n- \"`fetchNow`\" \n- \"`get`\" \n- \"`insert`\" \n- \"`update`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`fetchNow`\" - \"`get`\" - \"`insert`\" - \"`update`\" ", "type": "string" } }, @@ -5171,7 +6519,6 @@ "type": "array" }, "kind": { - "default": "content#datafeedsCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsCustomBatchResponse\".", "type": "string" } @@ -5202,7 +6549,6 @@ "id": "DatafeedsFetchNowResponse", "properties": { "kind": { - "default": "content#datafeedsFetchNowResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsFetchNowResponse\".", "type": "string" } @@ -5213,7 +6559,6 @@ "id": "DatafeedsListResponse", "properties": { "kind": { - "default": "content#datafeedsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedsListResponse\".", "type": "string" }, @@ -5271,7 +6616,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`get`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ", "type": "string" } }, @@ -5288,7 +6633,6 @@ "type": "array" }, "kind": { - "default": "content#datafeedstatusesCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesCustomBatchResponse\".", "type": "string" } @@ -5319,7 +6663,6 @@ "id": "DatafeedstatusesListResponse", "properties": { "kind": { - "default": "content#datafeedstatusesListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#datafeedstatusesListResponse\".", "type": "string" }, @@ -5336,6 +6679,79 @@ }, "type": "object" }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DateTime": { + "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.", + "id": "DateTime", + "properties": { + "day": { + "description": "Required. Day of month. Must be from 1 to 31 and valid for the year and month.", + "format": "int32", + "type": "integer" + }, + "hours": { + "description": "Required. Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Required. Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Required. Month of year. Must be from 1 to 12.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Required. Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Time zone." + }, + "utcOffset": { + "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", + "format": "google-duration", + "type": "string" + }, + "year": { + "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "DeliveryTime": { "id": "DeliveryTime", "properties": { @@ -5480,7 +6896,7 @@ "type": "array" }, "numberOfItems": { - "description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"<= 10 items\", \" 50 items\". Must be non-empty. Can only be set if all other fields are not set.", + "description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"<= 10 items\", \"<= 50 items\", and \"> 50 items\". Must be non-empty. Can only be set if all other fields are not set.", "items": { "type": "string" }, @@ -5494,14 +6910,14 @@ "type": "array" }, "prices": { - "description": "A list of inclusive order price upper bounds. The last price's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}]` represents the headers \"<= $10\", \" $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.", + "description": "A list of inclusive order price upper bounds. The last price's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}]` represents the headers \"<= $10\", \"<= $500\", and \"> $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.", "items": { "$ref": "Price" }, "type": "array" }, "weights": { - "description": "A list of inclusive order weight upper bounds. The last weight's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}]` represents the headers \"<= 10kg\", \" 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.", + "description": "A list of inclusive order weight upper bounds. The last weight's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}]` represents the headers \"<= 10kg\", \"<= 50kg\", and \"> 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.", "items": { "$ref": "Weight" }, @@ -5523,7 +6939,7 @@ "type": "integer" }, "deadlineTimezone": { - "description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.", + "description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.", "type": "string" }, "holidayId": { @@ -5562,7 +6978,41 @@ "type": "string" }, "type": { - "description": "The holiday type. Always present.\n\nAcceptable values are: \n- \"`Christmas`\" \n- \"`Easter`\" \n- \"`Father's Day`\" \n- \"`Halloween`\" \n- \"`Independence Day (USA)`\" \n- \"`Mother's Day`\" \n- \"`Thanksgiving`\" \n- \"`Valentine's Day`\"", + "description": "The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" ", + "type": "string" + } + }, + "type": "object" + }, + "InapplicabilityDetails": { + "description": "Map of inapplicability details.", + "id": "InapplicabilityDetails", + "properties": { + "inapplicableCount": { + "description": "Count of this inapplicable reason code.", + "format": "int64", + "type": "string" + }, + "inapplicableReason": { + "description": "Reason code this rule was not applicable.", + "enum": [ + "INAPPLICABLE_REASON_UNSPECIFIED", + "CANNOT_BEAT_BUYBOX_WINNER", + "ALREADY_WINNING_BUYBOX", + "TRIUMPHED_OVER_BY_SAME_TYPE_RULE", + "TRIUMPHED_OVER_BY_OTHER_RULE_ON_OFFER", + "RESTRICTIONS_NOT_MET", + "UNCATEGORIZED" + ], + "enumDescriptions": [ + "Default value. Should not be used.", + "The rule set for this product cannot beat the buybox winner.", + "This product can already win the buybox without rule.", + "Another rule of the same type takes precedence over this one.", + "Another rule of a different type takes precedence over this one.", + "The rule restrictions are not met. For example, this may be the case if the calculated rule price is lower than floor price in the restriction.", + "The reason is not categorized to any known reason." + ], "type": "string" } }, @@ -5608,17 +7058,32 @@ "description": "[required] Total additional charge for this type." }, "type": { - "description": "[required] Type of the additional charge.\n\nAcceptable values are: \n- \"`shipping`\"", + "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ", "type": "string" } }, "type": "object" }, + "LabelIds": { + "description": "The IDs of labels that should be assigned to the CSS domain.", + "id": "LabelIds", + "properties": { + "labelIds": { + "description": "The list of label IDs.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "LiaAboutPageSettings": { "id": "LiaAboutPageSettings", "properties": { "status": { - "description": "The status of the verification process for the About page.\n\nAcceptable values are: \n- \"`active`\" \n- \"`inactive`\" \n- \"`pending`\"", + "description": "The status of the verification process for the About page. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ", "type": "string" }, "url": { @@ -5636,11 +7101,6 @@ "description": "The settings for the About page." }, "country": { - "annotations": { - "required": [ - "content.liasettings.update" - ] - }, "description": "Required. CLDR country code (e.g. \"US\").", "type": "string" }, @@ -5679,11 +7139,11 @@ "type": "string" }, "inventoryVerificationContactStatus": { - "description": "The status of the verification contact.\n\nAcceptable values are: \n- \"`active`\" \n- \"`inactive`\" \n- \"`pending`\"", + "description": "The status of the verification contact. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ", "type": "string" }, "status": { - "description": "The status of the inventory verification process.\n\nAcceptable values are: \n- \"`active`\" \n- \"`inactive`\" \n- \"`pending`\"", + "description": "The status of the inventory verification process. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ", "type": "string" } }, @@ -5697,7 +7157,7 @@ "type": "string" }, "status": { - "description": "The status of the ?On display to order? feature.\n\nAcceptable values are: \n- \"`active`\" \n- \"`inactive`\" \n- \"`pending`\"", + "description": "The status of the ?On display to order? feature. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ", "type": "string" } }, @@ -5735,7 +7195,6 @@ "type": "array" }, "kind": { - "default": "content#liaSettings", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liaSettings`\"", "type": "string" } @@ -5794,7 +7253,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`get`\" \n- \"`getAccessibleGmbAccounts`\" \n- \"`requestGmbAccess`\" \n- \"`requestInventoryVerification`\" \n- \"`setInventoryVerificationContact`\" \n- \"`update`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`getAccessibleGmbAccounts`\" - \"`requestGmbAccess`\" - \"`requestInventoryVerification`\" - \"`setInventoryVerificationContact`\" - \"`update`\" ", "type": "string" }, "posDataProviderId": { @@ -5820,7 +7279,6 @@ "type": "array" }, "kind": { - "default": "content#liasettingsCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsCustomBatchResponse\".", "type": "string" } @@ -5841,10 +7299,9 @@ }, "gmbAccounts": { "$ref": "GmbAccounts", - "description": "The the list of accessible GMB accounts." + "description": "The list of accessible GMB accounts." }, "kind": { - "default": "content#liasettingsCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponseEntry`\"", "type": "string" }, @@ -5878,7 +7335,6 @@ "type": "array" }, "kind": { - "default": "content#liasettingsGetAccessibleGmbAccountsResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsGetAccessibleGmbAccountsResponse\".", "type": "string" } @@ -5889,7 +7345,6 @@ "id": "LiasettingsListPosDataProvidersResponse", "properties": { "kind": { - "default": "content#liasettingsListPosDataProvidersResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListPosDataProvidersResponse\".", "type": "string" }, @@ -5907,7 +7362,6 @@ "id": "LiasettingsListResponse", "properties": { "kind": { - "default": "content#liasettingsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsListResponse\".", "type": "string" }, @@ -5928,7 +7382,6 @@ "id": "LiasettingsRequestGmbAccessResponse", "properties": { "kind": { - "default": "content#liasettingsRequestGmbAccessResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestGmbAccessResponse\".", "type": "string" } @@ -5939,7 +7392,6 @@ "id": "LiasettingsRequestInventoryVerificationResponse", "properties": { "kind": { - "default": "content#liasettingsRequestInventoryVerificationResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsRequestInventoryVerificationResponse\".", "type": "string" } @@ -5950,7 +7402,6 @@ "id": "LiasettingsSetInventoryVerificationContactResponse", "properties": { "kind": { - "default": "content#liasettingsSetInventoryVerificationContactResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetInventoryVerificationContactResponse\".", "type": "string" } @@ -5961,7 +7412,6 @@ "id": "LiasettingsSetPosDataProviderResponse", "properties": { "kind": { - "default": "content#liasettingsSetPosDataProviderResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#liasettingsSetPosDataProviderResponse\".", "type": "string" } @@ -5972,11 +7422,11 @@ "id": "LinkService", "properties": { "service": { - "description": "Service provided to or by the linked account.\n\nAcceptable values are: \n- \"`shoppingActionsOrderManagement`\" \n- \"`shoppingActionsProductManagement`\" \n- \"`shoppingAdsProductManagement`\"", + "description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" ", "type": "string" }, "status": { - "description": "Status of the link\n\nAcceptable values are: \n- \"`active`\" \n- \"`inactive`\" \n- \"`pending`\"", + "description": "Status of the link Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ", "type": "string" } }, @@ -5999,12 +7449,170 @@ }, "type": "object" }, + "ListAccountLabelsResponse": { + "description": "Response message for the `ListAccountLabels` method.", + "id": "ListAccountLabelsResponse", + "properties": { + "accountLabels": { + "description": "The labels from the specified account.", + "items": { + "$ref": "AccountLabel" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "ListAccountReturnCarrierResponse": { + "description": "Response for listing account return carriers.", + "id": "ListAccountReturnCarrierResponse", + "properties": { + "accountReturnCarriers": { + "description": "List of all available account return carriers for the merchant.", + "items": { + "$ref": "AccountReturnCarrier" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListCollectionStatusesResponse": { + "description": "Response message for the ListCollectionStatuses method.", + "id": "ListCollectionStatusesResponse", + "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" + }, + "resources": { + "description": "The collectionstatuses listed.", + "items": { + "$ref": "CollectionStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListCollectionsResponse": { + "description": "Response message for the ListCollections method.", + "id": "ListCollectionsResponse", + "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" + }, + "resources": { + "description": "The collections listed.", + "items": { + "$ref": "Collection" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListCssesResponse": { + "description": "The response message for the `ListCsses` method", + "id": "ListCssesResponse", + "properties": { + "csses": { + "description": "The CSS domains affiliated with the specified CSS group.", + "items": { + "$ref": "Css" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "ListRegionsResponse": { + "description": "Response message for the `ListRegions` method.", + "id": "ListRegionsResponse", + "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" + }, + "regions": { + "description": "The regions from the specified merchant.", + "items": { + "$ref": "Region" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRepricingProductReportsResponse": { + "description": "Response message for the ListRepricingProductReports method.", + "id": "ListRepricingProductReportsResponse", + "properties": { + "nextPageToken": { + "description": "A token for retrieving the next page. Its absence means there is no subsequent page.", + "type": "string" + }, + "repricingProductReports": { + "description": "Periodic reports for the given Repricing product.", + "items": { + "$ref": "RepricingProductReport" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRepricingRuleReportsResponse": { + "description": "Response message for the ListRepricingRuleReports method.", + "id": "ListRepricingRuleReportsResponse", + "properties": { + "nextPageToken": { + "description": "A token for retrieving the next page. Its absence means there is no subsequent page.", + "type": "string" + }, + "repricingRuleReports": { + "description": "Daily reports for the given Repricing rule.", + "items": { + "$ref": "RepricingRuleReport" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRepricingRulesResponse": { + "description": "Response message for the `ListRepricingRules` method.", + "id": "ListRepricingRulesResponse", + "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" + }, + "repricingRules": { + "description": "The rules from the specified merchant.", + "items": { + "$ref": "RepricingRule" + }, + "type": "array" + } + }, + "type": "object" + }, "LocalInventory": { "description": "Local inventory resource. For accepted attribute values, see the local product inventory feed specification.", "id": "LocalInventory", "properties": { "availability": { - "description": "Availability of the product.", + "description": "Availability of the product. For accepted attribute values, see the local product inventory feed specification.", "type": "string" }, "instoreProductLocation": { @@ -6012,16 +7620,15 @@ "type": "string" }, "kind": { - "default": "content#localInventory", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localInventory`\"", "type": "string" }, "pickupMethod": { - "description": "Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`.", + "description": "Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed // specification.", "type": "string" }, "pickupSla": { - "description": "Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`.", + "description": "Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.", "type": "string" }, "price": { @@ -6080,7 +7687,7 @@ "type": "string" }, "method": { - "description": "Method of the batch request entry.\n\nAcceptable values are: \n- \"`insert`\"", + "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ", "type": "string" }, "productId": { @@ -6101,7 +7708,6 @@ "type": "array" }, "kind": { - "default": "content#localinventoryCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#localinventoryCustomBatchResponse\".", "type": "string" } @@ -6122,7 +7728,6 @@ "description": "A list of errors defined if and only if the request failed." }, "kind": { - "default": "content#localinventoryCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localinventoryCustomBatchResponseEntry`\"", "type": "string" } @@ -6250,7 +7855,7 @@ "type": "string" }, "state": { - "description": "State of the item.\n\nAcceptable values are: \n- \"`canceled`\" \n- \"`new`\" \n- \"`received`\" \n- \"`refunded`\" \n- \"`rejected`\"", + "description": "State of the item. Acceptable values are: - \"`canceled`\" - \"`new`\" - \"`received`\" - \"`refunded`\" - \"`rejected`\" ", "type": "string" } }, @@ -6315,7 +7920,7 @@ "type": "object" }, "Order": { - "description": "Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==)", + "description": "Order. Production access (all methods) requires the order manager role. Sandbox access does not.", "id": "Order", "properties": { "acknowledged": { @@ -6346,7 +7951,6 @@ "type": "string" }, "kind": { - "default": "content#order", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#order`\"", "type": "string" }, @@ -6374,7 +7978,7 @@ "description": "The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds." }, "paymentStatus": { - "description": "The status of the payment.\n\nAcceptable values are: \n- \"`paymentCaptured`\" \n- \"`paymentRejected`\" \n- \"`paymentSecured`\" \n- \"`pendingAuthorization`\"", + "description": "The status of the payment. Acceptable values are: - \"`paymentCaptured`\" - \"`paymentRejected`\" - \"`paymentSecured`\" - \"`pendingAuthorization`\" ", "type": "string" }, "pickupDetails": { @@ -6386,7 +7990,7 @@ "type": "string" }, "promotions": { - "description": "Promotions associated with the order.\n\nTo determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId.\n\nExamples: \n- To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`. \n- To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item. \n\nOnly 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price.\n\nMore details about the program are here.", + "description": "Promotions associated with the order. To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: 1. To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`. 2. To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here.", "items": { "$ref": "OrderPromotion" }, @@ -6415,11 +8019,11 @@ "description": "The tax for the total shipping cost." }, "status": { - "description": "The status of the order.\n\nAcceptable values are: \n- \"`canceled`\" \n- \"`delivered`\" \n- \"`inProgress`\" \n- \"`partiallyDelivered`\" \n- \"`partiallyReturned`\" \n- \"`partiallyShipped`\" \n- \"`pendingShipment`\" \n- \"`returned`\" \n- \"`shipped`\"", + "description": "The status of the order. Acceptable values are: - \"`canceled`\" - \"`delivered`\" - \"`inProgress`\" - \"`partiallyDelivered`\" - \"`partiallyReturned`\" - \"`partiallyShipped`\" - \"`pendingShipment`\" - \"`returned`\" - \"`shipped`\" ", "type": "string" }, "taxCollector": { - "description": "The party responsible for collecting and remitting taxes.\n\nAcceptable values are: \n- \"`marketplaceFacilitator`\" \n- \"`merchant`\"", + "description": "The party responsible for collecting and remitting taxes. Acceptable values are: - \"`marketplaceFacilitator`\" - \"`merchant`\" ", "type": "string" } }, @@ -6433,7 +8037,7 @@ "type": "string" }, "fullAddress": { - "description": "Strings representing the lines of the printed label for mailing the order, for example:\nJohn Smith\n1600 Amphitheatre Parkway\nMountain View, CA, 94043\nUnited States", + "description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States ", "items": { "type": "string" }, @@ -6473,7 +8077,7 @@ "id": "OrderCancellation", "properties": { "actor": { - "description": "The actor that created the cancellation.\n\nAcceptable values are: \n- \"`customer`\" \n- \"`googleBot`\" \n- \"`googleCustomerService`\" \n- \"`googlePayments`\" \n- \"`googleSabre`\" \n- \"`merchant`\"", + "description": "The actor that created the cancellation. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ", "type": "string" }, "creationDate": { @@ -6486,7 +8090,7 @@ "type": "integer" }, "reason": { - "description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads.\n\nAcceptable values are: \n- \"`autoPostInternal`\" \n- \"`autoPostInvalidBillingAddress`\" \n- \"`autoPostNoInventory`\" \n- \"`autoPostPriceError`\" \n- \"`autoPostUndeliverableShippingAddress`\" \n- \"`couponAbuse`\" \n- \"`customerCanceled`\" \n- \"`customerInitiatedCancel`\" \n- \"`customerSupportRequested`\" \n- \"`failToPushOrderGoogleError`\" \n- \"`failToPushOrderMerchantError`\" \n- \"`failToPushOrderMerchantFulfillmentError`\" \n- \"`failToPushOrderToMerchant`\" \n- \"`failToPushOrderToMerchantOutOfStock`\" \n- \"`invalidCoupon`\" \n- \"`malformedShippingAddress`\" \n- \"`merchantDidNotShipOnTime`\" \n- \"`noInventory`\" \n- \"`orderTimeout`\" \n- \"`other`\" \n- \"`paymentAbuse`\" \n- \"`paymentDeclined`\" \n- \"`priceError`\" \n- \"`returnRefundAbuse`\" \n- \"`shippingPriceError`\" \n- \"`taxError`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\"", + "description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ", "type": "string" }, "reasonText": { @@ -6504,7 +8108,7 @@ "type": "string" }, "invoiceReceivingEmail": { - "description": "Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Shopping Actions.", + "description": "Email address for the merchant to send value-added tax or invoice documentation of the order. Only the last document sent is made available to the customer. For more information, see About automated VAT invoicing for Buy on Google.", "type": "string" }, "loyaltyInfo": { @@ -6536,7 +8140,7 @@ "id": "OrderCustomerMarketingRightsInfo", "properties": { "explicitMarketingPreference": { - "description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in.\n\nAcceptable values are: \n- \"`denied`\" \n- \"`granted`\"", + "description": "Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - \"`denied`\" - \"`granted`\" ", "type": "string" }, "lastUpdatedTimestamp": { @@ -6674,7 +8278,7 @@ "description": "Adjustment for total tax of the line item." }, "type": { - "description": "Type of this adjustment.\n\nAcceptable values are: \n- \"`promotion`\"", + "description": "Type of this adjustment. Acceptable values are: - \"`promotion`\" ", "type": "string" } }, @@ -6688,7 +8292,7 @@ "type": "string" }, "condition": { - "description": "Condition or state of the item.\n\nAcceptable values are: \n- \"`new`\" \n- \"`refurbished`\" \n- \"`used`\"", + "description": "Condition or state of the item. Acceptable values are: - \"`new`\" - \"`refurbished`\" - \"`used`\" ", "type": "string" }, "contentLanguage": { @@ -6735,7 +8339,7 @@ "type": "string" }, "targetCountry": { - "description": "The CLDR territory code of the target country of the product.", + "description": "The CLDR territory // code of the target country of the product.", "type": "string" }, "title": { @@ -6784,30 +8388,15 @@ "id": "OrderLineItemReturnInfo", "properties": { "daysToReturn": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. How many days later the item can be returned.", "format": "int32", "type": "integer" }, "isReturnable": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Whether the item is returnable.", "type": "boolean" }, "policyUrl": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. URL of the item return policy.", "type": "string" } @@ -6818,21 +8407,11 @@ "id": "OrderLineItemShippingDetails", "properties": { "deliverByDate": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. The delivery by date, in ISO 8601 format.", "type": "string" }, "method": { "$ref": "OrderLineItemShippingDetailsMethod", - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Details of the shipping method." }, "pickupPromiseInMinutes": { @@ -6841,16 +8420,11 @@ "type": "integer" }, "shipByDate": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. The ship by date, in ISO 8601 format.", "type": "string" }, "type": { - "description": "Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment.\n\nAcceptable values are: \n- \"`delivery`\" \n- \"`pickup`\"", + "description": "Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - \"`delivery`\" - \"`pickup`\" ", "type": "string" } }, @@ -6864,30 +8438,15 @@ "type": "string" }, "maxDaysInTransit": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Maximum transit time.", "format": "uint32", "type": "integer" }, "methodName": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. The name of the shipping method.", "type": "string" }, "minDaysInTransit": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Minimum transit time.", "format": "uint32", "type": "integer" @@ -6942,7 +8501,7 @@ "type": "string" }, "pickupType": { - "description": "The pickup type of this order.\n\nAcceptable values are: \n- \"`merchantStore`\" \n- \"`merchantStoreCurbside`\" \n- \"`merchantStoreLocker`\" \n- \"`thirdPartyPickupPoint`\" \n- \"`thirdPartyLocker`\"", + "description": "The pickup type of this order. Acceptable values are: - \"`merchantStore`\" - \"`merchantStoreCurbside`\" - \"`merchantStoreLocker`\" - \"`thirdPartyPickupPoint`\" - \"`thirdPartyLocker`\" ", "type": "string" } }, @@ -6984,20 +8543,10 @@ "type": "string" }, "funder": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`.\n\nAcceptable values are: \n- \"`google`\" \n- \"`merchant`\"", + "description": "Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`. Acceptable values are: - \"`google`\" - \"`merchant`\" ", "type": "string" }, "merchantPromotionId": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. This field is used to identify promotions within merchants' own systems.", "type": "string" }, @@ -7014,12 +8563,7 @@ "type": "string" }, "subtype": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`.\n\nAcceptable values are: \n- \"`buyMGetMoneyOff`\" \n- \"`buyMGetNMoneyOff`\" \n- \"`buyMGetNPercentOff`\" \n- \"`buyMGetPercentOff`\" \n- \"`freeGift`\" \n- \"`freeGiftWithItemId`\" \n- \"`freeGiftWithValue`\" \n- \"`freeShippingOvernight`\" \n- \"`freeShippingStandard`\" \n- \"`freeShippingTwoDay`\" \n- \"`moneyOff`\" \n- \"`percentOff`\" \n- \"`rewardPoints`\" \n- \"`salePrice`\"", + "description": "Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`. Acceptable values are: - \"`buyMGetMoneyOff`\" - \"`buyMGetNMoneyOff`\" - \"`buyMGetNPercentOff`\" - \"`buyMGetPercentOff`\" - \"`freeGift`\" - \"`freeGiftWithItemId`\" - \"`freeGiftWithValue`\" - \"`freeShippingOvernight`\" - \"`freeShippingStandard`\" - \"`freeShippingTwoDay`\" - \"`moneyOff`\" - \"`percentOff`\" - \"`rewardPoints`\" - \"`salePrice`\" ", "type": "string" }, "taxValue": { @@ -7027,21 +8571,11 @@ "description": "Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`." }, "title": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. The title of the promotion.", "type": "string" }, "type": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`.\n\nAcceptable values are: \n- \"`product`\" \n- \"`shipping`\"", + "description": "Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`. Acceptable values are: - \"`product`\" - \"`shipping`\" ", "type": "string" } }, @@ -7055,11 +8589,6 @@ "type": "string" }, "offerId": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Offer ID of a product. Only for `orders.createtestorder`.", "type": "string" }, @@ -7079,7 +8608,7 @@ "id": "OrderRefund", "properties": { "actor": { - "description": "The actor that created the refund.\n\nAcceptable values are: \n- \"`customer`\" \n- \"`googleBot`\" \n- \"`googleCustomerService`\" \n- \"`googlePayments`\" \n- \"`googleSabre`\" \n- \"`merchant`\"", + "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ", "type": "string" }, "amount": { @@ -7091,7 +8620,7 @@ "type": "string" }, "reason": { - "description": "The reason for the refund.\n\nAcceptable values are: \n- \"`adjustment`\" \n- \"`autoPostInternal`\" \n- \"`autoPostInvalidBillingAddress`\" \n- \"`autoPostNoInventory`\" \n- \"`autoPostPriceError`\" \n- \"`autoPostUndeliverableShippingAddress`\" \n- \"`couponAbuse`\" \n- \"`courtesyAdjustment`\" \n- \"`customerCanceled`\" \n- \"`customerDiscretionaryReturn`\" \n- \"`customerInitiatedMerchantCancel`\" \n- \"`customerSupportRequested`\" \n- \"`deliveredLateByCarrier`\" \n- \"`deliveredTooLate`\" \n- \"`expiredItem`\" \n- \"`failToPushOrderGoogleError`\" \n- \"`failToPushOrderMerchantError`\" \n- \"`failToPushOrderMerchantFulfillmentError`\" \n- \"`failToPushOrderToMerchant`\" \n- \"`failToPushOrderToMerchantOutOfStock`\" \n- \"`feeAdjustment`\" \n- \"`invalidCoupon`\" \n- \"`lateShipmentCredit`\" \n- \"`malformedShippingAddress`\" \n- \"`merchantDidNotShipOnTime`\" \n- \"`noInventory`\" \n- \"`orderTimeout`\" \n- \"`other`\" \n- \"`paymentAbuse`\" \n- \"`paymentDeclined`\" \n- \"`priceAdjustment`\" \n- \"`priceError`\" \n- \"`productArrivedDamaged`\" \n- \"`productNotAsDescribed`\" \n- \"`promoReallocation`\" \n- \"`qualityNotAsExpected`\" \n- \"`returnRefundAbuse`\" \n- \"`shippingCostAdjustment`\" \n- \"`shippingPriceError`\" \n- \"`taxAdjustment`\" \n- \"`taxError`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\" \n- \"`wrongProductShipped`\"", + "description": "The reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ", "type": "string" }, "reasonText": { @@ -7102,7 +8631,7 @@ "type": "object" }, "OrderReportDisbursement": { - "description": "Order disbursement. All methods require the payment analyst role. (== resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==)", + "description": "Order disbursement. All methods require the payment analyst role.", "id": "OrderReportDisbursement", "properties": { "disbursementAmount": { @@ -7176,7 +8705,7 @@ "id": "OrderReturn", "properties": { "actor": { - "description": "The actor that created the refund.\n\nAcceptable values are: \n- \"`customer`\" \n- \"`googleBot`\" \n- \"`googleCustomerService`\" \n- \"`googlePayments`\" \n- \"`googleSabre`\" \n- \"`merchant`\"", + "description": "The actor that created the refund. Acceptable values are: - \"`customer`\" - \"`googleBot`\" - \"`googleCustomerService`\" - \"`googlePayments`\" - \"`googleSabre`\" - \"`merchant`\" ", "type": "string" }, "creationDate": { @@ -7189,7 +8718,7 @@ "type": "integer" }, "reason": { - "description": "The reason for the return.\n\nAcceptable values are: \n- \"`customerDiscretionaryReturn`\" \n- \"`customerInitiatedMerchantCancel`\" \n- \"`deliveredTooLate`\" \n- \"`expiredItem`\" \n- \"`invalidCoupon`\" \n- \"`malformedShippingAddress`\" \n- \"`other`\" \n- \"`productArrivedDamaged`\" \n- \"`productNotAsDescribed`\" \n- \"`qualityNotAsExpected`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\" \n- \"`wrongProductShipped`\"", + "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ", "type": "string" }, "reasonText": { @@ -7203,7 +8732,7 @@ "id": "OrderShipment", "properties": { "carrier": { - "description": "The carrier handling the shipment.\n\nFor supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. \nSupported carriers for US are: \n- \"`ups`\" (United Parcel Service) automatic status updates \n- \"`usps`\" (United States Postal Service) automatic status updates \n- \"`fedex`\" (FedEx) automatic status updates \n- \"`dhl`\" (DHL eCommerce) automatic status updates (US only) \n- \"`ontrac`\" (OnTrac) automatic status updates \n- \"`dhl express`\" (DHL Express)\n- \"`deliv`\" (Deliv) \n- \"`dynamex`\" (TForce) \n- \"`lasership`\" (LaserShip) \n- \"`mpx`\" (Military Parcel Xpress) \n- \"`uds`\" (United Delivery Service) \n- \"`efw`\" (Estes Forwarding Worldwide) \n- \"`jd logistics`\" (JD Logistics) \n- \"`yunexpress`\" (YunExpress) \n- \"`china post`\" (China Post) \n- \"`china ems`\" (China Post Express Mail Service) \n- \"`singapore post`\" (Singapore Post) \n- \"`pos malaysia`\" (Pos Malaysia) \n- \"`postnl`\" (PostNL) \n- \"`ptt`\" (PTT Turkish Post) \n- \"`eub`\" (ePacket) \n- \"`chukou1`\" (Chukou1 Logistics) \n- \"`bestex`\" (Best Express) \n- \"`canada post`\" (Canada Post) \n- \"`purolator`\" (Purolator) \n- \"`canpar`\" (Canpar) \n- \"`india post`\" (India Post) \n- \"`blue dart`\" (Blue Dart) \n- \"`delhivery`\" (Delhivery) \n- \"`dtdc`\" (DTDC) \n- \"`tpc india`\" (TPC India) \nSupported carriers for FR are: \n- \"`la poste`\" (La Poste) automatic status updates \n- \"`colissimo`\" (Colissimo by La Poste) automatic status updates \n- \"`ups`\" (United Parcel Service) automatic status updates \n- \"`chronopost`\" (Chronopost by La Poste) \n- \"`gls`\" (General Logistics Systems France) \n- \"`dpd`\" (DPD Group by GeoPost) \n- \"`bpost`\" (Belgian Post Group) \n- \"`colis prive`\" (Colis Privé) \n- \"`boxtal`\" (Boxtal) \n- \"`geodis`\" (GEODIS) \n- \"`tnt`\" (TNT) \n- \"`db schenker`\" (DB Schenker) \n- \"`aramex`\" (Aramex)", + "description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Privé) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) ", "type": "string" }, "creationDate": { @@ -7234,7 +8763,7 @@ "type": "string" }, "status": { - "description": "The status of the shipment.\n\nAcceptable values are: \n- \"`delivered`\" \n- \"`readyForPickup`\" \n- \"`shipped`\" \n- \"`undeliverable`\"", + "description": "The status of the shipment. Acceptable values are: - \"`delivered`\" - \"`readyForPickup`\" - \"`shipped`\" - \"`undeliverable`\" ", "type": "string" }, "trackingId": { @@ -7277,6 +8806,174 @@ }, "type": "object" }, + "OrderTrackingSignal": { + "description": "Represents a merchant trade from which signals are extracted, e.g. shipping.", + "id": "OrderTrackingSignal", + "properties": { + "customerShippingFee": { + "$ref": "PriceAmount", + "description": "The shipping fee of the order; this value should be set to zero in the case of free shipping." + }, + "deliveryPostalCode": { + "description": "Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. \"95016\".", + "type": "string" + }, + "deliveryRegionCode": { + "description": "Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.", + "type": "string" + }, + "lineItems": { + "description": "Information about line items in the order.", + "items": { + "$ref": "OrderTrackingSignalLineItemDetails" + }, + "type": "array" + }, + "merchantId": { + "description": "The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals).", + "format": "int64", + "type": "string" + }, + "orderCreatedTime": { + "$ref": "DateTime", + "description": "Required. The time when the order was created on the merchant side. Include the year and timezone string, if available." + }, + "orderId": { + "description": "Required. The ID of the order on the merchant side.", + "type": "string" + }, + "orderTrackingSignalId": { + "description": "Output only. The ID that uniquely identifies this order tracking signal.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "shipmentLineItemMapping": { + "description": "The mapping of the line items to the shipment information.", + "items": { + "$ref": "OrderTrackingSignalShipmentLineItemMapping" + }, + "type": "array" + }, + "shippingInfo": { + "description": "The shipping information for the order.", + "items": { + "$ref": "OrderTrackingSignalShippingInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "OrderTrackingSignalLineItemDetails": { + "description": "The line items of the order.", + "id": "OrderTrackingSignalLineItemDetails", + "properties": { + "gtin": { + "description": "The Global Trade Item Number.", + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID for this line item.", + "type": "string" + }, + "mpn": { + "description": "The manufacturer part number.", + "type": "string" + }, + "productId": { + "description": "Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId.", + "type": "string" + }, + "quantity": { + "description": "Required. The quantity of the line item in the order.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "OrderTrackingSignalShipmentLineItemMapping": { + "description": "Represents how many items are in the shipment for the given shipment_id and line_item_id.", + "id": "OrderTrackingSignalShipmentLineItemMapping", + "properties": { + "lineItemId": { + "description": "Required. The line item ID.", + "type": "string" + }, + "quantity": { + "description": "Required. The line item quantity in the shipment.", + "format": "int64", + "type": "string" + }, + "shipmentId": { + "description": "Required. The shipment ID.", + "type": "string" + } + }, + "type": "object" + }, + "OrderTrackingSignalShippingInfo": { + "description": "The shipping information for the order.", + "id": "OrderTrackingSignalShippingInfo", + "properties": { + "actualDeliveryTime": { + "$ref": "DateTime", + "description": "The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name." + }, + "carrierName": { + "description": "The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.", + "type": "string" + }, + "carrierServiceName": { + "description": "The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.", + "type": "string" + }, + "earliestDeliveryPromiseTime": { + "$ref": "DateTime", + "description": "The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name." + }, + "latestDeliveryPromiseTime": { + "$ref": "DateTime", + "description": "The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name." + }, + "originPostalCode": { + "description": "The origin postal code, as a continuous string without spaces or dashes, e.g. \"95016\".", + "type": "string" + }, + "originRegionCode": { + "description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.", + "type": "string" + }, + "shipmentId": { + "description": "Required. The shipment ID.", + "type": "string" + }, + "shippedTime": { + "$ref": "DateTime", + "description": "The time when the shipment was shipped. Include the year and timezone string, if available." + }, + "shippingStatus": { + "description": "The status of the shipment.", + "enum": [ + "SHIPPING_STATE_UNSPECIFIED", + "SHIPPED", + "DELIVERED" + ], + "enumDescriptions": [ + "The shipping status is not known to merchant.", + "All items are shipped.", + "The shipment is already delivered." + ], + "type": "string" + }, + "trackingId": { + "description": "The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.", + "type": "string" + } + }, + "type": "object" + }, "OrderinvoicesCreateChargeInvoiceRequest": { "id": "OrderinvoicesCreateChargeInvoiceRequest", "properties": { @@ -7310,11 +9007,10 @@ "id": "OrderinvoicesCreateChargeInvoiceResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#orderinvoicesCreateChargeInvoiceResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateChargeInvoiceResponse\".", "type": "string" } @@ -7354,11 +9050,10 @@ "id": "OrderinvoicesCreateRefundInvoiceResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#orderinvoicesCreateRefundInvoiceResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderinvoicesCreateRefundInvoiceResponse\".", "type": "string" } @@ -7373,7 +9068,7 @@ "type": "string" }, "reason": { - "description": "[required] Reason for the refund.\n\nAcceptable values are: \n- \"`adjustment`\" \n- \"`autoPostInternal`\" \n- \"`autoPostInvalidBillingAddress`\" \n- \"`autoPostNoInventory`\" \n- \"`autoPostPriceError`\" \n- \"`autoPostUndeliverableShippingAddress`\" \n- \"`couponAbuse`\" \n- \"`courtesyAdjustment`\" \n- \"`customerCanceled`\" \n- \"`customerDiscretionaryReturn`\" \n- \"`customerInitiatedMerchantCancel`\" \n- \"`customerSupportRequested`\" \n- \"`deliveredLateByCarrier`\" \n- \"`deliveredTooLate`\" \n- \"`expiredItem`\" \n- \"`failToPushOrderGoogleError`\" \n- \"`failToPushOrderMerchantError`\" \n- \"`failToPushOrderMerchantFulfillmentError`\" \n- \"`failToPushOrderToMerchant`\" \n- \"`failToPushOrderToMerchantOutOfStock`\" \n- \"`feeAdjustment`\" \n- \"`invalidCoupon`\" \n- \"`lateShipmentCredit`\" \n- \"`malformedShippingAddress`\" \n- \"`merchantDidNotShipOnTime`\" \n- \"`noInventory`\" \n- \"`orderTimeout`\" \n- \"`other`\" \n- \"`paymentAbuse`\" \n- \"`paymentDeclined`\" \n- \"`priceAdjustment`\" \n- \"`priceError`\" \n- \"`productArrivedDamaged`\" \n- \"`productNotAsDescribed`\" \n- \"`promoReallocation`\" \n- \"`qualityNotAsExpected`\" \n- \"`returnRefundAbuse`\" \n- \"`shippingCostAdjustment`\" \n- \"`shippingPriceError`\" \n- \"`taxAdjustment`\" \n- \"`taxError`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\" \n- \"`wrongProductShipped`\"", + "description": "[required] Reason for the refund. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ", "type": "string" } }, @@ -7387,7 +9082,7 @@ "type": "string" }, "reason": { - "description": "[required] Reason for the return.\n\nAcceptable values are: \n- \"`customerDiscretionaryReturn`\" \n- \"`customerInitiatedMerchantCancel`\" \n- \"`deliveredTooLate`\" \n- \"`expiredItem`\" \n- \"`invalidCoupon`\" \n- \"`malformedShippingAddress`\" \n- \"`other`\" \n- \"`productArrivedDamaged`\" \n- \"`productNotAsDescribed`\" \n- \"`qualityNotAsExpected`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\" \n- \"`wrongProductShipped`\"", + "description": "[required] Reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ", "type": "string" } }, @@ -7404,7 +9099,6 @@ "type": "array" }, "kind": { - "default": "content#orderreportsListDisbursementsResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListDisbursementsResponse\".", "type": "string" }, @@ -7419,7 +9113,6 @@ "id": "OrderreportsListTransactionsResponse", "properties": { "kind": { - "default": "content#orderreportsListTransactionsResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreportsListTransactionsResponse\".", "type": "string" }, @@ -7451,11 +9144,10 @@ "id": "OrderreturnsAcknowledgeResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#orderreturnsAcknowledgeResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsAcknowledgeResponse\".", "type": "string" } @@ -7491,11 +9183,10 @@ "id": "OrderreturnsCreateOrderReturnResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#orderreturnsCreateOrderReturnResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsCreateOrderReturnResponse\".", "type": "string" }, @@ -7525,7 +9216,6 @@ "id": "OrderreturnsListResponse", "properties": { "kind": { - "default": "content#orderreturnsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsListResponse\".", "type": "string" }, @@ -7585,11 +9275,10 @@ "id": "OrderreturnsProcessResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#orderreturnsProcessResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#orderreturnsProcessResponse\".", "type": "string" } @@ -7668,11 +9357,10 @@ "id": "OrdersAcknowledgeResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersAcknowledgeResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAcknowledgeResponse\".", "type": "string" } @@ -7683,7 +9371,6 @@ "id": "OrdersAdvanceTestOrderResponse", "properties": { "kind": { - "default": "content#ordersAdvanceTestOrderResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersAdvanceTestOrderResponse\".", "type": "string" } @@ -7711,7 +9398,7 @@ "type": "integer" }, "reason": { - "description": "The reason for the cancellation.\n\nAcceptable values are: \n- \"`customerInitiatedCancel`\" \n- \"`invalidCoupon`\" \n- \"`malformedShippingAddress`\" \n- \"`noInventory`\" \n- \"`other`\" \n- \"`priceError`\" \n- \"`shippingPriceError`\" \n- \"`taxError`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\"", + "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ", "type": "string" }, "reasonText": { @@ -7725,11 +9412,10 @@ "id": "OrdersCancelLineItemResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersCancelLineItemResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelLineItemResponse\".", "type": "string" } @@ -7744,7 +9430,7 @@ "type": "string" }, "reason": { - "description": "The reason for the cancellation.\n\nAcceptable values are: \n- \"`customerInitiatedCancel`\" \n- \"`invalidCoupon`\" \n- \"`malformedShippingAddress`\" \n- \"`noInventory`\" \n- \"`other`\" \n- \"`priceError`\" \n- \"`shippingPriceError`\" \n- \"`taxError`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\"", + "description": "The reason for the cancellation. Acceptable values are: - \"`customerInitiatedCancel`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`noInventory`\" - \"`other`\" - \"`priceError`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" ", "type": "string" }, "reasonText": { @@ -7758,11 +9444,10 @@ "id": "OrdersCancelResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersCancelResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelResponse\".", "type": "string" } @@ -7773,7 +9458,7 @@ "id": "OrdersCancelTestOrderByCustomerRequest", "properties": { "reason": { - "description": "The reason for the cancellation.\n\nAcceptable values are: \n- \"`changedMind`\" \n- \"`orderedWrongItem`\" \n- \"`other`\"", + "description": "The reason for the cancellation. Acceptable values are: - \"`changedMind`\" - \"`orderedWrongItem`\" - \"`other`\" ", "type": "string" } }, @@ -7783,7 +9468,6 @@ "id": "OrdersCancelTestOrderByCustomerResponse", "properties": { "kind": { - "default": "content#ordersCancelTestOrderByCustomerResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCancelTestOrderByCustomerResponse\".", "type": "string" } @@ -7794,11 +9478,11 @@ "id": "OrdersCreateTestOrderRequest", "properties": { "country": { - "description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`.\n\nAcceptable values are: \n- \"`US`\" \n- \"`FR`\" Defaults to `US`.", + "description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - \"`US`\" - \"`FR`\" Defaults to `US`.", "type": "string" }, "templateName": { - "description": "The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template.\n\nAcceptable values are: \n- \"`template1`\" \n- \"`template1a`\" \n- \"`template1b`\" \n- \"`template2`\" \n- \"`template3`\"", + "description": "The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - \"`template1`\" - \"`template1a`\" - \"`template1b`\" - \"`template2`\" - \"`template3`\" ", "type": "string" }, "testOrder": { @@ -7812,7 +9496,6 @@ "id": "OrdersCreateTestOrderResponse", "properties": { "kind": { - "default": "content#ordersCreateTestOrderResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestOrderResponse\".", "type": "string" }, @@ -7840,7 +9523,6 @@ "id": "OrdersCreateTestReturnResponse", "properties": { "kind": { - "default": "content#ordersCreateTestReturnResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersCreateTestReturnResponse\".", "type": "string" }, @@ -7911,15 +9593,10 @@ "id": "OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo", "properties": { "carrier": { - "description": "The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.", + "description": "The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.", "type": "string" }, "shipmentId": { - "annotations": { - "required": [ - "content.orders.shiplineitems" - ] - }, "description": "Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.", "type": "string" }, @@ -7930,11 +9607,25 @@ }, "type": "object" }, + "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails": { + "description": "ScheduledDeliveryDetails used to update the scheduled delivery order.", + "id": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails", + "properties": { + "carrierPhoneNumber": { + "description": "The phone number of the carrier fulfilling the delivery. The phone number should be formatted as the international notation in", + "type": "string" + }, + "scheduledDate": { + "description": "The date a shipment is scheduled for delivery, in ISO 8601 format.", + "type": "string" + } + }, + "type": "object" + }, "OrdersGetByMerchantOrderIdResponse": { "id": "OrdersGetByMerchantOrderIdResponse", "properties": { "kind": { - "default": "content#ordersGetByMerchantOrderIdResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetByMerchantOrderIdResponse\".", "type": "string" }, @@ -7949,7 +9640,6 @@ "id": "OrdersGetTestOrderTemplateResponse", "properties": { "kind": { - "default": "content#ordersGetTestOrderTemplateResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersGetTestOrderTemplateResponse\".", "type": "string" }, @@ -7985,7 +9675,7 @@ "type": "integer" }, "reason": { - "description": "The reason for the return.\n\nAcceptable values are: \n- \"`customerDiscretionaryReturn`\" \n- \"`customerInitiatedMerchantCancel`\" \n- \"`deliveredTooLate`\" \n- \"`expiredItem`\" \n- \"`invalidCoupon`\" \n- \"`malformedShippingAddress`\" \n- \"`other`\" \n- \"`productArrivedDamaged`\" \n- \"`productNotAsDescribed`\" \n- \"`qualityNotAsExpected`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\" \n- \"`wrongProductShipped`\"", + "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ", "type": "string" }, "reasonText": { @@ -8003,11 +9693,10 @@ "id": "OrdersInStoreRefundLineItemResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersInStoreRefundLineItemResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersInStoreRefundLineItemResponse\".", "type": "string" } @@ -8018,7 +9707,6 @@ "id": "OrdersListResponse", "properties": { "kind": { - "default": "content#ordersListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersListResponse\".", "type": "string" }, @@ -8050,7 +9738,7 @@ "type": "string" }, "reason": { - "description": "The reason for the refund.\n\nAcceptable values are: \n- \"`shippingCostAdjustment`\" \n- \"`priceAdjustment`\" \n- \"`taxAdjustment`\" \n- \"`feeAdjustment`\" \n- \"`courtesyAdjustment`\" \n- \"`adjustment`\" \n- \"`customerCancelled`\" \n- \"`noInventory`\" \n- \"`productNotAsDescribed`\" \n- \"`undeliverableShippingAddress`\" \n- \"`wrongProductShipped`\" \n- \"`lateShipmentCredit`\" \n- \"`deliveredLateByCarrier`\" \n- \"`productArrivedDamaged`\"", + "description": "The reason for the refund. Acceptable values are: - \"`shippingCostAdjustment`\" - \"`priceAdjustment`\" - \"`taxAdjustment`\" - \"`feeAdjustment`\" - \"`courtesyAdjustment`\" - \"`adjustment`\" - \"`customerCancelled`\" - \"`noInventory`\" - \"`productNotAsDescribed`\" - \"`undeliverableShippingAddress`\" - \"`wrongProductShipped`\" - \"`lateShipmentCredit`\" - \"`deliveredLateByCarrier`\" - \"`productArrivedDamaged`\" ", "type": "string" }, "reasonText": { @@ -8068,11 +9756,10 @@ "id": "OrdersRefundItemResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersRefundItemResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundItemResponse\".", "type": "string" } @@ -8095,7 +9782,7 @@ "type": "string" }, "reason": { - "description": "The reason for the refund.\n\nAcceptable values are: \n- \"`courtesyAdjustment`\" \n- \"`other`\"", + "description": "The reason for the refund. Acceptable values are: - \"`courtesyAdjustment`\" - \"`other`\" ", "type": "string" }, "reasonText": { @@ -8109,11 +9796,10 @@ "id": "OrdersRefundOrderResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersRefundOrderResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRefundOrderResponse\".", "type": "string" } @@ -8141,7 +9827,7 @@ "type": "integer" }, "reason": { - "description": "The reason for the return.\n\nAcceptable values are: \n- \"`damagedOrUsed`\" \n- \"`missingComponent`\" \n- \"`notEligible`\" \n- \"`other`\" \n- \"`outOfReturnWindow`\"", + "description": "The reason for the return. Acceptable values are: - \"`damagedOrUsed`\" - \"`missingComponent`\" - \"`notEligible`\" - \"`other`\" - \"`outOfReturnWindow`\" ", "type": "string" }, "reasonText": { @@ -8155,11 +9841,10 @@ "id": "OrdersRejectReturnLineItemResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersRejectReturnLineItemResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersRejectReturnLineItemResponse\".", "type": "string" } @@ -8191,7 +9876,7 @@ "type": "integer" }, "reason": { - "description": "The reason for the return.\n\nAcceptable values are: \n- \"`customerDiscretionaryReturn`\" \n- \"`customerInitiatedMerchantCancel`\" \n- \"`deliveredTooLate`\" \n- \"`expiredItem`\" \n- \"`invalidCoupon`\" \n- \"`malformedShippingAddress`\" \n- \"`other`\" \n- \"`productArrivedDamaged`\" \n- \"`productNotAsDescribed`\" \n- \"`qualityNotAsExpected`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\" \n- \"`wrongProductShipped`\"", + "description": "The reason for the return. Acceptable values are: - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`other`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`qualityNotAsExpected`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ", "type": "string" }, "reasonText": { @@ -8209,11 +9894,10 @@ "id": "OrdersReturnRefundLineItemResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersReturnRefundLineItemResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersReturnRefundLineItemResponse\".", "type": "string" } @@ -8248,11 +9932,10 @@ "id": "OrdersSetLineItemMetadataResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersSetLineItemMetadataResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersSetLineItemMetadataResponse\".", "type": "string" } @@ -8291,11 +9974,10 @@ "id": "OrdersShipLineItemsResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersShipLineItemsResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersShipLineItemsResponse\".", "type": "string" } @@ -8306,7 +9988,7 @@ "id": "OrdersUpdateLineItemShippingDetailsRequest", "properties": { "deliverByDate": { - "description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.\n\nProvided date should be within 1 year timeframe and can not be a date in the past.", + "description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.", "type": "string" }, "lineItemId": { @@ -8322,7 +10004,7 @@ "type": "string" }, "shipByDate": { - "description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated.\n\nProvided date should be within 1 year timeframe and can not be a date in the past.", + "description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.", "type": "string" } }, @@ -8332,11 +10014,10 @@ "id": "OrdersUpdateLineItemShippingDetailsResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersUpdateLineItemShippingDetailsResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateLineItemShippingDetailsResponse\".", "type": "string" } @@ -8361,11 +10042,10 @@ "id": "OrdersUpdateMerchantOrderIdResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersUpdateMerchantOrderIdResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateMerchantOrderIdResponse\".", "type": "string" } @@ -8376,7 +10056,7 @@ "id": "OrdersUpdateShipmentRequest", "properties": { "carrier": { - "description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.", + "description": "The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values.", "type": "string" }, "deliveryDate": { @@ -8395,12 +10075,16 @@ "description": "Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if `status` is `ready for pickup`.", "type": "string" }, + "scheduledDeliveryDetails": { + "$ref": "OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails", + "description": "Delivery details of the shipment if scheduling is needed." + }, "shipmentId": { "description": "The ID of the shipment.", "type": "string" }, "status": { - "description": "New status for the shipment. Not updated if missing.\n\nAcceptable values are: \n- \"`delivered`\" \n- \"`undeliverable`\" \n- \"`readyForPickup`\"", + "description": "New status for the shipment. Not updated if missing. Acceptable values are: - \"`delivered`\" - \"`undeliverable`\" - \"`readyForPickup`\" ", "type": "string" }, "trackingId": { @@ -8418,11 +10102,10 @@ "id": "OrdersUpdateShipmentResponse", "properties": { "executionStatus": { - "description": "The status of the execution.\n\nAcceptable values are: \n- \"`duplicate`\" \n- \"`executed`\"", + "description": "The status of the execution. Acceptable values are: - \"`duplicate`\" - \"`executed`\" ", "type": "string" }, "kind": { - "default": "content#ordersUpdateShipmentResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#ordersUpdateShipmentResponse\".", "type": "string" } @@ -8484,7 +10167,7 @@ }, "inventory": { "$ref": "PosInventory", - "description": "The inventory to submit. Set this only if the method is `inventory`." + "description": "The inventory to submit. This should be set only if the method is `inventory`." }, "merchantId": { "description": "The ID of the POS data provider.", @@ -8492,19 +10175,19 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`delete`\" \n- \"`get`\" \n- \"`insert`\" \n- \"`inventory`\" \n- \"`sale`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`inventory`\" - \"`sale`\" ", "type": "string" }, "sale": { "$ref": "PosSale", - "description": "The sale information to submit. Set this only if the method is `sale`." + "description": "The sale information to submit. This should be set only if the method is `sale`." }, "store": { "$ref": "PosStore", - "description": "The store information to submit. Set this only if the method is `insert`." + "description": "The store information to submit. This should be set only if the method is `insert`." }, "storeCode": { - "description": "The store code. Set this only if the method is `delete` or `get`.", + "description": "The store code. This should be set only if the method is `delete` or `get`.", "type": "string" }, "targetMerchantId": { @@ -8526,7 +10209,6 @@ "type": "array" }, "kind": { - "default": "content#posCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posCustomBatchResponse\".", "type": "string" } @@ -8550,7 +10232,6 @@ "description": "The updated inventory information." }, "kind": { - "default": "content#posCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponseEntry`\"", "type": "string" }, @@ -8606,11 +10287,6 @@ "id": "PosInventory", "properties": { "contentLanguage": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The two-letter ISO 639-1 language code for the item.", "type": "string" }, @@ -8619,62 +10295,31 @@ "type": "string" }, "itemId": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. A unique identifier for the item.", "type": "string" }, "kind": { - "default": "content#posInventory", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\"", "type": "string" }, "price": { "$ref": "Price", - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The current price of the item." }, "quantity": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The available quantity of the item.", "format": "int64", "type": "string" }, "storeCode": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.", "type": "string" }, "targetCountry": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The CLDR territory code for the item.", "type": "string" }, "timestamp": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The inventory timestamp, in ISO 8601 format.", "type": "string" } @@ -8685,11 +10330,6 @@ "id": "PosInventoryRequest", "properties": { "contentLanguage": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The two-letter ISO 639-1 language code for the item.", "type": "string" }, @@ -8698,57 +10338,27 @@ "type": "string" }, "itemId": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. A unique identifier for the item.", "type": "string" }, "price": { "$ref": "Price", - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The current price of the item." }, "quantity": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The available quantity of the item.", "format": "int64", "type": "string" }, "storeCode": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.", "type": "string" }, "targetCountry": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The CLDR territory code for the item.", "type": "string" }, "timestamp": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The inventory timestamp, in ISO 8601 format.", "type": "string" } @@ -8759,11 +10369,6 @@ "id": "PosInventoryResponse", "properties": { "contentLanguage": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The two-letter ISO 639-1 language code for the item.", "type": "string" }, @@ -8772,62 +10377,31 @@ "type": "string" }, "itemId": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. A unique identifier for the item.", "type": "string" }, "kind": { - "default": "content#posInventoryResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posInventoryResponse\".", "type": "string" }, "price": { "$ref": "Price", - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The current price of the item." }, "quantity": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The available quantity of the item.", "format": "int64", "type": "string" }, "storeCode": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.", "type": "string" }, "targetCountry": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The CLDR territory code for the item.", "type": "string" }, "timestamp": { - "annotations": { - "required": [ - "content.pos.inventory" - ] - }, "description": "Required. The inventory timestamp, in ISO 8601 format.", "type": "string" } @@ -8838,7 +10412,6 @@ "id": "PosListResponse", "properties": { "kind": { - "default": "content#posListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posListResponse\".", "type": "string" }, @@ -8856,11 +10429,6 @@ "id": "PosSale", "properties": { "contentLanguage": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The two-letter ISO 639-1 language code for the item.", "type": "string" }, @@ -8869,34 +10437,18 @@ "type": "string" }, "itemId": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. A unique identifier for the item.", "type": "string" }, "kind": { - "default": "content#posSale", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSale`\"", "type": "string" }, "price": { "$ref": "Price", - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The price of the item." }, "quantity": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The relative change of the available quantity. Negative for items returned.", "format": "int64", "type": "string" @@ -8906,29 +10458,14 @@ "type": "string" }, "storeCode": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.", "type": "string" }, "targetCountry": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The CLDR territory code for the item.", "type": "string" }, "timestamp": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The inventory timestamp, in ISO 8601 format.", "type": "string" } @@ -8939,11 +10476,6 @@ "id": "PosSaleRequest", "properties": { "contentLanguage": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The two-letter ISO 639-1 language code for the item.", "type": "string" }, @@ -8952,29 +10484,14 @@ "type": "string" }, "itemId": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. A unique identifier for the item.", "type": "string" }, "price": { "$ref": "Price", - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The price of the item." }, "quantity": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The relative change of the available quantity. Negative for items returned.", "format": "int64", "type": "string" @@ -8984,29 +10501,14 @@ "type": "string" }, "storeCode": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.", "type": "string" }, "targetCountry": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The CLDR territory code for the item.", "type": "string" }, "timestamp": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The inventory timestamp, in ISO 8601 format.", "type": "string" } @@ -9017,11 +10519,6 @@ "id": "PosSaleResponse", "properties": { "contentLanguage": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The two-letter ISO 639-1 language code for the item.", "type": "string" }, @@ -9030,34 +10527,18 @@ "type": "string" }, "itemId": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. A unique identifier for the item.", "type": "string" }, "kind": { - "default": "content#posSaleResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#posSaleResponse\".", "type": "string" }, "price": { "$ref": "Price", - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The price of the item." }, "quantity": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The relative change of the available quantity. Negative for items returned.", "format": "int64", "type": "string" @@ -9067,29 +10548,14 @@ "type": "string" }, "storeCode": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business.", "type": "string" }, "targetCountry": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The CLDR territory code for the item.", "type": "string" }, "timestamp": { - "annotations": { - "required": [ - "content.pos.sale" - ] - }, "description": "Required. The inventory timestamp, in ISO 8601 format.", "type": "string" } @@ -9101,25 +10567,14 @@ "id": "PosStore", "properties": { "kind": { - "default": "content#posStore", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posStore`\"", "type": "string" }, "storeAddress": { - "annotations": { - "required": [ - "content.pos.insert" - ] - }, "description": "Required. The street address of the store.", "type": "string" }, "storeCode": { - "annotations": { - "required": [ - "content.pos.insert" - ] - }, "description": "Required. A store identifier that is unique for the given merchant.", "type": "string" } @@ -9175,8 +10630,23 @@ }, "type": "object" }, + "PriceAmount": { + "description": "The price represented as a number and currency.", + "id": "PriceAmount", + "properties": { + "currency": { + "description": "The currency of the price.", + "type": "string" + }, + "value": { + "description": "The price represented as a number.", + "type": "string" + } + }, + "type": "object" + }, "Product": { - "description": "Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information.\n\nSome attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. \n\nProduct data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.", + "description": " Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.", "id": "Product", "properties": { "additionalImageLinks": { @@ -9202,7 +10672,7 @@ "type": "string" }, "adult": { - "description": "Set to true if the item is targeted towards adults.", + "description": "Should be set to true if the item is targeted towards adults.", "type": "boolean" }, "ageGroup": { @@ -9226,12 +10696,7 @@ "type": "string" }, "channel": { - "annotations": { - "required": [ - "content.products.insert" - ] - }, - "description": "Required. The item's channel (online or local).\n\nAcceptable values are: \n- \"`local`\" \n- \"`online`\"", + "description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" ", "type": "string" }, "color": { @@ -9243,11 +10708,6 @@ "type": "string" }, "contentLanguage": { - "annotations": { - "required": [ - "content.products.insert" - ] - }, "description": "Required. The two-letter ISO 639-1 language code for the item.", "type": "string" }, @@ -9256,7 +10716,7 @@ "description": "Cost of goods sold. Used for gross profit reporting." }, "customAttributes": { - "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Shopping Actions.", + "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).", "items": { "$ref": "CustomAttribute" }, @@ -9330,7 +10790,7 @@ "type": "string" }, "googleProductCategory": { - "description": "Google's category of the item (see Google product taxonomy).", + "description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.", "type": "string" }, "gtin": { @@ -9338,7 +10798,7 @@ "type": "string" }, "id": { - "description": "The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter.\nThe REST ID for a product is of the form channel:contentLanguage:targetCountry: offerId.", + "description": "The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.", "type": "string" }, "identifierExists": { @@ -9369,7 +10829,6 @@ "type": "string" }, "kind": { - "default": "content#product", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\"", "type": "string" }, @@ -9417,12 +10876,7 @@ "type": "string" }, "offerId": { - "annotations": { - "required": [ - "content.products.insert" - ] - }, - "description": "Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details.\nNote: Content API methods that operate on products take the REST ID of the product, not this identifier.", + "description": "Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.", "type": "string" }, "pattern": { @@ -9466,7 +10920,7 @@ "description": "Advertised sale price of the item." }, "salePriceEffectiveDate": { - "description": "Date range during which the item is on sale (see products data specification).", + "description": "Date range during which the item is on sale (see products data specification ).", "type": "string" }, "sellOnGoogleQuantity": { @@ -9524,7 +10978,7 @@ "type": "array" }, "source": { - "description": "The source of the offer, i.e., how the offer was created.\n\nAcceptable values are: \n- \"`api`\" \n- \"`crawl`\" \n- \"`feed`\"", + "description": "The source of the offer, i.e., how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", "type": "string" }, "subscriptionCost": { @@ -9532,11 +10986,6 @@ "description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract." }, "targetCountry": { - "annotations": { - "required": [ - "content.products.insert" - ] - }, "description": "Required. The CLDR territory code for the item.", "type": "string" }, @@ -9698,7 +11147,6 @@ "type": "array" }, "kind": { - "default": "content#productStatus", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productStatus`\"", "type": "string" }, @@ -9846,7 +11294,7 @@ "type": "string" }, "taxShip": { - "description": "Set to true if tax is charged on shipping.", + "description": "Should be set to true if tax is charged on shipping.", "type": "boolean" } }, @@ -9915,7 +11363,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`delete`\" \n- \"`get`\" \n- \"`insert`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ", "type": "string" }, "product": { @@ -9940,7 +11388,6 @@ "type": "array" }, "kind": { - "default": "content#productsCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsCustomBatchResponse\".", "type": "string" } @@ -9961,7 +11408,6 @@ "description": "A list of errors defined if and only if the request failed." }, "kind": { - "default": "content#productsCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponseEntry`\"", "type": "string" }, @@ -9976,7 +11422,6 @@ "id": "ProductsListResponse", "properties": { "kind": { - "default": "content#productsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productsListResponse\".", "type": "string" }, @@ -10031,7 +11476,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`get`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ", "type": "string" }, "productId": { @@ -10052,7 +11497,6 @@ "type": "array" }, "kind": { - "default": "content#productstatusesCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesCustomBatchResponse\".", "type": "string" } @@ -10073,7 +11517,6 @@ "description": "A list of errors, if the request failed." }, "kind": { - "default": "content#productstatusesCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponseEntry`\"", "type": "string" }, @@ -10088,7 +11531,6 @@ "id": "ProductstatusesListResponse", "properties": { "kind": { - "default": "content#productstatusesListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#productstatusesListResponse\".", "type": "string" }, @@ -10106,7 +11548,7 @@ "type": "object" }, "PubsubNotificationSettings": { - "description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account. (== resource_for v2.1.pubsubnotificationsettings ==)", + "description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.", "id": "PubsubNotificationSettings", "properties": { "cloudTopicName": { @@ -10114,12 +11556,11 @@ "type": "string" }, "kind": { - "default": "content#pubsubNotificationSettings", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#pubsubNotificationSettings`\"", "type": "string" }, "registeredEvents": { - "description": "List of event types.\n\nAcceptable values are: \n- \"`orderPendingShipment`\"", + "description": "List of event types. Acceptable values are: - \"`orderPendingShipment`\" ", "items": { "type": "string" }, @@ -10175,7 +11616,95 @@ "type": "string" }, "reasonCode": { - "description": "Code of the refund reason.\n\nAcceptable values are: \n- \"`adjustment`\" \n- \"`autoPostInternal`\" \n- \"`autoPostInvalidBillingAddress`\" \n- \"`autoPostNoInventory`\" \n- \"`autoPostPriceError`\" \n- \"`autoPostUndeliverableShippingAddress`\" \n- \"`couponAbuse`\" \n- \"`courtesyAdjustment`\" \n- \"`customerCanceled`\" \n- \"`customerDiscretionaryReturn`\" \n- \"`customerInitiatedMerchantCancel`\" \n- \"`customerSupportRequested`\" \n- \"`deliveredLateByCarrier`\" \n- \"`deliveredTooLate`\" \n- \"`expiredItem`\" \n- \"`failToPushOrderGoogleError`\" \n- \"`failToPushOrderMerchantError`\" \n- \"`failToPushOrderMerchantFulfillmentError`\" \n- \"`failToPushOrderToMerchant`\" \n- \"`failToPushOrderToMerchantOutOfStock`\" \n- \"`feeAdjustment`\" \n- \"`invalidCoupon`\" \n- \"`lateShipmentCredit`\" \n- \"`malformedShippingAddress`\" \n- \"`merchantDidNotShipOnTime`\" \n- \"`noInventory`\" \n- \"`orderTimeout`\" \n- \"`other`\" \n- \"`paymentAbuse`\" \n- \"`paymentDeclined`\" \n- \"`priceAdjustment`\" \n- \"`priceError`\" \n- \"`productArrivedDamaged`\" \n- \"`productNotAsDescribed`\" \n- \"`promoReallocation`\" \n- \"`qualityNotAsExpected`\" \n- \"`returnRefundAbuse`\" \n- \"`shippingCostAdjustment`\" \n- \"`shippingPriceError`\" \n- \"`taxAdjustment`\" \n- \"`taxError`\" \n- \"`undeliverableShippingAddress`\" \n- \"`unsupportedPoBoxAddress`\" \n- \"`wrongProductShipped`\"", + "description": "Code of the refund reason. Acceptable values are: - \"`adjustment`\" - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`courtesyAdjustment`\" - \"`customerCanceled`\" - \"`customerDiscretionaryReturn`\" - \"`customerInitiatedMerchantCancel`\" - \"`customerSupportRequested`\" - \"`deliveredLateByCarrier`\" - \"`deliveredTooLate`\" - \"`expiredItem`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`feeAdjustment`\" - \"`invalidCoupon`\" - \"`lateShipmentCredit`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceAdjustment`\" - \"`priceError`\" - \"`productArrivedDamaged`\" - \"`productNotAsDescribed`\" - \"`promoReallocation`\" - \"`qualityNotAsExpected`\" - \"`returnRefundAbuse`\" - \"`shippingCostAdjustment`\" - \"`shippingPriceError`\" - \"`taxAdjustment`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`wrongProductShipped`\" ", + "type": "string" + } + }, + "type": "object" + }, + "Region": { + "description": "Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.", + "id": "Region", + "properties": { + "displayName": { + "description": "The display name of the region.", + "type": "string" + }, + "geotargetArea": { + "$ref": "RegionGeoTargetArea", + "description": "A list of geotargets that defines the region area." + }, + "merchantId": { + "description": "Output only. Immutable. Merchant that owns the region.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "postalCodeArea": { + "$ref": "RegionPostalCodeArea", + "description": "A list of postal codes that defines the region area." + }, + "regionId": { + "description": "Output only. Immutable. The ID uniquely identifying each region.", + "readOnly": true, + "type": "string" + }, + "regionalInventoryEligible": { + "description": "Output only. Indicates if the region is eligible to use in the Regional Inventory configuration.", + "readOnly": true, + "type": "boolean" + }, + "shippingEligible": { + "description": "Output only. Indicates if the region is eligible to use in the Shipping Services configuration.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "RegionGeoTargetArea": { + "description": "A list of geotargets that defines the region area.", + "id": "RegionGeoTargetArea", + "properties": { + "geotargetCriteriaIds": { + "description": "Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionPostalCodeArea": { + "description": "A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource.", + "id": "RegionPostalCodeArea", + "properties": { + "postalCodes": { + "description": "Required. A range of postal codes.", + "items": { + "$ref": "RegionPostalCodeAreaPostalCodeRange" + }, + "type": "array" + }, + "regionCode": { + "description": "Required. CLDR territory code or the country the postal code group applies to.", + "type": "string" + } + }, + "type": "object" + }, + "RegionPostalCodeAreaPostalCodeRange": { + "description": "A range of postal codes that defines the region area.", + "id": "RegionPostalCodeAreaPostalCodeRange", + "properties": { + "begin": { + "description": "Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: \"94108\", \"9410*\", \"9*\".", + "type": "string" + }, + "end": { + "description": "Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.", "type": "string" } }, @@ -10197,7 +11726,6 @@ "type": "array" }, "kind": { - "default": "content#regionalInventory", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalInventory\".", "type": "string" }, @@ -10248,7 +11776,7 @@ "type": "string" }, "method": { - "description": "Method of the batch request entry.\n\nAcceptable values are: \n- \"`insert`\"", + "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ", "type": "string" }, "productId": { @@ -10273,7 +11801,6 @@ "type": "array" }, "kind": { - "default": "content#regionalinventoryCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponse\".", "type": "string" } @@ -10294,7 +11821,6 @@ "description": "A list of errors defined if and only if the request failed." }, "kind": { - "default": "content#regionalinventoryCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#regionalinventoryCustomBatchResponseEntry\".", "type": "string" }, @@ -10305,48 +11831,393 @@ }, "type": "object" }, + "RepricingProductReport": { + "description": "Resource that represents a daily Repricing product report. Each report contains stats for a single type of Repricing rule for a single product on a given day. If there are multiple rules of the same type for the product on that day, the report lists all the rules by rule ids, combines the stats, and paginates the results by date. To retrieve the stats of a particular rule, provide the rule_id in the request.", + "id": "RepricingProductReport", + "properties": { + "applicationCount": { + "description": "Total count of Repricer applications. This value captures how many times the rule of this type was applied to this product during this reporting period.", + "format": "int64", + "type": "string" + }, + "buyboxWinningProductStats": { + "$ref": "RepricingProductReportBuyboxWinningProductStats", + "description": "Stats specific to buybox winning rules for product report." + }, + "date": { + "$ref": "Date", + "description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone." + }, + "highWatermark": { + "$ref": "PriceAmount", + "description": "Maximum displayed price after repriced during this reporting period." + }, + "inapplicabilityDetails": { + "description": "List of all reasons the rule did not apply to the product during the specified reporting period.", + "items": { + "$ref": "InapplicabilityDetails" + }, + "type": "array" + }, + "lowWatermark": { + "$ref": "PriceAmount", + "description": "Minimum displayed price after repriced during this reporting period." + }, + "orderItemCount": { + "description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.", + "format": "int32", + "type": "integer" + }, + "ruleIds": { + "description": "Ids of the Repricing rule for this report.", + "items": { + "type": "string" + }, + "type": "array" + }, + "totalGmv": { + "$ref": "PriceAmount", + "description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed." + }, + "type": { + "description": "Type of the rule.", + "enum": [ + "REPRICING_RULE_TYPE_UNSPECIFIED", + "TYPE_STATS_BASED", + "TYPE_COGS_BASED" + ], + "enumDescriptions": [ + "Unused.", + "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.", + "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant." + ], + "type": "string" + } + }, + "type": "object" + }, + "RepricingProductReportBuyboxWinningProductStats": { + "description": "Stats specific to buybox winning rules for product report.", + "id": "RepricingProductReportBuyboxWinningProductStats", + "properties": { + "buyboxWinsCount": { + "description": "Number of times this product won the buybox with these rules during this time period.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RepricingRule": { + "description": "Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met. Next ID: 24", + "id": "RepricingRule", + "properties": { + "cogsBasedRule": { + "$ref": "RepricingRuleCostOfGoodsSaleRule", + "description": "The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED." + }, + "countryCode": { + "description": "Required. Immutable. CLDR country code (e.g. \"US\").", + "type": "string" + }, + "effectiveTimePeriod": { + "$ref": "RepricingRuleEffectiveTime", + "description": "Required. Time period when the rule should take effect." + }, + "eligibleOfferMatcher": { + "$ref": "RepricingRuleEligibleOfferMatcher", + "description": "Required. Match criteria for the eligible offers." + }, + "languageCode": { + "description": "Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.", + "type": "string" + }, + "merchantId": { + "description": "Output only. Immutable. Merchant that owns the repricing rule.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "paused": { + "description": "Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.", + "type": "boolean" + }, + "restriction": { + "$ref": "RepricingRuleRestriction", + "description": "Required. Restriction of the rule appliance." + }, + "ruleId": { + "description": "Output only. Immutable. The ID to uniquely identify each repricing rule.", + "readOnly": true, + "type": "string" + }, + "statsBasedRule": { + "$ref": "RepricingRuleStatsBasedRule", + "description": "The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED." + }, + "title": { + "description": "The title for the rule.", + "type": "string" + }, + "type": { + "description": "Required. Immutable. The type of the rule.", + "enum": [ + "REPRICING_RULE_TYPE_UNSPECIFIED", + "TYPE_STATS_BASED", + "TYPE_COGS_BASED" + ], + "enumDescriptions": [ + "Unused.", + "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.", + "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant." + ], + "type": "string" + } + }, + "type": "object" + }, + "RepricingRuleCostOfGoodsSaleRule": { + "description": "A repricing rule that changes the sale price based on cost of goods sale.", + "id": "RepricingRuleCostOfGoodsSaleRule", + "properties": { + "percentageDelta": { + "description": "The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.", + "format": "int32", + "type": "integer" + }, + "priceDelta": { + "description": "The price delta against the COGS. E.g. 2 means $2 more of the COGS.", + "type": "string" + } + }, + "type": "object" + }, + "RepricingRuleEffectiveTime": { + "id": "RepricingRuleEffectiveTime", + "properties": { + "fixedTimePeriods": { + "description": "A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.", + "items": { + "$ref": "RepricingRuleEffectiveTimeFixedTimePeriod" + }, + "type": "array" + } + }, + "type": "object" + }, + "RepricingRuleEffectiveTimeFixedTimePeriod": { + "description": "Definition of a fixed time period.", + "id": "RepricingRuleEffectiveTimeFixedTimePeriod", + "properties": { + "endTime": { + "description": "The end time (exclusive) of the period. It can only be hour granularity.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "The start time (inclusive) of the period. It can only be hour granularity.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RepricingRuleEligibleOfferMatcher": { + "description": "Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands.", + "id": "RepricingRuleEligibleOfferMatcher", + "properties": { + "brandMatcher": { + "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher", + "description": "Filter by the brand." + }, + "itemGroupIdMatcher": { + "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher", + "description": "Filter by the item group id." + }, + "matcherOption": { + "description": "Determines whether to use the custom matchers or the product feed attribute \"repricing_rule_id\" to specify offer-rule mapping.", + "enum": [ + "MATCHER_OPTION_UNSPECIFIED", + "MATCHER_OPTION_CUSTOM_FILTER", + "MATCHER_OPTION_USE_FEED_ATTRIBUTE", + "MATCHER_OPTION_ALL_PRODUCTS" + ], + "enumDescriptions": [ + "Unused.", + "Use custom filters.", + "Use repricing_rule_id feed attribute on the product resource to specify offer-rule mapping.", + "Matching all products." + ], + "type": "string" + }, + "offerIdMatcher": { + "$ref": "RepricingRuleEligibleOfferMatcherStringMatcher", + "description": "Filter by the offer id." + }, + "skipWhenOnPromotion": { + "description": "When true, the rule won't be applied to offers with active promotions.", + "type": "boolean" + } + }, + "type": "object" + }, + "RepricingRuleEligibleOfferMatcherStringMatcher": { + "description": "Matcher by string attributes.", + "id": "RepricingRuleEligibleOfferMatcherStringMatcher", + "properties": { + "strAttributes": { + "description": "String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regex.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RepricingRuleReport": { + "description": "Resource that represents a daily Repricing rule report. Next ID: 11", + "id": "RepricingRuleReport", + "properties": { + "buyboxWinningRuleStats": { + "$ref": "RepricingRuleReportBuyboxWinningRuleStats", + "description": "Stats specific to buybox winning rules for rule report." + }, + "date": { + "$ref": "Date", + "description": "Date of the stats in this report. The report starts and ends according to the merchant's timezone." + }, + "impactedProducts": { + "description": "List of product ids that are impacted by this rule during this reporting period. Out of stock products and products not searched for by customers are examples of non-impacted products.", + "items": { + "type": "string" + }, + "type": "array" + }, + "inapplicabilityDetails": { + "description": "List of all reasons the rule did not apply to the inapplicable products during the specified reporting period.", + "items": { + "$ref": "InapplicabilityDetails" + }, + "type": "array" + }, + "inapplicableProducts": { + "description": "List of product ids that are inapplicable to this rule during this reporting period. To get the inapplicable reason for a specific product, see RepricingProductReport.", + "items": { + "type": "string" + }, + "type": "array" + }, + "orderItemCount": { + "description": "Total unit count of impacted products ordered while the rule was active on the date of the report. This count includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed.", + "format": "int32", + "type": "integer" + }, + "ruleId": { + "description": "Id of the Repricing rule for this report.", + "type": "string" + }, + "totalGmv": { + "$ref": "PriceAmount", + "description": "Total GMV generated by impacted products while the rule was active on the date of the report. This value includes all orders that were started while the rule was active, even if the rule was no longer active when the order was completed." + }, + "type": { + "description": "Type of the rule.", + "enum": [ + "REPRICING_RULE_TYPE_UNSPECIFIED", + "TYPE_STATS_BASED", + "TYPE_COGS_BASED" + ], + "enumDescriptions": [ + "Unused.", + "Statistical measurement based rules among Google SA merchants. If this rule is chosen, repricer will adjust the offer price based on statistical metrics (currently only min is available) among other merchants who sell the same product. Details need to be provdided in the RuleDefinition.", + "Cost of goods sale based rule. Repricer will adjust the offer price based on the offer's sale cost which is provided by the merchant." + ], + "type": "string" + } + }, + "type": "object" + }, + "RepricingRuleReportBuyboxWinningRuleStats": { + "description": "Stats specific to buybox winning rules for rule report.", + "id": "RepricingRuleReportBuyboxWinningRuleStats", + "properties": { + "buyboxWonProductCount": { + "description": "Number of unique products that won the buybox with this rule during this period of time.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RepricingRuleRestriction": { + "description": "Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is \"-10\" and the floor.price_delta is \"-12\", the offer price will only be lowered $5 (10% lower than the original offer price).", + "id": "RepricingRuleRestriction", + "properties": { + "floor": { + "$ref": "RepricingRuleRestrictionBoundary", + "description": "The inclusive floor lower bound. The repricing rule only applies when new price >= floor." + }, + "useAutoPricingMinPrice": { + "description": "If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.", + "type": "boolean" + } + }, + "type": "object" + }, + "RepricingRuleRestrictionBoundary": { + "description": "Definition of a boundary.", + "id": "RepricingRuleRestrictionBoundary", + "properties": { + "percentageDelta": { + "description": "The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.", + "format": "int32", + "type": "integer" + }, + "priceDelta": { + "description": "The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.", + "type": "string" + } + }, + "type": "object" + }, + "RepricingRuleStatsBasedRule": { + "description": "Definition of stats based rule.", + "id": "RepricingRuleStatsBasedRule", + "properties": { + "percentageDelta": { + "description": "The percent change against the price target. Valid from 0 to 100 inclusively.", + "format": "int32", + "type": "integer" + }, + "priceDelta": { + "description": "The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.", + "type": "string" + } + }, + "type": "object" + }, "ReturnAddress": { "description": "Return address resource.", "id": "ReturnAddress", "properties": { "address": { "$ref": "ReturnAddressAddress", - "annotations": { - "required": [ - "content.returnaddress.insert" - ] - }, "description": "Required. The address." }, "country": { - "annotations": { - "required": [ - "content.returnaddress.insert" - ] - }, "description": "Required. The country of sale where the return address is applicable.", "type": "string" }, "kind": { - "default": "content#returnAddress", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnAddress`\"", "type": "string" }, "label": { - "annotations": { - "required": [ - "content.returnaddress.insert" - ] - }, "description": "Required. The user-defined label of the return address. For the default address, use the label \"default\".", "type": "string" }, "phoneNumber": { - "annotations": { - "required": [ - "content.returnaddress.insert" - ] - }, "description": "Required. The merchant's contact phone number regarding the return.", "type": "string" }, @@ -10395,34 +12266,18 @@ "id": "ReturnPolicy", "properties": { "country": { - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. The country of sale where the return policy is applicable.", "type": "string" }, "kind": { - "default": "content#returnPolicy", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnPolicy`\"", "type": "string" }, "label": { - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. The user-defined label of the return policy. For the default policy, use the label \"default\".", "type": "string" }, "name": { - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. The name of the policy as shown in Merchant Center.", "type": "string" }, @@ -10435,11 +12290,6 @@ }, "policy": { "$ref": "ReturnPolicyPolicy", - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. The policy." }, "returnPolicyId": { @@ -10460,11 +12310,6 @@ "id": "ReturnPolicyPolicy", "properties": { "lastReturnDate": { - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. Last day for returning the items. In ISO 8601 format. When specifying the return window like this, set the policy type to \"lastReturnDate\". Use this for seasonal overrides only.", "type": "string" }, @@ -10474,7 +12319,7 @@ "type": "string" }, "type": { - "description": "Policy type. Use \"lastReturnDate\" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items.\n\nAcceptable values are: \n- \"`lastReturnDate`\" \n- \"`lifetimeReturns`\" \n- \"`noReturns`\" \n- \"`numberOfDaysAfterDelivery`\"", + "description": "Policy type. Use \"lastReturnDate\" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items. Acceptable values are: - \"`lastReturnDate`\" - \"`lifetimeReturns`\" - \"`noReturns`\" - \"`numberOfDaysAfterDelivery`\" ", "type": "string" } }, @@ -10484,38 +12329,18 @@ "id": "ReturnPolicySeasonalOverride", "properties": { "endDate": { - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. Last day on which the override applies. In ISO 8601 format.", "type": "string" }, "name": { - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. The name of the seasonal override as shown in Merchant Center.", "type": "string" }, "policy": { "$ref": "ReturnPolicyPolicy", - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. The policy which is in effect during that time." }, "startDate": { - "annotations": { - "required": [ - "content.returnpolicy.insert" - ] - }, "description": "Required. First day on which the override applies. In ISO 8601 format.", "type": "string" } @@ -10560,7 +12385,7 @@ "type": "string" }, "returnMethodType": { - "description": "Type of the return method.\n\nAcceptable values are: \n- \"`byMail`\" \n- \"`contactCustomerSupport`\" \n- \"`returnless`\"", + "description": "Type of the return method. Acceptable values are: - \"`byMail`\" - \"`contactCustomerSupport`\" - \"`returnless`\" - \"`inStore`\" ", "type": "string" }, "shipmentId": { @@ -10579,7 +12404,7 @@ "type": "string" }, "state": { - "description": "State of the shipment.\n\nAcceptable values are: \n- \"`completed`\" \n- \"`new`\" \n- \"`shipped`\" \n- \"`undeliverable`\" \n- \"`pending`\"", + "description": "State of the shipment. Acceptable values are: - \"`completed`\" - \"`new`\" - \"`shipped`\" - \"`undeliverable`\" - \"`pending`\" ", "type": "string" } }, @@ -10612,15 +12437,15 @@ "type": "string" }, "method": { - "description": "Method of the batch request entry.\n\nAcceptable values are: \n- \"`delete`\" \n- \"`get`\" \n- \"`insert`\"", + "description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ", "type": "string" }, "returnAddress": { "$ref": "ReturnAddress", - "description": "The return address to submit. Set this only if the method is `insert`." + "description": "The return address to submit. This should be set only if the method is `insert`." }, "returnAddressId": { - "description": "The return address ID. Set this only if the method is `delete` or `get`.", + "description": "The return address ID. This should be set only if the method is `delete` or `get`.", "type": "string" } }, @@ -10637,7 +12462,6 @@ "type": "array" }, "kind": { - "default": "content#returnaddressCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressCustomBatchResponse\".", "type": "string" } @@ -10657,7 +12481,6 @@ "description": "A list of errors defined if, and only if, the request failed." }, "kind": { - "default": "content#returnaddressCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnaddressCustomBatchResponseEntry`\"", "type": "string" }, @@ -10672,7 +12495,6 @@ "id": "ReturnaddressListResponse", "properties": { "kind": { - "default": "content#returnaddressListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnaddressListResponse\".", "type": "string" }, @@ -10716,15 +12538,15 @@ "type": "string" }, "method": { - "description": "Method of the batch request entry.\n\nAcceptable values are: \n- \"`delete`\" \n- \"`get`\" \n- \"`insert`\"", + "description": "Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" ", "type": "string" }, "returnPolicy": { "$ref": "ReturnPolicy", - "description": "The return policy to submit. Set this only if the method is `insert`." + "description": "The return policy to submit. This should be set only if the method is `insert`." }, "returnPolicyId": { - "description": "The return policy ID. Set this only if the method is `delete` or `get`.", + "description": "The return policy ID. This should be set only if the method is `delete` or `get`.", "type": "string" } }, @@ -10741,7 +12563,6 @@ "type": "array" }, "kind": { - "default": "content#returnpolicyCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyCustomBatchResponse\".", "type": "string" } @@ -10761,7 +12582,6 @@ "description": "A list of errors defined if, and only if, the request failed." }, "kind": { - "default": "content#returnpolicyCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#returnpolicyCustomBatchResponseEntry`\"", "type": "string" }, @@ -10776,7 +12596,6 @@ "id": "ReturnpolicyListResponse", "properties": { "kind": { - "default": "content#returnpolicyListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#returnpolicyListResponse\".", "type": "string" }, @@ -10822,7 +12641,7 @@ "description": "Time spent in various aspects from order to the delivery of the product. Required." }, "eligibility": { - "description": "Eligibility for this service.\n\nAcceptable values are: \n- \"`All scenarios`\" \n- \"`All scenarios except Shopping Actions`\" \n- \"`Shopping Actions`\"", + "description": "Eligibility for this service. Acceptable values are: - \"`All scenarios`\" - \"`All scenarios except Shopping Actions`\" - \"`Shopping Actions`\" ", "type": "string" }, "minimumOrderValue": { @@ -10849,14 +12668,14 @@ "type": "array" }, "shipmentType": { - "description": "Type of locations this service ships orders to.\n\nAcceptable values are: \n- \"`delivery`\" \n- \"`pickup`\"", + "description": "Type of locations this service ships orders to. Acceptable values are: - \"`delivery`\" - \"`pickup`\" ", "type": "string" } }, "type": "object" }, "SettlementReport": { - "description": "Settlement reports detail order-level and item-level credits and debits between you and Google.", + "description": " Settlement reports detail order-level and item-level credits and debits between you and Google.", "id": "SettlementReport", "properties": { "endDate": { @@ -10864,7 +12683,6 @@ "type": "string" }, "kind": { - "default": "content#settlementReport", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementReport`\"", "type": "string" }, @@ -10899,7 +12717,7 @@ "type": "object" }, "SettlementTransaction": { - "description": "Settlement transactions give a detailed breakdown of the settlement report. (== resource_for v2.1.settlementtransactions ==)", + "description": "Settlement transactions give a detailed breakdown of the settlement report.", "id": "SettlementTransaction", "properties": { "amount": { @@ -10911,7 +12729,6 @@ "description": "Identifiers of the transaction." }, "kind": { - "default": "content#settlementTransaction", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#settlementTransaction`\"", "type": "string" }, @@ -10929,7 +12746,7 @@ "$ref": "SettlementTransactionAmountCommission" }, "description": { - "description": "The description of the event.\n\nAcceptable values are: \n- \"`taxWithhold`\" \n- \"`principal`\" \n- \"`principalAdjustment`\" \n- \"`shippingFee`\" \n- \"`merchantRemittedSalesTax`\" \n- \"`googleRemittedSalesTax`\" \n- \"`merchantCoupon`\" \n- \"`merchantCouponTax`\" \n- \"`merchantRemittedDisposalTax`\" \n- \"`googleRemittedDisposalTax`\" \n- \"`merchantRemittedRedemptionFee`\" \n- \"`googleRemittedRedemptionFee`\" \n- \"`eeeEcoFee`\" \n- \"`furnitureEcoFee`\" \n- \"`copyPrivateFee`\" \n- \"`eeeEcoFeeCommission`\" \n- \"`furnitureEcoFeeCommission`\" \n- \"`copyPrivateFeeCommission`\" \n- \"`principalRefund`\" \n- \"`principalRefundTax`\" \n- \"`itemCommission`\" \n- \"`adjustmentCommission`\" \n- \"`shippingFeeCommission`\" \n- \"`commissionRefund`\" \n- \"`damaged`\" \n- \"`damagedOrDefectiveItem`\" \n- \"`expiredItem`\" \n- \"`faultyItem`\" \n- \"`incorrectItemReceived`\" \n- \"`itemMissing`\" \n- \"`qualityNotExpected`\" \n- \"`receivedTooLate`\" \n- \"`storePackageMissing`\" \n- \"`transitPackageMissing`\" \n- \"`unsuccessfulDeliveryUndeliverable`\" \n- \"`wrongChargeInStore`\" \n- \"`wrongItem`\" \n- \"`returns`\" \n- \"`undeliverable`\" \n- \"`refundFromMerchant`\" \n- \"`returnLabelShippingFee`\"", + "description": "The description of the event. Acceptable values are: - \"`taxWithhold`\" - \"`principal`\" - \"`principalAdjustment`\" - \"`shippingFee`\" - \"`merchantRemittedSalesTax`\" - \"`googleRemittedSalesTax`\" - \"`merchantCoupon`\" - \"`merchantCouponTax`\" - \"`merchantRemittedDisposalTax`\" - \"`googleRemittedDisposalTax`\" - \"`merchantRemittedRedemptionFee`\" - \"`googleRemittedRedemptionFee`\" - \"`eeeEcoFee`\" - \"`furnitureEcoFee`\" - \"`copyPrivateFee`\" - \"`eeeEcoFeeCommission`\" - \"`furnitureEcoFeeCommission`\" - \"`copyPrivateFeeCommission`\" - \"`principalRefund`\" - \"`principalRefundTax`\" - \"`itemCommission`\" - \"`adjustmentCommission`\" - \"`shippingFeeCommission`\" - \"`commissionRefund`\" - \"`damaged`\" - \"`damagedOrDefectiveItem`\" - \"`expiredItem`\" - \"`faultyItem`\" - \"`incorrectItemReceived`\" - \"`itemMissing`\" - \"`qualityNotExpected`\" - \"`receivedTooLate`\" - \"`storePackageMissing`\" - \"`transitPackageMissing`\" - \"`unsuccessfulDeliveryUndeliverable`\" - \"`wrongChargeInStore`\" - \"`wrongItem`\" - \"`returns`\" - \"`undeliverable`\" - \"`refundFromMerchant`\" - \"`returnLabelShippingFee`\" - \"`pspFee`\" ", "type": "string" }, "transactionAmount": { @@ -10937,7 +12754,7 @@ "description": "The amount that contributes to the line item price." }, "type": { - "description": "The type of the amount.\n\nAcceptable values are: \n- \"`itemPrice`\" \n- \"`orderPrice`\" \n- \"`refund`\" \n- \"`earlyRefund`\" \n- \"`courtesyRefund`\" \n- \"`returnRefund`\" \n- \"`returnLabelShippingFeeAmount`\"", + "description": "The type of the amount. Acceptable values are: - \"`itemPrice`\" - \"`orderPrice`\" - \"`refund`\" - \"`earlyRefund`\" - \"`courtesyRefund`\" - \"`returnRefund`\" - \"`returnLabelShippingFeeAmount`\" ", "type": "string" } }, @@ -10947,7 +12764,7 @@ "id": "SettlementTransactionAmountCommission", "properties": { "category": { - "description": "The category of the commission.\n\nAcceptable values are: \n- \"`animalsAndPetSupplies`\" \n- \"`dogCatFoodAndCatLitter`\" \n- \"`apparelAndAccessories`\" \n- \"`shoesHandbagsAndSunglasses`\" \n- \"`costumesAndAccessories`\" \n- \"`jewelry`\" \n- \"`watches`\" \n- \"`hobbiesArtsAndCrafts`\" \n- \"`homeAndGarden`\" \n- \"`entertainmentCollectibles`\" \n- \"`collectibleCoins`\" \n- \"`sportsCollectibles`\" \n- \"`sportingGoods`\" \n- \"`toysAndGames`\" \n- \"`musicalInstruments`\" \n- \"`giftCards`\" \n- \"`babyAndToddler`\" \n- \"`babyFoodWipesAndDiapers`\" \n- \"`businessAndIndustrial`\" \n- \"`camerasOpticsAndPhotography`\" \n- \"`consumerElectronics`\" \n- \"`electronicsAccessories`\" \n- \"`personalComputers`\" \n- \"`videoGameConsoles`\" \n- \"`foodAndGrocery`\" \n- \"`beverages`\" \n- \"`tobaccoProducts`\" \n- \"`furniture`\" \n- \"`hardware`\" \n- \"`buildingMaterials`\" \n- \"`tools`\" \n- \"`healthAndPersonalCare`\" \n- \"`beauty`\" \n- \"`householdSupplies`\" \n- \"`kitchenAndDining`\" \n- \"`majorAppliances`\" \n- \"`luggageAndBags`\" \n- \"`media`\" \n- \"`officeSupplies`\" \n- \"`softwareAndVideoGames`\" \n- \"`vehiclePartsAndAccessories`\" \n- \"`vehicleTiresAndWheels`\" \n- \"`vehicles`\" \n- \"`everythingElse`\"", + "description": "The category of the commission. Acceptable values are: - \"`animalsAndPetSupplies`\" - \"`dogCatFoodAndCatLitter`\" - \"`apparelAndAccessories`\" - \"`shoesHandbagsAndSunglasses`\" - \"`costumesAndAccessories`\" - \"`jewelry`\" - \"`watches`\" - \"`hobbiesArtsAndCrafts`\" - \"`homeAndGarden`\" - \"`entertainmentCollectibles`\" - \"`collectibleCoins`\" - \"`sportsCollectibles`\" - \"`sportingGoods`\" - \"`toysAndGames`\" - \"`musicalInstruments`\" - \"`giftCards`\" - \"`babyAndToddler`\" - \"`babyFoodWipesAndDiapers`\" - \"`businessAndIndustrial`\" - \"`camerasOpticsAndPhotography`\" - \"`consumerElectronics`\" - \"`electronicsAccessories`\" - \"`personalComputers`\" - \"`videoGameConsoles`\" - \"`foodAndGrocery`\" - \"`beverages`\" - \"`tobaccoProducts`\" - \"`furniture`\" - \"`hardware`\" - \"`buildingMaterials`\" - \"`tools`\" - \"`healthAndPersonalCare`\" - \"`beauty`\" - \"`householdSupplies`\" - \"`kitchenAndDining`\" - \"`majorAppliances`\" - \"`luggageAndBags`\" - \"`media`\" - \"`officeSupplies`\" - \"`softwareAndVideoGames`\" - \"`vehiclePartsAndAccessories`\" - \"`vehicleTiresAndWheels`\" - \"`vehicles`\" - \"`everythingElse`\" ", "type": "string" }, "rate": { @@ -10998,7 +12815,7 @@ "type": "string" }, "type": { - "description": "The type of the transaction that occurred.\n\nAcceptable values are: \n- \"`order`\" \n- \"`reversal`\" \n- \"`orderRefund`\" \n- \"`reversalRefund`\" \n- \"`issueRelatedRefundAndReplacement`\" \n- \"`returnLabelShippingFeeTransaction`\" \n- \"`reversalIssueRelatedRefundAndReplacement`\" \n- \"`reversalReturnLabelShippingFeeTransaction`\"", + "description": "The type of the transaction that occurred. Acceptable values are: - \"`order`\" - \"`reversal`\" - \"`orderRefund`\" - \"`reversalRefund`\" - \"`issueRelatedRefundAndReplacement`\" - \"`returnLabelShippingFeeTransaction`\" - \"`reversalIssueRelatedRefundAndReplacement`\" - \"`reversalReturnLabelShippingFeeTransaction`\" ", "type": "string" } }, @@ -11008,7 +12825,6 @@ "id": "SettlementreportsListResponse", "properties": { "kind": { - "default": "content#settlementreportsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementreportsListResponse\".", "type": "string" }, @@ -11029,7 +12845,6 @@ "id": "SettlementtransactionsListResponse", "properties": { "kind": { - "default": "content#settlementtransactionsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#settlementtransactionsListResponse\".", "type": "string" }, @@ -11096,7 +12911,7 @@ "id": "ShipmentTrackingInfo", "properties": { "carrier": { - "description": "The shipping carrier that handles the package.\n\nAcceptable values are: \n- \"`boxtal`\" \n- \"`bpost`\" \n- \"`chronopost`\" \n- \"`colisPrive`\" \n- \"`colissimo`\" \n- \"`cxt`\" \n- \"`deliv`\" \n- \"`dhl`\" \n- \"`dpd`\" \n- \"`dynamex`\" \n- \"`eCourier`\" \n- \"`easypost`\" \n- \"`efw`\" \n- \"`fedex`\" \n- \"`fedexSmartpost`\" \n- \"`geodis`\" \n- \"`gls`\" \n- \"`googleCourier`\" \n- \"`gsx`\" \n- \"`jdLogistics`\" \n- \"`laPoste`\" \n- \"`lasership`\" \n- \"`manual`\" \n- \"`mpx`\" \n- \"`onTrac`\" \n- \"`other`\" \n- \"`tnt`\" \n- \"`uds`\" \n- \"`ups`\" \n- \"`usps`\"", + "description": "The shipping carrier that handles the package. Acceptable values are: - \"`boxtal`\" - \"`bpost`\" - \"`chronopost`\" - \"`colisPrive`\" - \"`colissimo`\" - \"`cxt`\" - \"`deliv`\" - \"`dhl`\" - \"`dpd`\" - \"`dynamex`\" - \"`eCourier`\" - \"`easypost`\" - \"`efw`\" - \"`fedex`\" - \"`fedexSmartpost`\" - \"`geodis`\" - \"`gls`\" - \"`googleCourier`\" - \"`gsx`\" - \"`jdLogistics`\" - \"`laPoste`\" - \"`lasership`\" - \"`manual`\" - \"`mpx`\" - \"`onTrac`\" - \"`other`\" - \"`tnt`\" - \"`uds`\" - \"`ups`\" - \"`usps`\" ", "type": "string" }, "trackingNumber": { @@ -11165,7 +12980,7 @@ "type": "string" }, "method": { - "description": "The method of the batch entry.\n\nAcceptable values are: \n- \"`get`\" \n- \"`update`\"", + "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ", "type": "string" }, "shippingSettings": { @@ -11186,7 +13001,6 @@ "type": "array" }, "kind": { - "default": "content#shippingsettingsCustomBatchResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsCustomBatchResponse\".", "type": "string" } @@ -11207,7 +13021,6 @@ "description": "A list of errors defined if, and only if, the request failed." }, "kind": { - "default": "content#shippingsettingsCustomBatchResponseEntry", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponseEntry`\"", "type": "string" }, @@ -11229,7 +13042,6 @@ "type": "array" }, "kind": { - "default": "content#shippingsettingsGetSupportedCarriersResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedCarriersResponse\".", "type": "string" } @@ -11247,7 +13059,6 @@ "type": "array" }, "kind": { - "default": "content#shippingsettingsGetSupportedHolidaysResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedHolidaysResponse\".", "type": "string" } @@ -11258,7 +13069,6 @@ "id": "ShippingsettingsGetSupportedPickupServicesResponse", "properties": { "kind": { - "default": "content#shippingsettingsGetSupportedPickupServicesResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsGetSupportedPickupServicesResponse\".", "type": "string" }, @@ -11276,7 +13086,6 @@ "id": "ShippingsettingsListResponse", "properties": { "kind": { - "default": "content#shippingsettingsListResponse", "description": "Identifies what kind of resource this is. Value: the fixed string \"content#shippingsettingsListResponse\".", "type": "string" }, @@ -11330,16 +13139,10 @@ "type": "boolean" }, "kind": { - "default": "content#testOrder", "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#testOrder`\"", "type": "string" }, "lineItems": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Line items that are ordered. At least one line item must be provided.", "items": { "$ref": "TestOrderLineItem" @@ -11355,34 +13158,19 @@ "description": "Overrides the predefined pickup details if provided." }, "predefinedBillingAddress": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. The billing address.\n\nAcceptable values are: \n- \"`dwight`\" \n- \"`jim`\" \n- \"`pam`\"", + "description": "Required. The billing address. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ", "type": "string" }, "predefinedDeliveryAddress": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. Identifier of one of the predefined delivery addresses for the delivery.\n\nAcceptable values are: \n- \"`dwight`\" \n- \"`jim`\" \n- \"`pam`\"", + "description": "Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ", "type": "string" }, "predefinedEmail": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. Email address of the customer.\n\nAcceptable values are: \n- \"`pog.dwight.schrute@gmail.com`\" \n- \"`pog.jim.halpert@gmail.com`\" \n- \"`penpog.pam.beesly@gmail.comding`\"", + "description": "Required. Email address of the customer. Acceptable values are: - \"`pog.dwight.schrute@gmail.com`\" - \"`pog.jim.halpert@gmail.com`\" - \"`penpog.pam.beesly@gmail.comding`\" ", "type": "string" }, "predefinedPickupDetails": { - "description": "Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`.\n\nAcceptable values are: \n- \"`dwight`\" \n- \"`jim`\" \n- \"`pam`\"", + "description": "Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`. Acceptable values are: - \"`dwight`\" - \"`jim`\" - \"`pam`\" ", "type": "string" }, "promotions": { @@ -11394,20 +13182,10 @@ }, "shippingCost": { "$ref": "Price", - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. The price of shipping for all items. Shipping tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied. Note that shipping is not taxed in certain states." }, "shippingOption": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. The requested shipping option.\n\nAcceptable values are: \n- \"`economy`\" \n- \"`expedited`\" \n- \"`oneDay`\" \n- \"`sameDay`\" \n- \"`standard`\" \n- \"`twoDay`\"", + "description": "Required. The requested shipping option. Acceptable values are: - \"`economy`\" - \"`expedited`\" - \"`oneDay`\" - \"`sameDay`\" - \"`standard`\" - \"`twoDay`\" ", "type": "string" } }, @@ -11421,7 +13199,7 @@ "type": "string" }, "fullAddress": { - "description": "Strings representing the lines of the printed label for mailing the order, for example:\nJohn Smith\n1600 Amphitheatre Parkway\nMountain View, CA, 94043\nUnited States", + "description": "Strings representing the lines of the printed label for mailing the order, for example: John Smith 1600 Amphitheatre Parkway Mountain View, CA, 94043 United States ", "items": { "type": "string" }, @@ -11464,6 +13242,10 @@ "$ref": "TestOrderAddress", "description": "The delivery address" }, + "isScheduledDelivery": { + "description": "Whether the order is scheduled delivery order.", + "type": "boolean" + }, "phoneNumber": { "description": "The phone number of the person receiving the delivery.", "type": "string" @@ -11479,31 +13261,16 @@ "description": "Required. Product data from the time of the order placement." }, "quantityOrdered": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Number of items ordered.", "format": "uint32", "type": "integer" }, "returnInfo": { "$ref": "OrderLineItemReturnInfo", - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Details of the return policy for the line item." }, "shippingDetails": { "$ref": "OrderLineItemShippingDetails", - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Details of the requested shipping for the line item." } }, @@ -11513,30 +13280,15 @@ "id": "TestOrderLineItemProduct", "properties": { "brand": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. Brand of the item.", "type": "string" }, "condition": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. Condition or state of the item.\n\nAcceptable values are: \n- \"`new`\"", + "description": "Required. Condition or state of the item. Acceptable values are: - \"`new`\" ", "type": "string" }, "contentLanguage": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. The two-letter ISO 639-1 language code for the item.\n\nAcceptable values are: \n- \"`en`\" \n- \"`fr`\"", + "description": "Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - \"`en`\" - \"`fr`\" ", "type": "string" }, "fees": { @@ -11551,11 +13303,6 @@ "type": "string" }, "imageLink": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. URL of an image of the item.", "type": "string" }, @@ -11568,38 +13315,18 @@ "type": "string" }, "offerId": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. An identifier of the item.", "type": "string" }, "price": { "$ref": "Price", - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied." }, "targetCountry": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, - "description": "Required. The CLDR territory code of the target country of the product.", + "description": "Required. The CLDR territory // code of the target country of the product.", "type": "string" }, "title": { - "annotations": { - "required": [ - "content.orders.createtestorder" - ] - }, "description": "Required. The title of the product.", "type": "string" }, @@ -11625,7 +13352,7 @@ "description": "Required. Pickup location address." }, "pickupLocationType": { - "description": "Pickup location type.\n\nAcceptable values are: \n- \"`locker`\" \n- \"`store`\" \n- \"`curbside`\"", + "description": "Pickup location type. Acceptable values are: - \"`locker`\" - \"`store`\" - \"`curbside`\" ", "type": "string" }, "pickupPersons": { @@ -11652,6 +13379,21 @@ }, "type": "object" }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "type": "string" + } + }, + "type": "object" + }, "TransitTable": { "id": "TransitTable", "properties": { @@ -11738,7 +13480,7 @@ "description": "[required] Amount of the additional charge." }, "type": { - "description": "[required] Type of the additional charge.\n\nAcceptable values are: \n- \"`shipping`\"", + "description": "[required] Type of the additional charge. Acceptable values are: - \"`shipping`\" ", "type": "string" } }, @@ -11756,7 +13498,7 @@ "type": "string" }, "taxType": { - "description": "[required] Type of the tax.\n\nAcceptable values are: \n- \"`otherFee`\" \n- \"`otherFeeTax`\" \n- \"`sales`\"", + "description": "[required] Type of the tax. Acceptable values are: - \"`otherFee`\" - \"`otherFeeTax`\" - \"`sales`\" ", "type": "string" } }, @@ -11793,7 +13535,7 @@ "id": "Weight", "properties": { "unit": { - "description": "Required. The weight unit.\n\nAcceptable values are: \n- \"`kg`\" \n- \"`lb`\"", + "description": "Required. The weight unit. Acceptable values are: - \"`kg`\" - \"`lb`\" ", "type": "string" }, "value": { @@ -11804,7 +13546,7 @@ "type": "object" } }, - "servicePath": "content/v2.1/", + "servicePath": "", "title": "Content API for Shopping", "version": "v2.1" } \ No newline at end of file
diff --git a/discovery/googleapis/customsearch__v1.json b/discovery/googleapis/customsearch__v1.json index c1bec65..8d660a4 100644 --- a/discovery/googleapis/customsearch__v1.json +++ b/discovery/googleapis/customsearch__v1.json
@@ -671,7 +671,7 @@ } } }, - "revision": "20201007", + "revision": "20210203", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": {
diff --git a/discovery/googleapis_beta/datafusion__v1beta1.json b/discovery/googleapis/datafusion__v1.json similarity index 94% rename from discovery/googleapis_beta/datafusion__v1beta1.json rename to discovery/googleapis/datafusion__v1.json index 9573836..5320cd8 100644 --- a/discovery/googleapis_beta/datafusion__v1beta1.json +++ b/discovery/googleapis/datafusion__v1.json
@@ -19,7 +19,7 @@ "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "id": "datafusion:v1beta1", + "id": "datafusion:v1", "kind": "discovery#restDescription", "name": "datafusion", "ownerDomain": "google.com", @@ -123,7 +123,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Location" }, @@ -168,7 +168,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}/locations", + "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, @@ -201,7 +201,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/instances", + "path": "v1/{+parent}/instances", "request": { "$ref": "Instance" }, @@ -228,7 +228,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -252,7 +252,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Instance" }, @@ -282,7 +282,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", "response": { "$ref": "Policy" }, @@ -327,7 +327,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/instances", + "path": "v1/{+parent}/instances", "response": { "$ref": "ListInstancesResponse" }, @@ -351,13 +351,13 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels and options currently) will be overwritten.", + "description": "Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "request": { "$ref": "Instance" }, @@ -384,7 +384,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}:restart", + "path": "v1/{+name}:restart", "request": { "$ref": "RestartInstanceRequest" }, @@ -411,7 +411,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, @@ -438,7 +438,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, @@ -448,33 +448,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "upgrade": { - "description": "Upgrade a single Data Fusion instance. At the end of an operation instance is fully upgraded.", - "httpMethod": "POST", - "id": "datafusion.projects.locations.instances.upgrade", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Name of the Data Fusion instance which need to be upgraded in the form of projects/{project}/locations/{location}/instances/{instance} Instance will be upgraded with the latest stable version of the Data Fusion.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:upgrade", - "request": { - "$ref": "UpgradeInstanceRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -496,7 +469,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1/{+name}:cancel", "request": { "$ref": "CancelOperationRequest" }, @@ -523,7 +496,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Empty" }, @@ -547,7 +520,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -587,7 +560,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}/operations", + "path": "v1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, @@ -631,7 +604,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/versions", + "path": "v1/{+parent}/versions", "response": { "$ref": "ListAvailableVersionsResponse" }, @@ -646,7 +619,7 @@ } } }, - "revision": "20201001", + "revision": "20210121", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -666,6 +639,22 @@ "Cloud Healthcare accelerator for CDF. This accelerator is to enable Cloud Healthcare specific CDF plugins developed by Healthcare team." ], "type": "string" + }, + "state": { + "description": "The state of the accelerator", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "UNKNOWN" + ], + "enumDescriptions": [ + "Default value, do not use", + "Indicates that the accelerator is enabled and available to use", + "Indicates that the accelerator is disabled and not available to use", + "Indicates that accelerator state is currently unknown. Requests for enable, disable could be retried while in this state" + ], + "type": "string" } }, "type": "object" @@ -722,10 +711,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -837,7 +822,7 @@ "additionalProperties": { "type": "string" }, - "description": "The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.", + "description": "The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels.", "type": "object" }, "name": { @@ -880,7 +865,7 @@ "enum": [ "STATE_UNSPECIFIED", "CREATING", - "RUNNING", + "ACTIVE", "FAILED", "DELETING", "UPGRADING", @@ -892,7 +877,7 @@ "enumDescriptions": [ "Instance does not have a state yet", "Instance is being created", - "Instance is running and ready for requests", + "Instance is active and ready for requests. This corresponds to 'RUNNING' in datafusion.v1beta1.", "Instance creation failed", "Instance is being deleted", "Instance is being upgraded", @@ -937,11 +922,11 @@ "type": "string" }, "version": { - "description": "Current version of Data Fusion.", + "description": "Current version of the Data Fusion. Only specifiable in Update.", "type": "string" }, "zone": { - "description": "Name of the zone in which the Data Fusion instance will be created.", + "description": "Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.", "type": "string" } }, @@ -1065,7 +1050,7 @@ "id": "NetworkConfig", "properties": { "ipAllocation": { - "description": "The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network.", + "description": "The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the customer network.", "type": "string" }, "network": { @@ -1114,6 +1099,13 @@ "description": "Represents the metadata of a long-running operation.", "id": "OperationMetadata", "properties": { + "additionalStatus": { + "additionalProperties": { + "type": "string" + }, + "description": "Map to hold any additonal status info for the operation If there is an accelerator being enabled/disabled/deleted, this will be populated with accelerator name as key and status as ENABLING, DISABLING or DELETING", + "type": "object" + }, "apiVersion": { "description": "API version used to start the operation.", "type": "string" @@ -1255,14 +1247,8 @@ }, "type": "object" }, - "UpgradeInstanceRequest": { - "description": "Request message for upgrading a Data Fusion instance. To change the instance properties, instance update should be used.", - "id": "UpgradeInstanceRequest", - "properties": {}, - "type": "object" - }, "Version": { - "description": "The Data Fusion version.", + "description": "The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.", "id": "Version", "properties": { "availableFeatures": { @@ -1286,6 +1272,6 @@ }, "servicePath": "", "title": "Cloud Data Fusion API", - "version": "v1beta1", + "version": "v1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis/dataproc__v1.json b/discovery/googleapis/dataproc__v1.json index dec8ccf..8a2f2f5 100644 --- a/discovery/googleapis/dataproc__v1.json +++ b/discovery/googleapis/dataproc__v1.json
@@ -1039,6 +1039,49 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "injectCredentials": { + "description": "Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC.", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.injectCredentials", + "parameterOrder": [ + "project", + "region", + "cluster" + ], + "parameters": { + "cluster": { + "description": "Required. The cluster, in the form clusters/.", + "location": "path", + "pattern": "^clusters/[^/]+$", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to, of the form projects/.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The region containing the cluster, of the form regions/.", + "location": "path", + "pattern": "^regions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+project}/{+region}/{+cluster}:injectCredentials", + "request": { + "$ref": "InjectCredentialsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all regions/{region}/clusters in a project alphabetically.", "httpMethod": "GET", @@ -2070,7 +2113,7 @@ } } }, - "revision": "20200925", + "revision": "20210121", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2179,10 +2222,6 @@ "description": "Associates members with a role.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -2265,7 +2304,7 @@ "description": "Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset." }, "configBucket": { - "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).", + "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.", "type": "string" }, "encryptionConfig": { @@ -2308,7 +2347,7 @@ "description": "Optional. The config settings for software inside the cluster." }, "tempBucket": { - "description": "Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket.", + "description": "Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket. This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket.", "type": "string" }, "workerConfig": { @@ -2559,7 +2598,7 @@ "type": "integer" }, "bootDiskType": { - "description": "Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive).", + "description": "Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-balanced\" (Persistent Disk Balanced Solid State Drive), \"pd-ssd\" (Persistent Disk Solid State Drive), or \"pd-standard\" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).", "type": "string" }, "numLocalSsds": { @@ -2683,6 +2722,10 @@ }, "type": "array" }, + "shieldedInstanceConfig": { + "$ref": "ShieldedInstanceConfig", + "description": "Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm)." + }, "subnetworkUri": { "description": "Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0 projects/[project_id]/regions/us-east1/subnetworks/sub0 sub0", "type": "string" @@ -2818,6 +2861,21 @@ }, "type": "object" }, + "InjectCredentialsRequest": { + "description": "A request to inject credentials into a cluster.", + "id": "InjectCredentialsRequest", + "properties": { + "clusterUuid": { + "description": "Required. The cluster UUID.", + "type": "string" + }, + "credentialsCiphertext": { + "description": "Required. The encrypted credentials being injected in to the cluster.The client is responsible for encrypting the credentials in a way that is supported by the cluster.A wrapped value is used here so that the actual contents of the encrypted credentials are not written to audit logs.", + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupAutoscalingPolicyConfig": { "description": "Configuration for the size bounds of an instance group, including its proportional size to other groups.", "id": "InstanceGroupAutoscalingPolicyConfig", @@ -2926,6 +2984,10 @@ "instanceName": { "description": "The user-friendly name of the Compute Engine instance.", "type": "string" + }, + "publicKey": { + "description": "The public key used for sharing data with this instance.", + "type": "string" } }, "type": "object" @@ -3119,6 +3181,11 @@ "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.", "format": "int32", "type": "integer" + }, + "maxFailuresTotal": { + "description": "Optional. Maximum number of times in total a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. Maximum value is 240.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -3228,7 +3295,7 @@ "type": "string" }, "kmsKeyUri": { - "description": "Required. The uri of the KMS key used to encrypt various sensitive files.", + "description": "Optional. The uri of the KMS key used to encrypt various sensitive files.", "type": "string" }, "realm": { @@ -3236,7 +3303,7 @@ "type": "string" }, "rootPrincipalPasswordUri": { - "description": "Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.", + "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.", "type": "string" }, "tgtLifetimeHours": { @@ -3270,7 +3337,7 @@ "type": "string" }, "idleDeleteTtl": { - "description": "Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).", + "description": "Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).", "format": "google-duration", "type": "string" }, @@ -3460,7 +3527,7 @@ "id": "NodeGroupAffinity", "properties": { "nodeGroupUri": { - "description": "Required. The name of a single node group (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) a cluster will be created on.", + "description": "Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-central1-a/nodeGroups/node-group-1 projects/[project_id]/zones/us-central1-a/nodeGroups/node-group-1 node-group-1", "type": "string" } }, @@ -3843,6 +3910,25 @@ }, "type": "object" }, + "ShieldedInstanceConfig": { + "description": "Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm).", + "id": "ShieldedInstanceConfig", + "properties": { + "enableIntegrityMonitoring": { + "description": "Optional. Defines whether instances have integrity monitoring enabled.", + "type": "boolean" + }, + "enableSecureBoot": { + "description": "Optional. Defines whether instances have Secure Boot enabled.", + "type": "boolean" + }, + "enableVtpm": { + "description": "Optional. Defines whether instances have the vTPM enabled.", + "type": "boolean" + } + }, + "type": "object" + }, "SoftwareConfig": { "description": "Specifies the selection and config of software inside the cluster.", "id": "SoftwareConfig", @@ -3869,7 +3955,7 @@ ], "enumDescriptions": [ "Unspecified component. Specifying this will cause Cluster creation to fail.", - "The Anaconda python distribution.", + "The Anaconda python distribution. The Anaconda component is not supported in the Dataproc preview 2.0 image. The 2.0 preview image is pre-installed with Miniconda.", "Docker", "Flink", "The Hive Web HCatalog (the REST service for accessing HCatalog).", @@ -4175,6 +4261,24 @@ "description": "Output only. The create cluster operation metadata.", "readOnly": true }, + "dagEndTime": { + "description": "Output only. DAG end time, only set for workflows with dag_timeout when DAG ends.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dagStartTime": { + "description": "Output only. DAG start time, only set for workflows with dag_timeout when DAG begins.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dagTimeout": { + "description": "Output only. The timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, "deleteCluster": { "$ref": "ClusterOperation", "description": "Output only. The delete cluster operation metadata.", @@ -4296,6 +4400,11 @@ "readOnly": true, "type": "string" }, + "dagTimeout": { + "description": "Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes (\"600s\") to 24 hours (\"86400s\"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted.", + "format": "google-duration", + "type": "string" + }, "id": { "type": "string" },
diff --git a/discovery/googleapis/datastore__v1.json b/discovery/googleapis/datastore__v1.json index 257795a..16b09d7 100644 --- a/discovery/googleapis/datastore__v1.json +++ b/discovery/googleapis/datastore__v1.json
@@ -607,7 +607,7 @@ } } }, - "revision": "20200913", + "revision": "20201003", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "AllocateIdsRequest": {
diff --git a/discovery/googleapis/deploymentmanager__v2.json b/discovery/googleapis/deploymentmanager__v2.json index 994113e..06d7bb6 100644 --- a/discovery/googleapis/deploymentmanager__v2.json +++ b/discovery/googleapis/deploymentmanager__v2.json
@@ -17,16 +17,16 @@ } } }, - "basePath": "/deploymentmanager/v2/projects/", - "baseUrl": "https://www.googleapis.com/deploymentmanager/v2/projects/", - "batchPath": "batch/deploymentmanager/v2", + "basePath": "", + "baseUrl": "https://deploymentmanager.googleapis.com/", + "batchPath": "batch", "canonicalName": "Deployment Manager", - "description": "Declares, configures, and deploys complex solutions on Google Cloud Platform.", + "description": "The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/deployment-manager/", + "documentationLink": "https://cloud.google.com/deployment-manager", "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "deploymentmanager:v2", "kind": "discovery#restDescription", @@ -34,18 +34,45 @@ "ownerDomain": "google.com", "ownerName": "Google", "parameters": { - "alt": { - "default": "json", - "description": "Data format for the response.", + "$.xgafv": { + "description": "V1 error format.", "enum": [ - "json" + "1", + "2" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "v1 error format", + "v2 error format" ], "location": "query", "type": "string" }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -68,12 +95,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "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", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -106,7 +138,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}/cancelPreview", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/cancelPreview", "request": { "$ref": "DeploymentsCancelPreviewRequest" }, @@ -131,8 +163,8 @@ "default": "DELETE", "description": "Sets the policy to use for deleting resources.", "enum": [ - "ABANDON", - "DELETE" + "DELETE", + "ABANDON" ], "enumDescriptions": [ "", @@ -155,7 +187,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}", "response": { "$ref": "Operation" }, @@ -188,7 +220,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}", "response": { "$ref": "Deployment" }, @@ -208,6 +240,12 @@ "resource" ], "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -223,7 +261,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{resource}/getIamPolicy", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -244,8 +282,8 @@ "default": "CREATE_OR_ACQUIRE", "description": "Sets the policy to use for creating new resources.", "enum": [ - "ACQUIRE", - "CREATE_OR_ACQUIRE" + "CREATE_OR_ACQUIRE", + "ACQUIRE" ], "enumDescriptions": [ "", @@ -267,7 +305,7 @@ "type": "string" } }, - "path": "{project}/global/deployments", + "path": "deploymentmanager/v2/projects/{project}/global/deployments", "request": { "$ref": "Deployment" }, @@ -288,7 +326,7 @@ ], "parameters": { "filter": { - "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", + "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", "location": "query", "type": "string" }, @@ -301,7 +339,7 @@ "type": "integer" }, "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, @@ -318,7 +356,7 @@ "type": "string" } }, - "path": "{project}/global/deployments", + "path": "deploymentmanager/v2/projects/{project}/global/deployments", "response": { "$ref": "DeploymentsListResponse" }, @@ -342,8 +380,8 @@ "default": "CREATE_OR_ACQUIRE", "description": "Sets the policy to use for creating new resources.", "enum": [ - "ACQUIRE", - "CREATE_OR_ACQUIRE" + "CREATE_OR_ACQUIRE", + "ACQUIRE" ], "enumDescriptions": [ "", @@ -356,8 +394,8 @@ "default": "DELETE", "description": "Sets the policy to use for deleting resources.", "enum": [ - "ABANDON", - "DELETE" + "DELETE", + "ABANDON" ], "enumDescriptions": [ "", @@ -387,7 +425,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}", "request": { "$ref": "Deployment" }, @@ -423,7 +461,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{resource}/setIamPolicy", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{resource}/setIamPolicy", "request": { "$ref": "GlobalSetPolicyRequest" }, @@ -459,7 +497,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}/stop", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/stop", "request": { "$ref": "DeploymentsStopRequest" }, @@ -495,7 +533,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{resource}/testIamPermissions", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -520,8 +558,8 @@ "default": "CREATE_OR_ACQUIRE", "description": "Sets the policy to use for creating new resources.", "enum": [ - "ACQUIRE", - "CREATE_OR_ACQUIRE" + "CREATE_OR_ACQUIRE", + "ACQUIRE" ], "enumDescriptions": [ "", @@ -534,8 +572,8 @@ "default": "DELETE", "description": "Sets the policy to use for deleting resources.", "enum": [ - "ABANDON", - "DELETE" + "DELETE", + "ABANDON" ], "enumDescriptions": [ "", @@ -565,7 +603,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}", "request": { "$ref": "Deployment" }, @@ -613,7 +651,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}/manifests/{manifest}", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/manifests/{manifest}", "response": { "$ref": "Manifest" }, @@ -641,7 +679,7 @@ "type": "string" }, "filter": { - "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", + "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", "location": "query", "type": "string" }, @@ -654,7 +692,7 @@ "type": "integer" }, "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, @@ -671,7 +709,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}/manifests", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/manifests", "response": { "$ref": "ManifestsListResponse" }, @@ -709,7 +747,7 @@ "type": "string" } }, - "path": "{project}/global/operations/{operation}", + "path": "deploymentmanager/v2/projects/{project}/global/operations/{operation}", "response": { "$ref": "Operation" }, @@ -729,7 +767,7 @@ ], "parameters": { "filter": { - "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", + "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", "location": "query", "type": "string" }, @@ -742,7 +780,7 @@ "type": "integer" }, "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, @@ -759,7 +797,7 @@ "type": "string" } }, - "path": "{project}/global/operations", + "path": "deploymentmanager/v2/projects/{project}/global/operations", "response": { "$ref": "OperationsListResponse" }, @@ -805,7 +843,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}/resources/{resource}", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/resources/{resource}", "response": { "$ref": "Resource" }, @@ -833,7 +871,7 @@ "type": "string" }, "filter": { - "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", + "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", "location": "query", "type": "string" }, @@ -846,7 +884,7 @@ "type": "integer" }, "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, @@ -863,7 +901,7 @@ "type": "string" } }, - "path": "{project}/global/deployments/{deployment}/resources", + "path": "deploymentmanager/v2/projects/{project}/global/deployments/{deployment}/resources", "response": { "$ref": "ResourcesListResponse" }, @@ -887,7 +925,7 @@ ], "parameters": { "filter": { - "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", + "description": "A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```", "location": "query", "type": "string" }, @@ -900,7 +938,7 @@ "type": "integer" }, "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.", + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, @@ -917,7 +955,7 @@ "type": "string" } }, - "path": "{project}/global/types", + "path": "deploymentmanager/v2/projects/{project}/global/types", "response": { "$ref": "TypesListResponse" }, @@ -931,11 +969,11 @@ } } }, - "revision": "20200519", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210128", + "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { - "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.\n\nIf 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.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"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\" ] } ] } ] }\n\nFor 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.", + "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.", "id": "AuditConfig", "properties": { "auditLogConfigs": { @@ -945,13 +983,6 @@ }, "type": "array" }, - "exemptedMembers": { - "description": "", - "items": { - "type": "string" - }, - "type": "array" - }, "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" @@ -960,33 +991,30 @@ "type": "object" }, "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions. Example:\n\n{ \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\", } ] }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "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.", "id": "AuditLogConfig", "properties": { "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].", + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "items": { "type": "string" }, "type": "array" }, - "ignoreChildExemptions": { - "description": "", - "type": "boolean" - }, "logType": { "description": "The log type that this config enables.", - "type": "string" - } - }, - "type": "object" - }, - "AuthorizationLoggingOptions": { - "description": "Authorization-related information used by Cloud Audit Logging.", - "id": "AuthorizationLoggingOptions", - "properties": { - "permissionType": { - "description": "The type of the permission that was checked.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], "type": "string" } }, @@ -998,10 +1026,10 @@ "properties": { "condition": { "$ref": "Expr", - "description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the current request.\n\nIf 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 members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + "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 members 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)." }, "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `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.\n\n* `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.\n\n* `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.\n\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.", + "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", "items": { "type": "string" }, @@ -1014,38 +1042,7 @@ }, "type": "object" }, - "Condition": { - "description": "A condition to be met.", - "id": "Condition", - "properties": { - "iam": { - "description": "Trusted attributes supplied by the IAM system.", - "type": "string" - }, - "op": { - "description": "An operator to apply the subject with.", - "type": "string" - }, - "svc": { - "description": "Trusted attributes discharged by the service.", - "type": "string" - }, - "sys": { - "description": "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.", - "type": "string" - }, - "values": { - "description": "The objects of the condition.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "ConfigFile": { - "description": "", "id": "ConfigFile", "properties": { "content": { @@ -1056,7 +1053,6 @@ "type": "object" }, "Deployment": { - "description": "", "id": "Deployment", "properties": { "description": { @@ -1064,7 +1060,7 @@ "type": "string" }, "fingerprint": { - "description": "Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.", + "description": "Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.", "format": "byte", "type": "string" }, @@ -1077,7 +1073,7 @@ "type": "string" }, "labels": { - "description": "Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.", + "description": "Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.", "items": { "$ref": "DeploymentLabelEntry" }, @@ -1115,19 +1111,21 @@ "type": "object" }, "DeploymentLabelEntry": { + "description": "Label object for Deployments", "id": "DeploymentLabelEntry", "properties": { "key": { + "description": "Key of the label", "type": "string" }, "value": { + "description": "Value of the label", "type": "string" } }, "type": "object" }, "DeploymentUpdate": { - "description": "", "id": "DeploymentUpdate", "properties": { "description": { @@ -1135,7 +1133,7 @@ "type": "string" }, "labels": { - "description": "Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.", + "description": "Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.", "items": { "$ref": "DeploymentUpdateLabelEntry" }, @@ -1149,23 +1147,25 @@ "type": "object" }, "DeploymentUpdateLabelEntry": { + "description": "Label object for DeploymentUpdate", "id": "DeploymentUpdateLabelEntry", "properties": { "key": { + "description": "Key of the label", "type": "string" }, "value": { + "description": "Value of the label", "type": "string" } }, "type": "object" }, "DeploymentsCancelPreviewRequest": { - "description": "", "id": "DeploymentsCancelPreviewRequest", "properties": { "fingerprint": { - "description": "Specifies a fingerprint for `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided in `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.", + "description": "Specifies a fingerprint for `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided in `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.", "format": "byte", "type": "string" } @@ -1191,11 +1191,10 @@ "type": "object" }, "DeploymentsStopRequest": { - "description": "", "id": "DeploymentsStopRequest", "properties": { "fingerprint": { - "description": "Specifies a fingerprint for `stop()` requests. A fingerprint is a randomly generated value that must be provided in `stop()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).\n\nThe fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.", + "description": "Specifies a fingerprint for `stop()` requests. A fingerprint is a randomly generated value that must be provided in `stop()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision). The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.", "format": "byte", "type": "string" } @@ -1203,7 +1202,7 @@ "type": "object" }, "Expr": { - "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.\n\nExample (Comparison):\n\ntitle: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\ntitle: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\ntitle: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\ntitle: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\"\n\nThe 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.", + "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() < 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", "properties": { "description": { @@ -1248,7 +1247,6 @@ "type": "object" }, "ImportFile": { - "description": "", "id": "ImportFile", "properties": { "content": { @@ -1262,90 +1260,7 @@ }, "type": "object" }, - "LogConfig": { - "description": "Specifies what kind of log the caller must write", - "id": "LogConfig", - "properties": { - "cloudAudit": { - "$ref": "LogConfigCloudAuditOptions", - "description": "Cloud audit options." - }, - "counter": { - "$ref": "LogConfigCounterOptions", - "description": "Counter options." - }, - "dataAccess": { - "$ref": "LogConfigDataAccessOptions", - "description": "Data access options." - } - }, - "type": "object" - }, - "LogConfigCloudAuditOptions": { - "description": "Write a Cloud Audit log", - "id": "LogConfigCloudAuditOptions", - "properties": { - "authorizationLoggingOptions": { - "$ref": "AuthorizationLoggingOptions", - "description": "Information used by the Cloud Audit Logging pipeline." - }, - "logName": { - "description": "The log_name to populate in the Cloud Audit Record.", - "type": "string" - } - }, - "type": "object" - }, - "LogConfigCounterOptions": { - "description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only, and end in \"_count\". Field names should not contain an initial slash. The actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are their respective values.\n\nSupported field names: - \"authority\", which is \"[token]\" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - \"iam_principal\", a representation of IAMContext.principal even if a token or authority selector is present; or - \"\" (empty string), resulting in a counter with no fields.\n\nExamples: counter { metric: \"/debug_access_count\" field: \"iam_principal\" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}", - "id": "LogConfigCounterOptions", - "properties": { - "customFields": { - "description": "Custom fields.", - "items": { - "$ref": "LogConfigCounterOptionsCustomField" - }, - "type": "array" - }, - "field": { - "description": "The field value to attribute.", - "type": "string" - }, - "metric": { - "description": "The metric to update.", - "type": "string" - } - }, - "type": "object" - }, - "LogConfigCounterOptionsCustomField": { - "description": "Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.", - "id": "LogConfigCounterOptionsCustomField", - "properties": { - "name": { - "description": "Name is the field name.", - "type": "string" - }, - "value": { - "description": "Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.", - "type": "string" - } - }, - "type": "object" - }, - "LogConfigDataAccessOptions": { - "description": "Write a Data Access (Gin) log", - "id": "LogConfigDataAccessOptions", - "properties": { - "logMode": { - "description": "", - "type": "string" - } - }, - "type": "object" - }, "Manifest": { - "description": "", "id": "Manifest", "properties": { "config": { @@ -1375,8 +1290,18 @@ "description": "Output only. The YAML layout for this manifest.", "type": "string" }, + "manifestSizeBytes": { + "description": "Output only. The computed size of the fully expanded manifest.", + "format": "int64", + "type": "string" + }, + "manifestSizeLimitBytes": { + "description": "Output only. The size limit for expanded manifests in the project.", + "format": "int64", + "type": "string" + }, "name": { - "description": "Output only.\n\nThe name of the manifest.", + "description": "Output only. The name of the manifest.", "type": "string" }, "selfLink": { @@ -1405,7 +1330,7 @@ "type": "object" }, "Operation": { - "description": "Represents an Operation resource.\n\nGoogle Compute Engine has three Operation resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)\n\nYou can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.\n\nOperations can be global, regional or zonal. \n- For global operations, use the `globalOperations` resource. \n- For regional operations, use the `regionOperations` resource. \n- For zonal operations, use the `zonalOperations` resource. \n\nFor more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)", + "description": "Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.", "id": "Operation", "properties": { "clientOperationId": { @@ -1501,6 +1426,16 @@ }, "status": { "description": "[Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.", + "enum": [ + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "", + "", + "" + ], "type": "string" }, "statusMessage": { @@ -1526,10 +1461,64 @@ "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "DEPRECATED_RESOURCE_USED", + "NO_RESULTS_ON_PAGE", + "UNREACHABLE", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_NOT_RUNNING", + "INJECTED_KERNELS_DEPRECATED", + "REQUIRED_TOS_AGREEMENT", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "RESOURCE_NOT_DELETED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "NOT_CRITICAL_ERROR", + "CLEANUP_FAILED", + "FIELD_VALUE_OVERRIDEN", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "MISSING_TYPE_DEPENDENCY", + "EXTERNAL_API_WARNING", + "SCHEMA_VALIDATION_IGNORED", + "UNDECLARED_PROPERTIES", + "EXPERIMENTAL_TYPE_USED", + "DEPRECATED_TYPE_USED", + "PARTIAL_SUCCESS", + "LARGE_DEPLOYMENT_WARNING" + ], + "enumDescriptions": [ + "A link to a deprecated resource was created.", + "No results are present on a particular list page.", + "A given scope cannot be reached.", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance cannot ip forward.", + "The route's next hop instance does not have a status of RUNNING.", + "The operation involved use of an injected kernel, which is deprecated.", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "The user created a boot disk that is larger than image size.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "Warning about failed cleanup of transient changes made by a failed operation.", + "Warning that value of a field has been overridden. Deprecated unused field.", + "Warning that a resource is in use.", + "A resource depends on a missing type", + "Warning that is present in an external api call", + "When a resource schema validation is ignored.", + "When undeclared properties in the schema are present", + "When deploying and at least one of the resources has a type marked as experimental", + "When deploying and at least one of the resources has a type marked as deprecated", + "Success is reported, but some results may be missing due to errors", + "When deploying a deployment with a exceedingly large number of resources" + ], "type": "string" }, "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", "items": { "properties": { "key": { @@ -1580,7 +1569,7 @@ "type": "object" }, "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.\n\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members 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.\n\nFor 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).\n\n**JSON example:**\n\n{ \"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 < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 }\n\n**YAML example:**\n\nbindings: - 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 < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3\n\nFor a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "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` to a single `role`. Members 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 < 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 < 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/).", "id": "Policy", "properties": { "auditConfigs": { @@ -1598,23 +1587,12 @@ "type": "array" }, "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.\n\n**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.", + "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" }, - "iamOwned": { - "description": "", - "type": "boolean" - }, - "rules": { - "description": "If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.", - "items": { - "$ref": "Rule" - }, - "type": "array" - }, "version": { - "description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.\n\nAny operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:\n\n* 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\n\n**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.\n\nIf a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "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).", "format": "int32", "type": "integer" } @@ -1622,7 +1600,6 @@ "type": "object" }, "Resource": { - "description": "", "id": "Resource", "properties": { "accessControl": { @@ -1675,10 +1652,64 @@ "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "DEPRECATED_RESOURCE_USED", + "NO_RESULTS_ON_PAGE", + "UNREACHABLE", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_NOT_RUNNING", + "INJECTED_KERNELS_DEPRECATED", + "REQUIRED_TOS_AGREEMENT", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "RESOURCE_NOT_DELETED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "NOT_CRITICAL_ERROR", + "CLEANUP_FAILED", + "FIELD_VALUE_OVERRIDEN", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "MISSING_TYPE_DEPENDENCY", + "EXTERNAL_API_WARNING", + "SCHEMA_VALIDATION_IGNORED", + "UNDECLARED_PROPERTIES", + "EXPERIMENTAL_TYPE_USED", + "DEPRECATED_TYPE_USED", + "PARTIAL_SUCCESS", + "LARGE_DEPLOYMENT_WARNING" + ], + "enumDescriptions": [ + "A link to a deprecated resource was created.", + "No results are present on a particular list page.", + "A given scope cannot be reached.", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance cannot ip forward.", + "The route's next hop instance does not have a status of RUNNING.", + "The operation involved use of an injected kernel, which is deprecated.", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "The user created a boot disk that is larger than image size.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "Warning about failed cleanup of transient changes made by a failed operation.", + "Warning that value of a field has been overridden. Deprecated unused field.", + "Warning that a resource is in use.", + "A resource depends on a missing type", + "Warning that is present in an external api call", + "When a resource schema validation is ignored.", + "When undeclared properties in the schema are present", + "When deploying and at least one of the resources has a type marked as experimental", + "When deploying and at least one of the resources has a type marked as deprecated", + "Success is reported, but some results may be missing due to errors", + "When deploying a deployment with a exceedingly large number of resources" + ], "type": "string" }, "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", "items": { "properties": { "key": { @@ -1718,7 +1749,6 @@ "type": "object" }, "ResourceUpdate": { - "description": "", "id": "ResourceUpdate", "properties": { "accessControl": { @@ -1758,6 +1788,22 @@ }, "intent": { "description": "Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.", + "enum": [ + "CREATE_OR_ACQUIRE", + "DELETE", + "ACQUIRE", + "UPDATE", + "ABANDON", + "CREATE" + ], + "enumDescriptions": [ + "The resource is scheduled to be created, or if it already exists, acquired.", + "The resource is scheduled to be deleted.", + "The resource is scheduled to be acquired.", + "The resource is scheduled to be updated via the UPDATE method.", + "The resource is scheduled to be abandoned.", + "The resource is scheduled to be created." + ], "type": "string" }, "manifest": { @@ -1770,6 +1816,20 @@ }, "state": { "description": "Output only. The state of the resource.", + "enum": [ + "PENDING", + "IN_PROGRESS", + "IN_PREVIEW", + "FAILED", + "ABORTED" + ], + "enumDescriptions": [ + "There are changes pending for this resource.", + "The service is executing changes on the resource.", + "The service is previewing changes on the resource.", + "The service has failed to change the resource.", + "The service has aborted trying to change the resource." + ], "type": "string" }, "warnings": { @@ -1778,10 +1838,64 @@ "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "DEPRECATED_RESOURCE_USED", + "NO_RESULTS_ON_PAGE", + "UNREACHABLE", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_NOT_RUNNING", + "INJECTED_KERNELS_DEPRECATED", + "REQUIRED_TOS_AGREEMENT", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "RESOURCE_NOT_DELETED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "NOT_CRITICAL_ERROR", + "CLEANUP_FAILED", + "FIELD_VALUE_OVERRIDEN", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "MISSING_TYPE_DEPENDENCY", + "EXTERNAL_API_WARNING", + "SCHEMA_VALIDATION_IGNORED", + "UNDECLARED_PROPERTIES", + "EXPERIMENTAL_TYPE_USED", + "DEPRECATED_TYPE_USED", + "PARTIAL_SUCCESS", + "LARGE_DEPLOYMENT_WARNING" + ], + "enumDescriptions": [ + "A link to a deprecated resource was created.", + "No results are present on a particular list page.", + "A given scope cannot be reached.", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance cannot ip forward.", + "The route's next hop instance does not have a status of RUNNING.", + "The operation involved use of an injected kernel, which is deprecated.", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "The user created a boot disk that is larger than image size.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "Warning about failed cleanup of transient changes made by a failed operation.", + "Warning that value of a field has been overridden. Deprecated unused field.", + "Warning that a resource is in use.", + "A resource depends on a missing type", + "Warning that is present in an external api call", + "When a resource schema validation is ignored.", + "When undeclared properties in the schema are present", + "When deploying and at least one of the resources has a type marked as experimental", + "When deploying and at least one of the resources has a type marked as deprecated", + "Success is reported, but some results may be missing due to errors", + "When deploying a deployment with a exceedingly large number of resources" + ], "type": "string" }, "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }", + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", "items": { "properties": { "key": { @@ -1827,58 +1941,7 @@ }, "type": "object" }, - "Rule": { - "description": "A rule to be applied in a Policy.", - "id": "Rule", - "properties": { - "action": { - "description": "Required", - "type": "string" - }, - "conditions": { - "description": "Additional restrictions that must be met. All conditions must pass for the rule to match.", - "items": { - "$ref": "Condition" - }, - "type": "array" - }, - "description": { - "description": "Human-readable description of the rule.", - "type": "string" - }, - "ins": { - "description": "If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.", - "items": { - "type": "string" - }, - "type": "array" - }, - "logConfigs": { - "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.", - "items": { - "$ref": "LogConfig" - }, - "type": "array" - }, - "notIns": { - "description": "If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.", - "items": { - "type": "string" - }, - "type": "array" - }, - "permissions": { - "description": "A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "TargetConfiguration": { - "description": "", "id": "TargetConfiguration", "properties": { "config": { @@ -1967,7 +2030,7 @@ "type": "object" } }, - "servicePath": "deploymentmanager/v2/projects/", - "title": "Google Cloud Deployment Manager API", + "servicePath": "", + "title": "Cloud Deployment Manager V2 API", "version": "v2" } \ No newline at end of file
diff --git a/discovery/googleapis/dfareporting__v3.4.json b/discovery/googleapis/dfareporting__v3.4.json index 115cf97..b90589c 100644 --- a/discovery/googleapis/dfareporting__v3.4.json +++ b/discovery/googleapis/dfareporting__v3.4.json
@@ -3952,7 +3952,7 @@ "type": "string" }, "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -4603,7 +4603,7 @@ "type": "string" }, "profileId": { - "description": "The DFA profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7665,7 +7665,7 @@ ], "parameters": { "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7694,7 +7694,7 @@ ], "parameters": { "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7725,7 +7725,7 @@ ], "parameters": { "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7766,7 +7766,7 @@ "type": "string" }, "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7870,7 +7870,7 @@ ], "parameters": { "profileId": { - "description": "The DFA profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7908,7 +7908,7 @@ ], "parameters": { "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7946,7 +7946,7 @@ ], "parameters": { "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -7986,7 +7986,7 @@ "type": "string" }, "profileId": { - "description": "The DFA user profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -8033,7 +8033,7 @@ "type": "string" }, "profileId": { - "description": "The DFA profile ID.", + "description": "The Campaign Manager 360 user profile ID.", "format": "int64", "location": "path", "required": true, @@ -9464,7 +9464,7 @@ } } }, - "revision": "20200921", + "revision": "20201102", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -11029,7 +11029,7 @@ "type": "boolean" }, "enabledSizes": { - "description": "Whitelist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.", + "description": "Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.", "items": { "$ref": "Size" }, @@ -11512,11 +11512,13 @@ "enum": [ "CREATIVE_AUTHORING_SOURCE_DCM", "CREATIVE_AUTHORING_SOURCE_DBM", - "CREATIVE_AUTHORING_SOURCE_STUDIO" + "CREATIVE_AUTHORING_SOURCE_STUDIO", + "CREATIVE_AUTHORING_SOURCE_GWD" ], "enumDescriptions": [ "", "", + "", "" ], "type": "string" @@ -17020,7 +17022,7 @@ "description": "Lookback window settings for this placement." }, "name": { - "description": "Name of this placement.This is a required field and must be less than 256 characters long.", + "description": "Name of this placement.This is a required field and must be less than or equal to 256 characters long.", "type": "string" }, "paymentApproved": { @@ -19039,7 +19041,7 @@ "type": "boolean" }, "enabledSizes": { - "description": "Whitelist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.", + "description": "Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.", "items": { "$ref": "Size" }, @@ -19175,7 +19177,7 @@ "id": "SiteTranscodeSetting", "properties": { "enabledVideoFormats": { - "description": "Whitelist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.", + "description": "Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.", "items": { "format": "int32", "type": "integer" @@ -19873,7 +19875,7 @@ "id": "TranscodeSetting", "properties": { "enabledVideoFormats": { - "description": "Whitelist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.", + "description": "Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.", "items": { "format": "int32", "type": "integer" @@ -20501,6 +20503,6 @@ } }, "servicePath": "dfareporting/v3.4/", - "title": "DCM/DFA Reporting And Trafficking API", + "title": "Campaign Manager 360 API", "version": "v3.4" } \ No newline at end of file
diff --git a/discovery/googleapis/dialogflow__v2.json b/discovery/googleapis/dialogflow__v2.json index 411d609..5dde703 100644 --- a/discovery/googleapis/dialogflow__v2.json +++ b/discovery/googleapis/dialogflow__v2.json
@@ -823,7 +823,7 @@ ] }, "detectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.", + "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "httpMethod": "POST", "id": "dialogflow.projects.agent.environments.users.sessions.detectIntent", "parameterOrder": [ @@ -831,7 +831,7 @@ ], "parameters": { "session": { - "description": "Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).", + "description": "Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "location": "path", "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", "required": true, @@ -1470,7 +1470,7 @@ ] }, "detectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.", + "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "httpMethod": "POST", "id": "dialogflow.projects.agent.sessions.detectIntent", "parameterOrder": [ @@ -1478,7 +1478,7 @@ ], "parameters": { "session": { - "description": "Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).", + "description": "Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).", "location": "path", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "required": true, @@ -2004,9 +2004,1585 @@ } } }, - "revision": "20201006", + "revision": "20210130", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { + "GoogleCloudDialogflowCxV3AudioInput": { + "description": "Represents the natural speech audio to be processed.", + "id": "GoogleCloudDialogflowCxV3AudioInput", + "properties": { + "audio": { + "description": "The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.", + "format": "byte", + "type": "string" + }, + "config": { + "$ref": "GoogleCloudDialogflowCxV3InputAudioConfig", + "description": "Required. Instructs the speech recognizer how to process the speech audio." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata": { + "description": "Metadata returned for the TestCases.BatchRunTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata", + "properties": { + "errors": { + "description": "The test errors.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3BatchRunTestCasesResponse": { + "description": "The response message for TestCases.BatchRunTestCases.", + "id": "GoogleCloudDialogflowCxV3BatchRunTestCasesResponse", + "properties": { + "results": { + "description": "The test case results. The detailed conversation turns are empty in this response.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ConversationTurn": { + "description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.", + "id": "GoogleCloudDialogflowCxV3ConversationTurn", + "properties": { + "userInput": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurnUserInput", + "description": "The user input." + }, + "virtualAgentOutput": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput", + "description": "The virtual agent output." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ConversationTurnUserInput": { + "description": "The input from the human user.", + "id": "GoogleCloudDialogflowCxV3ConversationTurnUserInput", + "properties": { + "injectedParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Parameters that need to be injected into the conversation during intent detection.", + "type": "object" + }, + "input": { + "$ref": "GoogleCloudDialogflowCxV3QueryInput", + "description": "Supports text input, event input, dtmf input in the test case." + }, + "isWebhookEnabled": { + "description": "If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput": { + "description": "The output from the virtual agent.", + "id": "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput", + "properties": { + "currentPage": { + "$ref": "GoogleCloudDialogflowCxV3Page", + "description": "The Page on which the utterance was spoken. Only some fields such as name and displayname will be set." + }, + "diagnosticInfo": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. Input only. The diagnostic info output for the turn.", + "type": "object" + }, + "differences": { + "description": "Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestRunDifference" + }, + "readOnly": true, + "type": "array" + }, + "sessionParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The session parameters available to the bot at this point.", + "type": "object" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "Response error from the agent in the test result. If set, other output is empty." + }, + "textResponses": { + "description": "The text responses from the agent for the turn.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText" + }, + "type": "array" + }, + "triggeredIntent": { + "$ref": "GoogleCloudDialogflowCxV3Intent", + "description": "The Intent that triggered the response. Only some fields such as name and displayname will be set." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": { + "description": "Metadata for CreateDocument operation.", + "id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": { + "description": "Metadata associated with the long running operation for Versions.CreateVersion.", + "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata", + "properties": { + "version": { + "description": "Name of the created version. Format: `projects//locations//agents//flows//versions/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { + "description": "Metadata for DeleteDocument operation.", + "id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DtmfInput": { + "description": "Represents the input for dtmf event.", + "id": "GoogleCloudDialogflowCxV3DtmfInput", + "properties": { + "digits": { + "description": "The dtmf digits.", + "type": "string" + }, + "finishDigit": { + "description": "The finish digit (if any).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EventHandler": { + "description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3EventHandler", + "properties": { + "event": { + "description": "Required. The name of the event to handle.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this event handler.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EventInput": { + "description": "Represents the event to trigger.", + "id": "GoogleCloudDialogflowCxV3EventInput", + "properties": { + "event": { + "description": "Name of the event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowCxV3ExportAgentResponse", + "properties": { + "agentContent": { + "description": "Uncompressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportTestCasesResponse": { + "description": "The response message for TestCases.ExportTestCases.", + "id": "GoogleCloudDialogflowCxV3ExportTestCasesResponse", + "properties": { + "content": { + "description": "Uncompressed raw byte content for test cases.", + "format": "byte", + "type": "string" + }, + "gcsUri": { + "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Form": { + "description": "A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.", + "id": "GoogleCloudDialogflowCxV3Form", + "properties": { + "parameters": { + "description": "Parameters to collect from the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FormParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FormParameter": { + "description": "Represents a form parameter.", + "id": "GoogleCloudDialogflowCxV3FormParameter", + "properties": { + "defaultValue": { + "description": "The default value of an optional parameter. If the parameter is required, the default value will be ignored.", + "type": "any" + }, + "displayName": { + "description": "Required. The human-readable name of the parameter, unique within the form.", + "type": "string" + }, + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "fillBehavior": { + "$ref": "GoogleCloudDialogflowCxV3FormParameterFillBehavior", + "description": "Required. Defines fill behavior for the parameter." + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + }, + "required": { + "description": "Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FormParameterFillBehavior": { + "description": "Configuration for how the filling of a parameter should be handled.", + "id": "GoogleCloudDialogflowCxV3FormParameterFillBehavior", + "properties": { + "initialPromptFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter." + }, + "repromptEventHandlers": { + "description": "The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EventHandler" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Fulfillment": { + "description": "A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.", + "id": "GoogleCloudDialogflowCxV3Fulfillment", + "properties": { + "conditionalCases": { + "description": "Conditional cases for this fulfillment.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases" + }, + "type": "array" + }, + "messages": { + "description": "The list of rich message responses to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" + }, + "type": "array" + }, + "setParameterActions": { + "description": "Set parameter values before executing the webhook.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction" + }, + "type": "array" + }, + "tag": { + "description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified.", + "type": "string" + }, + "webhook": { + "description": "The webhook to call. Format: `projects//locations//agents//webhooks/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentConditionalCases": { + "description": "A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.", + "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases", + "properties": { + "cases": { + "description": "A list of cascading if-else conditions.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase": { + "description": "Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.", + "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase", + "properties": { + "caseContent": { + "description": "A list of case content.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent" + }, + "type": "array" + }, + "condition": { + "description": "The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent": { + "description": "The list of messages or conditional cases to activate for this case.", + "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent", + "properties": { + "additionalCases": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases", + "description": "Additional cases to be evaluated." + }, + "message": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage", + "description": "Returned message." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction": { + "description": "Setting a parameter value.", + "id": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction", + "properties": { + "parameter": { + "description": "Display name of the parameter.", + "type": "string" + }, + "value": { + "description": "The new value of the parameter. A null value clears the parameter.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": { + "description": "Metadata in google::longrunning::Operation for Knowledge operations.", + "id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "properties": { + "state": { + "description": "Required. Output only. The current state of this operation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": { + "description": "Metadata for ImportDocuments operation.", + "id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportDocumentsResponse": { + "description": "Response message for Documents.ImportDocuments.", + "id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse", + "properties": { + "warnings": { + "description": "Includes details about skipped documents or any other warnings.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", + "properties": { + "errors": { + "description": "Errors for failed test cases.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportTestCasesResponse": { + "description": "The response message for TestCases.ImportTestCases.", + "id": "GoogleCloudDialogflowCxV3ImportTestCasesResponse", + "properties": { + "names": { + "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3InputAudioConfig": { + "description": "Instructs the speech recognizer on how to process the audio content.", + "id": "GoogleCloudDialogflowCxV3InputAudioConfig", + "properties": { + "audioEncoding": { + "description": "Required. Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "model": { + "description": "Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.", + "type": "string" + }, + "modelVariant": { + "description": "Optional. Which variant of the Speech model to use.", + "enum": [ + "SPEECH_MODEL_VARIANT_UNSPECIFIED", + "USE_BEST_AVAILABLE", + "USE_STANDARD", + "USE_ENHANCED" + ], + "enumDescriptions": [ + "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", + "Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.", + "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", + "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible." + ], + "type": "string" + }, + "phraseHints": { + "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, + "singleUtterance": { + "description": "Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Intent": { + "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.", + "id": "GoogleCloudDialogflowCxV3Intent", + "properties": { + "description": { + "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the intent, unique within the agent.", + "type": "string" + }, + "isFallback": { + "description": "Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.", + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", + "type": "object" + }, + "name": { + "description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.", + "type": "string" + }, + "parameters": { + "description": "The collection of parameters associated with the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3IntentParameter" + }, + "type": "array" + }, + "priority": { + "description": "The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", + "format": "int32", + "type": "integer" + }, + "trainingPhrases": { + "description": "The collection of training phrases the agent is trained on to identify the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3IntentTrainingPhrase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentInput": { + "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing.", + "id": "GoogleCloudDialogflowCxV3IntentInput", + "properties": { + "intent": { + "description": "Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentParameter": { + "description": "Represents an intent parameter.", + "id": "GoogleCloudDialogflowCxV3IntentParameter", + "properties": { + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "id": { + "description": "Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.", + "type": "string" + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentTrainingPhrase": { + "description": "Represents an example that the agent is trained on to identify the intent.", + "id": "GoogleCloudDialogflowCxV3IntentTrainingPhrase", + "properties": { + "id": { + "description": "Output only. The unique identifier of the training phrase.", + "type": "string" + }, + "parts": { + "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart" + }, + "type": "array" + }, + "repeatCount": { + "description": "Indicates how many times this example was added to the intent.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart": { + "description": "Represents a part of a training phrase.", + "id": "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart", + "properties": { + "parameterId": { + "description": "The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "text": { + "description": "Required. The text for this part.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Page": { + "description": "A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", + "id": "GoogleCloudDialogflowCxV3Page", + "properties": { + "displayName": { + "description": "Required. The human-readable name of the page, unique within the agent.", + "type": "string" + }, + "entryFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "The fulfillment to call when the session is entering the page." + }, + "eventHandlers": { + "description": "Handlers associated with the page to handle events such as webhook errors, no match or no input.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EventHandler" + }, + "type": "array" + }, + "form": { + "$ref": "GoogleCloudDialogflowCxV3Form", + "description": "The form associated with the page, used for collecting parameters relevant to the page." + }, + "name": { + "description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "transitionRouteGroups": { + "description": "Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "transitionRoutes": { + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PageInfo": { + "description": "Represents page information communicated to and from the webhook.", + "id": "GoogleCloudDialogflowCxV3PageInfo", + "properties": { + "currentPage": { + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "formInfo": { + "$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfo", + "description": "Optional for both WebhookRequest and WebhookResponse. Information about the form." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PageInfoFormInfo": { + "description": "Represents form information.", + "id": "GoogleCloudDialogflowCxV3PageInfoFormInfo", + "properties": { + "parameterInfo": { + "description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo": { + "description": "Represents parameter information.", + "id": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo", + "properties": { + "displayName": { + "description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.", + "type": "string" + }, + "justCollected": { + "description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.", + "type": "boolean" + }, + "required": { + "description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", + "type": "boolean" + }, + "state": { + "description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.", + "enum": [ + "PARAMETER_STATE_UNSPECIFIED", + "EMPTY", + "INVALID", + "FILLED" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "Indicates that the parameter does not have a value.", + "Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", + "Indicates that the parameter has a value." + ], + "type": "string" + }, + "value": { + "description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3QueryInput": { + "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. ", + "id": "GoogleCloudDialogflowCxV3QueryInput", + "properties": { + "audio": { + "$ref": "GoogleCloudDialogflowCxV3AudioInput", + "description": "The natural language speech audio to be processed." + }, + "dtmf": { + "$ref": "GoogleCloudDialogflowCxV3DtmfInput", + "description": "The DTMF event to be handled." + }, + "event": { + "$ref": "GoogleCloudDialogflowCxV3EventInput", + "description": "The event to be triggered." + }, + "intent": { + "$ref": "GoogleCloudDialogflowCxV3IntentInput", + "description": "The intent to be triggered." + }, + "languageCode": { + "description": "Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, + "text": { + "$ref": "GoogleCloudDialogflowCxV3TextInput", + "description": "The natural language text to be processed." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": { + "description": "Metadata for ReloadDocument operation.", + "id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessage": { + "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", + "id": "GoogleCloudDialogflowCxV3ResponseMessage", + "properties": { + "conversationSuccess": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess", + "description": "Indicates that the conversation succeeded." + }, + "endInteraction": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction", + "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.", + "readOnly": true + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a human agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio", + "description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "readOnly": true + }, + "outputAudioText": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText", + "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "playAudio": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", + "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way." + }, + "text": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess": { + "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText": { + "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "ssml": { + "description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).", + "type": "string" + }, + "text": { + "description": "The raw text to be synthesized.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio": { + "description": "Specifies an audio clip to be played by the client as part of the response.", + "id": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "audioUri": { + "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageText", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "text": { + "description": "Required. A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseMetadata": { + "description": "Metadata returned for the TestCases.RunTestCase long running operation.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseResponse": { + "description": "The response message for TestCases.RunTestCase.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseResponse", + "properties": { + "result": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", + "description": "The result." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SessionInfo": { + "description": "Represents session information communicated to and from the webhook.", + "id": "GoogleCloudDialogflowCxV3SessionInfo", + "properties": { + "parameters": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", + "type": "object" + }, + "session": { + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestCase": { + "description": "Represents a test case.", + "id": "GoogleCloudDialogflowCxV3TestCase", + "properties": { + "creationTime": { + "description": "Output only. When the test was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", + "type": "string" + }, + "lastTestResult": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", + "description": "The latest test result." + }, + "name": { + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "type": "string" + }, + "notes": { + "description": "Additional freeform notes about the test case. Limit of 400 characters.", + "type": "string" + }, + "tags": { + "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", + "items": { + "type": "string" + }, + "type": "array" + }, + "testCaseConversationTurns": { + "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" + }, + "type": "array" + }, + "testConfig": { + "$ref": "GoogleCloudDialogflowCxV3TestConfig", + "description": "Config for the test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestCaseError": { + "description": "Error info for importing a test.", + "id": "GoogleCloudDialogflowCxV3TestCaseError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test case." + }, + "testCase": { + "$ref": "GoogleCloudDialogflowCxV3TestCase", + "description": "The test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestCaseResult": { + "description": "Represents a result from running a test case in an agent environment.", + "id": "GoogleCloudDialogflowCxV3TestCaseResult", + "properties": { + "conversationTurns": { + "description": "The conversation turns uttered during the test case replay in chronological order.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" + }, + "type": "array" + }, + "environment": { + "description": "Environment where the test was run. If not set, it indicates the draft environment.", + "type": "string" + }, + "name": { + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "type": "string" + }, + "testResult": { + "description": "Whether the test case passed in the agent environment.", + "enum": [ + "TEST_RESULT_UNSPECIFIED", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "Not specified. Should never be used.", + "The test passed.", + "The test did not pass." + ], + "type": "string" + }, + "testTime": { + "description": "The time that the test was run.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestConfig": { + "description": "Represents configurations for a test case.", + "id": "GoogleCloudDialogflowCxV3TestConfig", + "properties": { + "flow": { + "description": "Flow name. If not set, default start flow is assumed. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "trackingParameters": { + "description": "Session parameters to be compared when calculating differences.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestError": { + "description": "Error info for running a test.", + "id": "GoogleCloudDialogflowCxV3TestError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test." + }, + "testCase": { + "description": "The test case resource name.", + "type": "string" + }, + "testTime": { + "description": "The timestamp when the test was completed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestRunDifference": { + "description": "The description of differences between original and replayed agent output.", + "id": "GoogleCloudDialogflowCxV3TestRunDifference", + "properties": { + "description": { + "description": "A description of the diff, showing the actual output vs expected output.", + "type": "string" + }, + "type": { + "description": "The type of diff.", + "enum": [ + "DIFF_TYPE_UNSPECIFIED", + "INTENT", + "PAGE", + "PARAMETERS", + "UTTERANCE" + ], + "enumDescriptions": [ + "Should never be used.", + "The intent.", + "The page.", + "The parameters.", + "The message utterance." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TextInput": { + "description": "Represents the natural language text to be processed.", + "id": "GoogleCloudDialogflowCxV3TextInput", + "properties": { + "text": { + "description": "Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TransitionRoute": { + "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3TransitionRoute", + "properties": { + "condition": { + "description": "The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "intent": { + "description": "The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this transition route.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": { + "description": "Metadata for UpdateDocument operation.", + "id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequest": { + "description": "The request message for a webhook call.", + "id": "GoogleCloudDialogflowCxV3WebhookRequest", + "properties": { + "detectIntentResponseId": { + "description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.", + "type": "string" + }, + "fulfillmentInfo": { + "$ref": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo", + "description": "Always present. Information about the fulfillment that triggered this webhook call." + }, + "intentInfo": { + "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", + "description": "Information about the last matched intent." + }, + "messages": { + "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" + }, + "type": "array" + }, + "pageInfo": { + "$ref": "GoogleCloudDialogflowCxV3PageInfo", + "description": "Information about page status." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom data set in QueryParameters.payload.", + "type": "object" + }, + "sessionInfo": { + "$ref": "GoogleCloudDialogflowCxV3SessionInfo", + "description": "Information about session status." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo": { + "description": "Represents fulfillment information communicated to the webhook.", + "id": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo", + "properties": { + "tag": { + "description": "Always present. The tag used to identify which fulfillment is being called.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo": { + "description": "Represents intent information communicated to the webhook.", + "id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", + "properties": { + "confidence": { + "description": "The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).", + "format": "float", + "type": "number" + }, + "displayName": { + "description": "Always present. The display name of the last matched intent.", + "type": "string" + }, + "lastMatchedIntent": { + "description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue" + }, + "description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue": { + "description": "Represents a value for an intent parameter.", + "id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue", + "properties": { + "originalValue": { + "description": "Always present. Original text value extracted from user utterance.", + "type": "string" + }, + "resolvedValue": { + "description": "Always present. Structured value for the parameter extracted from user utterance.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookResponse": { + "description": "The response message for a webhook call.", + "id": "GoogleCloudDialogflowCxV3WebhookResponse", + "properties": { + "fulfillmentResponse": { + "$ref": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse", + "description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user." + }, + "pageInfo": { + "$ref": "GoogleCloudDialogflowCxV3PageInfo", + "description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Value to append directly to QueryResult.webhook_payloads.", + "type": "object" + }, + "sessionInfo": { + "$ref": "GoogleCloudDialogflowCxV3SessionInfo", + "description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status." + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse": { + "description": "Represents a fulfillment response to the user.", + "id": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse", + "properties": { + "mergeBehavior": { + "description": "Merge behavior for `messages`.", + "enum": [ + "MERGE_BEHAVIOR_UNSPECIFIED", + "APPEND", + "REPLACE" + ], + "enumDescriptions": [ + "Not specified. `APPEND` will be used.", + "`messages` will be appended to the list of messages waiting to be sent to the user.", + "`messages` will replace the list of messages waiting to be sent to the user." + ], + "type": "string" + }, + "messages": { + "description": "The list of rich message responses to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1AudioInput": { + "description": "Represents the natural speech audio to be processed.", + "id": "GoogleCloudDialogflowCxV3beta1AudioInput", + "properties": { + "audio": { + "description": "The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.", + "format": "byte", + "type": "string" + }, + "config": { + "$ref": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", + "description": "Required. Instructs the speech recognizer how to process the speech audio." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata": { + "description": "Metadata returned for the TestCases.BatchRunTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata", + "properties": { + "errors": { + "description": "The test errors.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse": { + "description": "The response message for TestCases.BatchRunTestCases.", + "id": "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse", + "properties": { + "results": { + "description": "The test case results. The detailed conversation turns are empty in this response.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ConversationTurn": { + "description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.", + "id": "GoogleCloudDialogflowCxV3beta1ConversationTurn", + "properties": { + "userInput": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput", + "description": "The user input." + }, + "virtualAgentOutput": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput", + "description": "The virtual agent output." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput": { + "description": "The input from the human user.", + "id": "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput", + "properties": { + "injectedParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Parameters that need to be injected into the conversation during intent detection.", + "type": "object" + }, + "input": { + "$ref": "GoogleCloudDialogflowCxV3beta1QueryInput", + "description": "Supports text input, event input, dtmf input in the test case." + }, + "isWebhookEnabled": { + "description": "If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput": { + "description": "The output from the virtual agent.", + "id": "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput", + "properties": { + "currentPage": { + "$ref": "GoogleCloudDialogflowCxV3beta1Page", + "description": "The Page on which the utterance was spoken. Only some fields such as name and displayname will be set." + }, + "diagnosticInfo": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. Input only. The diagnostic info output for the turn.", + "type": "object" + }, + "differences": { + "description": "Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestRunDifference" + }, + "readOnly": true, + "type": "array" + }, + "sessionParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The session parameters available to the bot at this point.", + "type": "object" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "Response error from the agent in the test result. If set, other output is empty." + }, + "textResponses": { + "description": "The text responses from the agent for the turn.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText" + }, + "type": "array" + }, + "triggeredIntent": { + "$ref": "GoogleCloudDialogflowCxV3beta1Intent", + "description": "The Intent that triggered the response. Only some fields such as name and displayname will be set." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": { + "description": "Metadata for CreateDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", @@ -2018,6 +3594,71 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { + "description": "Metadata for DeleteDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DtmfInput": { + "description": "Represents the input for dtmf event.", + "id": "GoogleCloudDialogflowCxV3beta1DtmfInput", + "properties": { + "digits": { + "description": "The dtmf digits.", + "type": "string" + }, + "finishDigit": { + "description": "The finish digit (if any).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1EventHandler": { + "description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3beta1EventHandler", + "properties": { + "event": { + "description": "Required. The name of the event to handle.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this event handler.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1EventInput": { + "description": "Represents the event to trigger.", + "id": "GoogleCloudDialogflowCxV3beta1EventInput", + "properties": { + "event": { + "description": "Name of the event.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportAgentResponse": { "description": "The response message for Agents.ExportAgent.", "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", @@ -2034,13 +3675,502 @@ }, "type": "object" }, - "GoogleCloudDialogflowCxV3beta1ImportAgentResponse": { - "description": "The response message for Agents.ImportAgent.", - "id": "GoogleCloudDialogflowCxV3beta1ImportAgentResponse", + "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse": { + "description": "The response message for TestCases.ExportTestCases.", + "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse", "properties": { - "agent": { - "description": "The unique identifier of the new agent. Format: `projects//locations//agents/`.", + "content": { + "description": "Uncompressed raw byte content for test cases.", + "format": "byte", "type": "string" + }, + "gcsUri": { + "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Form": { + "description": "A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.", + "id": "GoogleCloudDialogflowCxV3beta1Form", + "properties": { + "parameters": { + "description": "Parameters to collect from the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FormParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FormParameter": { + "description": "Represents a form parameter.", + "id": "GoogleCloudDialogflowCxV3beta1FormParameter", + "properties": { + "defaultValue": { + "description": "The default value of an optional parameter. If the parameter is required, the default value will be ignored.", + "type": "any" + }, + "displayName": { + "description": "Required. The human-readable name of the parameter, unique within the form.", + "type": "string" + }, + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "fillBehavior": { + "$ref": "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior", + "description": "Required. Defines fill behavior for the parameter." + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + }, + "required": { + "description": "Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior": { + "description": "Configuration for how the filling of a parameter should be handled.", + "id": "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior", + "properties": { + "initialPromptFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter." + }, + "repromptEventHandlers": { + "description": "The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1EventHandler" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Fulfillment": { + "description": "A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.", + "id": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "properties": { + "conditionalCases": { + "description": "Conditional cases for this fulfillment.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases" + }, + "type": "array" + }, + "messages": { + "description": "The list of rich message responses to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" + }, + "type": "array" + }, + "setParameterActions": { + "description": "Set parameter values before executing the webhook.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction" + }, + "type": "array" + }, + "tag": { + "description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified.", + "type": "string" + }, + "webhook": { + "description": "The webhook to call. Format: `projects//locations//agents//webhooks/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases": { + "description": "A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases", + "properties": { + "cases": { + "description": "A list of cascading if-else conditions.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase": { + "description": "Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase", + "properties": { + "caseContent": { + "description": "A list of case content.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent" + }, + "type": "array" + }, + "condition": { + "description": "The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent": { + "description": "The list of messages or conditional cases to activate for this case.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent", + "properties": { + "additionalCases": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases", + "description": "Additional cases to be evaluated." + }, + "message": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage", + "description": "Returned message." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction": { + "description": "Setting a parameter value.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction", + "properties": { + "parameter": { + "description": "Display name of the parameter.", + "type": "string" + }, + "value": { + "description": "The new value of the parameter. A null value clears the parameter.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": { + "description": "Metadata in google::longrunning::Operation for Knowledge operations.", + "id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "properties": { + "state": { + "description": "Required. Output only. The current state of this operation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": { + "description": "Metadata for ImportDocuments operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": { + "description": "Response message for Documents.ImportDocuments.", + "id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse", + "properties": { + "warnings": { + "description": "Includes details about skipped documents or any other warnings.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", + "properties": { + "errors": { + "description": "Errors for failed test cases.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse": { + "description": "The response message for TestCases.ImportTestCases.", + "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse", + "properties": { + "names": { + "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1InputAudioConfig": { + "description": "Instructs the speech recognizer on how to process the audio content.", + "id": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", + "properties": { + "audioEncoding": { + "description": "Required. Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "model": { + "description": "Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.", + "type": "string" + }, + "modelVariant": { + "description": "Optional. Which variant of the Speech model to use.", + "enum": [ + "SPEECH_MODEL_VARIANT_UNSPECIFIED", + "USE_BEST_AVAILABLE", + "USE_STANDARD", + "USE_ENHANCED" + ], + "enumDescriptions": [ + "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", + "Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.", + "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", + "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible." + ], + "type": "string" + }, + "phraseHints": { + "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, + "singleUtterance": { + "description": "Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Intent": { + "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.", + "id": "GoogleCloudDialogflowCxV3beta1Intent", + "properties": { + "description": { + "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the intent, unique within the agent.", + "type": "string" + }, + "isFallback": { + "description": "Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.", + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", + "type": "object" + }, + "name": { + "description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.", + "type": "string" + }, + "parameters": { + "description": "The collection of parameters associated with the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentParameter" + }, + "type": "array" + }, + "priority": { + "description": "The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", + "format": "int32", + "type": "integer" + }, + "trainingPhrases": { + "description": "The collection of training phrases the agent is trained on to identify the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentInput": { + "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing.", + "id": "GoogleCloudDialogflowCxV3beta1IntentInput", + "properties": { + "intent": { + "description": "Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentParameter": { + "description": "Represents an intent parameter.", + "id": "GoogleCloudDialogflowCxV3beta1IntentParameter", + "properties": { + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "id": { + "description": "Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.", + "type": "string" + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase": { + "description": "Represents an example that the agent is trained on to identify the intent.", + "id": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase", + "properties": { + "id": { + "description": "Output only. The unique identifier of the training phrase.", + "type": "string" + }, + "parts": { + "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart" + }, + "type": "array" + }, + "repeatCount": { + "description": "Indicates how many times this example was added to the intent.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart": { + "description": "Represents a part of a training phrase.", + "id": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart", + "properties": { + "parameterId": { + "description": "The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "text": { + "description": "Required. The text for this part.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Page": { + "description": "A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", + "id": "GoogleCloudDialogflowCxV3beta1Page", + "properties": { + "displayName": { + "description": "Required. The human-readable name of the page, unique within the agent.", + "type": "string" + }, + "entryFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "The fulfillment to call when the session is entering the page." + }, + "eventHandlers": { + "description": "Handlers associated with the page to handle events such as webhook errors, no match or no input.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1EventHandler" + }, + "type": "array" + }, + "form": { + "$ref": "GoogleCloudDialogflowCxV3beta1Form", + "description": "The form associated with the page, used for collecting parameters relevant to the page." + }, + "name": { + "description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "transitionRouteGroups": { + "description": "Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "transitionRoutes": { + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" + }, + "type": "array" } }, "type": "object" @@ -2113,6 +4243,48 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1QueryInput": { + "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. ", + "id": "GoogleCloudDialogflowCxV3beta1QueryInput", + "properties": { + "audio": { + "$ref": "GoogleCloudDialogflowCxV3beta1AudioInput", + "description": "The natural language speech audio to be processed." + }, + "dtmf": { + "$ref": "GoogleCloudDialogflowCxV3beta1DtmfInput", + "description": "The DTMF event to be handled." + }, + "event": { + "$ref": "GoogleCloudDialogflowCxV3beta1EventInput", + "description": "The event to be triggered." + }, + "intent": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentInput", + "description": "The intent to be triggered." + }, + "languageCode": { + "description": "Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, + "text": { + "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", + "description": "The natural language text to be processed." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": { + "description": "Metadata for ReloadDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ResponseMessage": { "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "id": "GoogleCloudDialogflowCxV3beta1ResponseMessage", @@ -2284,6 +4456,23 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata": { + "description": "Metadata returned for the TestCases.RunTestCase long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1RunTestCaseResponse": { + "description": "The response message for TestCases.RunTestCase.", + "id": "GoogleCloudDialogflowCxV3beta1RunTestCaseResponse", + "properties": { + "result": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult", + "description": "The result." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1SessionInfo": { "description": "Represents session information communicated to and from the webhook.", "id": "GoogleCloudDialogflowCxV3beta1SessionInfo", @@ -2296,12 +4485,236 @@ "type": "object" }, "session": { - "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a user. Format: `projects//locations//agents//sessions/`.", + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", "type": "string" } }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1TestCase": { + "description": "Represents a test case.", + "id": "GoogleCloudDialogflowCxV3beta1TestCase", + "properties": { + "creationTime": { + "description": "Output only. When the test was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", + "type": "string" + }, + "lastTestResult": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult", + "description": "The latest test result." + }, + "name": { + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "type": "string" + }, + "notes": { + "description": "Additional freeform notes about the test case. Limit of 400 characters.", + "type": "string" + }, + "tags": { + "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", + "items": { + "type": "string" + }, + "type": "array" + }, + "testCaseConversationTurns": { + "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurn" + }, + "type": "array" + }, + "testConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestConfig", + "description": "Config for the test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestCaseError": { + "description": "Error info for importing a test.", + "id": "GoogleCloudDialogflowCxV3beta1TestCaseError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test case." + }, + "testCase": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCase", + "description": "The test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestCaseResult": { + "description": "Represents a result from running a test case in an agent environment.", + "id": "GoogleCloudDialogflowCxV3beta1TestCaseResult", + "properties": { + "conversationTurns": { + "description": "The conversation turns uttered during the test case replay in chronological order.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurn" + }, + "type": "array" + }, + "environment": { + "description": "Environment where the test was run. If not set, it indicates the draft environment.", + "type": "string" + }, + "name": { + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "type": "string" + }, + "testResult": { + "description": "Whether the test case passed in the agent environment.", + "enum": [ + "TEST_RESULT_UNSPECIFIED", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "Not specified. Should never be used.", + "The test passed.", + "The test did not pass." + ], + "type": "string" + }, + "testTime": { + "description": "The time that the test was run.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestConfig": { + "description": "Represents configurations for a test case.", + "id": "GoogleCloudDialogflowCxV3beta1TestConfig", + "properties": { + "flow": { + "description": "Flow name. If not set, default start flow is assumed. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "trackingParameters": { + "description": "Session parameters to be compared when calculating differences.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestError": { + "description": "Error info for running a test.", + "id": "GoogleCloudDialogflowCxV3beta1TestError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test." + }, + "testCase": { + "description": "The test case resource name.", + "type": "string" + }, + "testTime": { + "description": "The timestamp when the test was completed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestRunDifference": { + "description": "The description of differences between original and replayed agent output.", + "id": "GoogleCloudDialogflowCxV3beta1TestRunDifference", + "properties": { + "description": { + "description": "A description of the diff, showing the actual output vs expected output.", + "type": "string" + }, + "type": { + "description": "The type of diff.", + "enum": [ + "DIFF_TYPE_UNSPECIFIED", + "INTENT", + "PAGE", + "PARAMETERS", + "UTTERANCE" + ], + "enumDescriptions": [ + "Should never be used.", + "The intent.", + "The page.", + "The parameters.", + "The message utterance." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TextInput": { + "description": "Represents the natural language text to be processed.", + "id": "GoogleCloudDialogflowCxV3beta1TextInput", + "properties": { + "text": { + "description": "Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TransitionRoute": { + "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", + "properties": { + "condition": { + "description": "The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "intent": { + "description": "The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this transition route.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { + "description": "Metadata for UpdateDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", @@ -2359,6 +4772,15 @@ "description": "Represents intent information communicated to the webhook.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", "properties": { + "confidence": { + "description": "The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).", + "format": "float", + "type": "number" + }, + "displayName": { + "description": "Always present. The display name of the last matched intent.", + "type": "string" + }, "lastMatchedIntent": { "description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.", "type": "string" @@ -2755,7 +5177,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", "type": "object" } }, @@ -3003,7 +5425,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", "type": "object" } }, @@ -3131,20 +5553,6 @@ }, "type": "object" }, - "GoogleCloudDialogflowV2ImportDocumentsResponse": { - "description": "Response message for Documents.ImportDocuments.", - "id": "GoogleCloudDialogflowV2ImportDocumentsResponse", - "properties": { - "warnings": { - "description": "Includes details about skipped documents or any other warnings.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDialogflowV2InputAudioConfig": { "description": "Instructs the speech recognizer how to process the audio content.", "id": "GoogleCloudDialogflowV2InputAudioConfig", @@ -4255,7 +6663,7 @@ "readOnly": true }, "name": { - "description": "The unique identifier of the message. Format: `projects//conversations//messages/`.", + "description": "The unique identifier of the message. Format: `projects//locations//conversations//messages/`.", "type": "string" }, "participant": { @@ -4416,6 +6824,13 @@ "timeZone": { "description": "The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.", "type": "string" + }, + "webhookHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: \"Host\", \"Content-Length\", \"Connection\", \"From\", \"User-Agent\", \"Accept-Encoding\", \"If-Modified-Since\", \"If-None-Match\", \"X-Forwarded-For\", etc.", + "type": "object" } }, "type": "object" @@ -4476,7 +6891,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", "type": "object" }, "queryText": { @@ -4711,7 +7126,7 @@ ], "enumDescriptions": [ "Not specified. This value should never be used.", - "The agent doesn't follow Dialogflow best practicies.", + "The agent doesn't follow Dialogflow best practices.", "The agent may not behave as expected.", "The agent may experience partial failures.", "The agent may completely fail." @@ -4833,71 +7248,6 @@ }, "type": "object" }, - "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset": { - "description": "Represents an annotated conversation dataset. ConversationDataset can have multiple AnnotatedConversationDataset, each of them represents one result from one annotation task. AnnotatedConversationDataset can only be generated from annotation task, which will be triggered by LabelConversation.", - "id": "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset", - "properties": { - "completedExampleCount": { - "description": "Output only. Number of examples that have annotations in the annotated conversation dataset.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "createTime": { - "description": "Output only. Creation time of this annotated conversation dataset.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Optional. The description of the annotated conversation dataset. Maximum of 10000 bytes.", - "type": "string" - }, - "displayName": { - "description": "Required. The display name of the annotated conversation dataset. It's specified when user starts an annotation task. Maximum of 64 bytes.", - "type": "string" - }, - "exampleCount": { - "description": "Output only. Number of examples in the annotated conversation dataset.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. AnnotatedConversationDataset resource name. Format: `projects//conversationDatasets//annotatedConversationDatasets/`", - "readOnly": true, - "type": "string" - }, - "questionTypeName": { - "description": "Output only. Question type name that identifies a labeling task. A question is a single task that a worker answers. A question type is set of related questions. Each question belongs to a particular question type. It can be used in CrowdCompute UI to filter and manage labeling tasks.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse": { - "description": "Response message for [Documents.AutoApproveSmartMessagingEntries].", - "id": "GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse", - "properties": { - "disabledCount": { - "description": "Number of smart messaging entries disabled.", - "format": "int32", - "type": "integer" - }, - "enabledCount": { - "description": "Number of smart messaging entries enabled.", - "format": "int32", - "type": "integer" - }, - "unreviewedCount": { - "description": "Number of smart messaging entries unreviewed.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": { "description": "The response message for EntityTypes.BatchUpdateEntityTypes.", "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse", @@ -4926,20 +7276,6 @@ }, "type": "object" }, - "GoogleCloudDialogflowV2beta1BatchUpdateSmartMessagingEntriesResponse": { - "description": "Response message for [Documents.BatchUpdateSmartMessagingEntries]", - "id": "GoogleCloudDialogflowV2beta1BatchUpdateSmartMessagingEntriesResponse", - "properties": { - "smartMessagingEntries": { - "description": "List of updated smart message entries.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1SmartMessagingEntry" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDialogflowV2beta1Context": { "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", "id": "GoogleCloudDialogflowV2beta1Context", @@ -4958,7 +7294,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", "type": "object" } }, @@ -5053,7 +7389,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", "type": "object" } }, @@ -5075,20 +7411,6 @@ }, "type": "object" }, - "GoogleCloudDialogflowV2beta1ImportDocumentsResponse": { - "description": "Response message for Documents.ImportDocuments.", - "id": "GoogleCloudDialogflowV2beta1ImportDocumentsResponse", - "properties": { - "warnings": { - "description": "Includes details about skipped documents or any other warnings.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -6369,17 +8691,6 @@ }, "type": "object" }, - "GoogleCloudDialogflowV2beta1LabelConversationResponse": { - "description": "The response for ConversationDatasets.LabelConversation.", - "id": "GoogleCloudDialogflowV2beta1LabelConversationResponse", - "properties": { - "annotatedConversationDataset": { - "$ref": "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset", - "description": "New annotated conversation dataset created by the labeling task." - } - }, - "type": "object" - }, "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": { "description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.", "id": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest", @@ -6463,7 +8774,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", "type": "object" }, "queryText": { @@ -6554,66 +8865,6 @@ }, "type": "object" }, - "GoogleCloudDialogflowV2beta1SmartMessagingEntry": { - "description": "Smart Messaging Entry resource.", - "id": "GoogleCloudDialogflowV2beta1SmartMessagingEntry", - "properties": { - "messageInfo": { - "$ref": "GoogleCloudDialogflowV2beta1SmartMessagingEntryInfo", - "description": "Output only. Metadata of the message entry" - }, - "name": { - "description": "The unique identifier of this message entry. Required for [Documents.GetSmartMessagingEntry], [Documents.CreateSmartMessagingEntry], [Documents.UpdateSmartMessagingEntry], and [Documents.DeleteSmartMessagingEntry]. Format: `projects//knowledgeBases//documents//smartMessagingEntries/`", - "type": "string" - }, - "rawText": { - "description": "Required. The raw text of the message.", - "type": "string" - }, - "state": { - "description": "Required. Smart Messaging Entry's enabled/disabled state.", - "enum": [ - "SMART_MESSAGING_ENTRY_STATE_UNSPECIFIED", - "ENABLED", - "DISABLED" - ], - "enumDescriptions": [ - "State unspecified.", - "This smart reply message is enabled and used when generating suggestions.", - "This smart reply message is disabled and is not used when generating suggestions." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SmartMessagingEntryInfo": { - "description": "Smart messaging entry info.", - "id": "GoogleCloudDialogflowV2beta1SmartMessagingEntryInfo", - "properties": { - "creationMethod": { - "description": "Output only. Method of how the smart messaging entry was created. When the smart messaging entry was generated from GenerateDocument, the value is AUTOMATIC; when the entry was manually added through CreateSmartMessagingEntry, the value is MANUAL.", - "enum": [ - "CREATION_METHOD_UNSPECIFIED", - "AUTOMATIC", - "MANUAL" - ], - "enumDescriptions": [ - "The creation method of the smart messaging entry is unspecified. The value is unused.", - "The smart messaging entry was generated automatically from backend pipeline.", - "The smart messaging entry was added manually." - ], - "readOnly": true, - "type": "string" - }, - "occurrenceCount": { - "description": "The number of times an entry's message text has been uttered", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "GoogleCloudDialogflowV2beta1WebhookRequest": { "description": "The request message for a webhook call.", "id": "GoogleCloudDialogflowV2beta1WebhookRequest", @@ -6696,75 +8947,99 @@ }, "type": "object" }, - "GoogleCloudDialogflowV3alpha1ExportAgentResponse": { - "description": "The response message for Agents.ExportAgent.", - "id": "GoogleCloudDialogflowV3alpha1ExportAgentResponse", + "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": { + "description": "Metadata for CreateDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata", "properties": { - "agentContent": { - "description": "Uncompressed raw byte content for agent.", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.", + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": { + "description": "Metadata for DeleteDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": { + "description": "Metadata in google::longrunning::Operation for Knowledge operations.", + "id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "properties": { + "state": { + "description": "Required. Output only. The current state of this operation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed." + ], + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDialogflowV3alpha1ExportTestCasesMetadata": { - "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", - "id": "GoogleCloudDialogflowV3alpha1ExportTestCasesMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ExportTestCasesResponse": { - "description": "The response message for TestCases.ExportTestCases.", - "id": "GoogleCloudDialogflowV3alpha1ExportTestCasesResponse", + "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": { + "description": "Metadata for ImportDocuments operation.", + "id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata", "properties": { - "content": { - "description": "Uncompressed raw byte content for test cases.", - "format": "byte", - "type": "string" - }, - "gcsUri": { - "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", - "type": "string" + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." } }, "type": "object" }, - "GoogleCloudDialogflowV3alpha1ImportAgentResponse": { - "description": "The response message for Agents.ImportAgent.", - "id": "GoogleCloudDialogflowV3alpha1ImportAgentResponse", + "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": { + "description": "Response message for Documents.ImportDocuments.", + "id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse", "properties": { - "agent": { - "description": "The unique identifier of the new agent. Format: `projects//locations//agents/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ImportTestCasesMetadata": { - "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", - "id": "GoogleCloudDialogflowV3alpha1ImportTestCasesMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ImportTestCasesResponse": { - "description": "The response message for TestCases.ImportTestCases.", - "id": "GoogleCloudDialogflowV3alpha1ImportTestCasesResponse", - "properties": { - "names": { - "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", + "warnings": { + "description": "Includes details about skipped documents or any other warnings.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, + "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": { + "description": "Metadata for ReloadDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": { + "description": "Metadata for UpdateDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse", @@ -6852,7 +9127,7 @@ "type": "object" }, "GoogleTypeLatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "GoogleTypeLatLng", "properties": { "latitude": {
diff --git a/discovery/googleapis/dialogflow__v3.json b/discovery/googleapis/dialogflow__v3.json new file mode 100644 index 0000000..8e31500 --- /dev/null +++ b/discovery/googleapis/dialogflow__v3.json
@@ -0,0 +1,11402 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/dialogflow": { + "description": "View, manage and query your Dialogflow agents" + } + } + } + }, + "basePath": "", + "baseUrl": "https://dialogflow.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Dialogflow", + "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/dialogflow/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "dialogflow:v3", + "kind": "discovery#restDescription", + "name": "dialogflow", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "agents": { + "methods": { + "create": { + "description": "Creates an agent in the specified location.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location to create a agent for. Format: `projects//locations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/agents", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Agent" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified agent.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the agent to delete. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "export": { + "description": "Exports the specified agent to a binary file.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the agent to export. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:export", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ExportAgentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the agent. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "getValidationResult": { + "description": "Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.getValidationResult", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "If not specified, the agent's default language is used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The agent name. Format: `projects//locations//agents//validationResult`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/validationResult$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3AgentValidationResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all agents in the specified location.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location to list all agents for. Format: `projects//locations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/agents", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListAgentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified agent.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Agent" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "restore": { + "description": "Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the agent to restore into. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:restore", + "request": { + "$ref": "GoogleCloudDialogflowCxV3RestoreAgentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "validate": { + "description": "Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.validate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The agent to validate. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:validate", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ValidateAgentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3AgentValidationResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + }, + "resources": { + "entityTypes": { + "methods": { + "create": { + "description": "Creates an entity type in the specified agent.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.entityTypes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `entity_type`: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to create a entity type for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/entityTypes", + "request": { + "$ref": "GoogleCloudDialogflowCxV3EntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3EntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified entity type.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.entityTypes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "This field has no effect for entity type not being used. For entity types that are used by intents or pages: * If `force` is set to false, an error will be returned with message indicating the referencing resources. * If `force` is set to true, Dialogflow will remove the entity type, as well as any references to the entity type (i.e. Page parameter of the entity type will be changed to '@sys.any' and intent parameter of the entity type will be removed).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the entity type to delete. Format: `projects//locations//agents//entityTypes/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified entity type.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.entityTypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language to retrieve the entity type for. The following fields are language dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the entity type. Format: `projects//locations//agents//entityTypes/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3EntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all entity types in the specified agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.entityTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language to list entity types for. The following fields are language dependent: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all entity types for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/entityTypes", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListEntityTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified entity type.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.entityTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `entity_type`: * `EntityType.entities.value` * `EntityType.entities.synonyms` * `EntityType.excluded_phrases.value` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: `projects//locations//agents//entityTypes/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3EntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3EntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "environments": { + "methods": { + "create": { + "description": "Creates an Environment in the specified Agent.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The Agent to create an Environment for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/environments", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Environment" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified Environment.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.environments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Environment to delete. Format: `projects//locations//agents//environments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified Environment.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.environments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Environment. Format: `projects//locations//agents//environments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all environments in the specified Agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.environments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 20 and at most 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The Agent to list all environments for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/environments", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListEnvironmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "lookupEnvironmentHistory": { + "description": "Looks up the history of the specified Environment.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.environments.lookupEnvironmentHistory", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the environment to look up the history for. Format: `projects//locations//agents//environments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}:lookupEnvironmentHistory", + "response": { + "$ref": "GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified Environment.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.environments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the environment. Format: `projects//locations//agents//environments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Environment" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + }, + "resources": { + "experiments": { + "methods": { + "create": { + "description": "Creates an Experiment in the specified Environment.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.experiments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The Agent to create an Environment for. Format: `projects//locations//agents//environments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/experiments", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified Experiment.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.environments.experiments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Environment to delete. Format: `projects//locations//agents//environments//experiments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified Experiment.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.environments.experiments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Environment. Format: `projects//locations//agents//environments//experiments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all experiments in the specified Environment.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.environments.experiments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 20 and at most 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/experiments", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListExperimentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified Experiment.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.environments.experiments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "start": { + "description": "Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.experiments.start", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the experiment to start. Format: `projects//locations//agents//environments//experiments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:start", + "request": { + "$ref": "GoogleCloudDialogflowCxV3StartExperimentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "stop": { + "description": "Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.experiments.stop", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the experiment to stop. Format: `projects//locations//agents//environments//experiments/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:stop", + "request": { + "$ref": "GoogleCloudDialogflowCxV3StopExperimentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "sessions": { + "methods": { + "detectIntent": { + "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.sessions.detectIntent", + "parameterOrder": [ + "session" + ], + "parameters": { + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+session}:detectIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3DetectIntentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3DetectIntentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "fulfillIntent": { + "description": "Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.sessions.fulfillIntent", + "parameterOrder": [ + "session" + ], + "parameters": { + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+session}:fulfillIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3FulfillIntentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3FulfillIntentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "matchIntent": { + "description": "Returns preliminary intent match results, doesn't change the session status.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.sessions.matchIntent", + "parameterOrder": [ + "session" + ], + "parameters": { + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+session}:matchIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3MatchIntentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3MatchIntentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + }, + "resources": { + "entityTypes": { + "methods": { + "create": { + "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/entityTypes", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified session entity type.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified session entity type.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all session entity types in the specified session.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/entityTypes", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified session entity type.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.environments.sessions.entityTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + } + } + }, + "flows": { + "methods": { + "create": { + "description": "Creates a flow in the specified agent.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to create a flow for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/flows", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Flow" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Flow" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes a specified flow.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.flows.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "This field has no effect for flows with no incoming transitions. For flows with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the flow, as well as any transitions to the flow (i.e. Target flow in event handlers or Target flow in transition routes that point to this flow will be cleared).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the flow to delete. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified flow.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language to retrieve the flow for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the flow to get. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Flow" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "getValidationResult": { + "description": "Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.getValidationResult", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "If not specified, the agent's default language is used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The flow name. Format: `projects//locations//agents//flows//validationResult`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/validationResult$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3FlowValidationResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all flows in the specified agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language to list flows for. The following fields are language dependent: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent containing the flows. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/flows", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListFlowsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified flow.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.flows.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `flow`: * `Flow.event_handlers.trigger_fulfillment.messages` * `Flow.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The unique identifier of the flow. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated. If `update_mask` is not specified, an error will be returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Flow" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Flow" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "train": { + "description": "Trains the specified flow. Note that only the flow in 'draft' environment is trained.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.train", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The flow to train. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:train", + "request": { + "$ref": "GoogleCloudDialogflowCxV3TrainFlowRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "validate": { + "description": "Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.validate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The flow to validate. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:validate", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ValidateFlowRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3FlowValidationResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + }, + "resources": { + "pages": { + "methods": { + "create": { + "description": "Creates a page in the specified flow.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.pages.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The flow to create a page for. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/pages", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Page" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Page" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified page.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.flows.pages.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "This field has no effect for pages with no incoming transitions. For pages with incoming transitions: * If `force` is set to false, an error will be returned with message indicating the incoming transitions. * If `force` is set to true, Dialogflow will remove the page, as well as any transitions to the page (i.e. Target page in event handlers or Target page in transition routes that point to this page will be cleared).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the page to delete. Format: `projects//locations//agents//Flows//pages/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified page.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.pages.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language to retrieve the page for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the page. Format: `projects//locations//agents//flows//pages/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Page" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all pages in the specified flow.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.pages.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language to list pages for. The following fields are language dependent: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The flow to list all pages for. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/pages", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListPagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified page.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.flows.pages.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `page`: * `Page.entry_fulfillment.messages` * `Page.form.parameters.fill_behavior.initial_prompt_fulfillment.messages` * `Page.form.parameters.fill_behavior.reprompt_event_handlers.messages` * `Page.transition_routes.trigger_fulfillment.messages` * `Page.transition_route_groups.transition_routes.trigger_fulfillment.messages` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/pages/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Page" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Page" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "transitionRouteGroups": { + "methods": { + "create": { + "description": "Creates an TransitionRouteGroup in the specified flow.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/transitionRouteGroups", + "request": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified TransitionRouteGroup.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If `force` is set to false, an error will be returned with message indicating pages that reference the transition route group. * If `force` is set to true, Dialogflow will remove the transition route group, as well as any reference to it.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the TransitionRouteGroup to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified TransitionRouteGroup.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all transition route groups in the specified flow.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/transitionRouteGroups", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified TransitionRouteGroup.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.flows.transitionRouteGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language to list transition route groups for. The field `messages` in TransitionRoute is language dependent. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/transitionRouteGroups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "versions": { + "methods": { + "create": { + "description": "Creates a Version in the specified Flow.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.versions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The Flow to create an Version for. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/versions", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Version" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified Version.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.flows.versions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Version to delete. Format: `projects//locations//agents//flows//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified Version.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.versions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Version. Format: `projects//locations//agents//flows//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all versions in the specified Flow.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.flows.versions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 20 and at most 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The Flow to list all versions for. Format: `projects//locations//agents//flows/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/versions", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "load": { + "description": "Loads a specified version to draft version.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.flows.versions.load", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Version to be loaded to draft version. Format: `projects//locations//agents//flows//versions/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:load", + "request": { + "$ref": "GoogleCloudDialogflowCxV3LoadVersionRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified Version.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.flows.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated. Currently only `description` and `display_name` can be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Version" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "intents": { + "methods": { + "create": { + "description": "Creates an intent in the specified agent.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.intents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to create an intent for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/intents", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Intent" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Intent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified intent.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.intents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the intent to delete. Format: `projects//locations//agents//intents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified intent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.intents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language to retrieve the intent for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the intent. Format: `projects//locations//agents//intents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Intent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all intents in the specified agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.intents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "intentView": { + "description": "The resource view to apply to the returned intent.", + "enum": [ + "INTENT_VIEW_UNSPECIFIED", + "INTENT_VIEW_PARTIAL", + "INTENT_VIEW_FULL" + ], + "enumDescriptions": [ + "Not specified. Treated as INTENT_VIEW_FULL.", + "Training phrases field is not populated in the response.", + "All fields are populated." + ], + "location": "query", + "type": "string" + }, + "languageCode": { + "description": "The language to list intents for. The following fields are language dependent: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all intents for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/intents", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListIntentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified intent.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.intents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "languageCode": { + "description": "The language of the following fields in `intent`: * `Intent.training_phrases.parts.text` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/intents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Intent" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Intent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "sessions": { + "methods": { + "detectIntent": { + "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.sessions.detectIntent", + "parameterOrder": [ + "session" + ], + "parameters": { + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session). Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+session}:detectIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3DetectIntentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3DetectIntentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "fulfillIntent": { + "description": "Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.sessions.fulfillIntent", + "parameterOrder": [ + "session" + ], + "parameters": { + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+session}:fulfillIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3FulfillIntentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3FulfillIntentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "matchIntent": { + "description": "Returns preliminary intent match results, doesn't change the session status.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.sessions.matchIntent", + "parameterOrder": [ + "session" + ], + "parameters": { + "session": { + "description": "Required. The name of the session this query is sent to. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length of the `Session ID` must not exceed 36 characters. For more information, see the [sessions guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+session}:matchIntent", + "request": { + "$ref": "GoogleCloudDialogflowCxV3MatchIntentRequest" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3MatchIntentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + }, + "resources": { + "entityTypes": { + "methods": { + "create": { + "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The session to create a session entity type for. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/entityTypes", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified session entity type.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the session entity type to delete. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified session entity type.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all session entity types in the specified session.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The session to list all session entity types from. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/entityTypes", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified session entity type.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.sessions.entityTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "testCases": { + "methods": { + "batchDelete": { + "description": "Batch deletes test cases.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to delete test cases from. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/testCases:batchDelete", + "request": { + "$ref": "GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "batchRun": { + "description": "Kicks off a batch run of test cases.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.batchRun", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Agent name. Format: `projects//locations//agents/ `.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/testCases:batchRun", + "request": { + "$ref": "GoogleCloudDialogflowCxV3BatchRunTestCasesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "calculateCoverage": { + "description": "Calculates the test coverage for an agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.testCases.calculateCoverage", + "parameterOrder": [ + "agent" + ], + "parameters": { + "agent": { + "description": "Required. The agent to calculate coverage for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "type": { + "description": "Required. The type of coverage requested.", + "enum": [ + "COVERAGE_TYPE_UNSPECIFIED", + "INTENT", + "PAGE_TRANSITION" + ], + "enumDescriptions": [ + "Should never be used.", + "Intent coverage.", + "Page transition coverage" + ], + "location": "query", + "type": "string" + } + }, + "path": "v3/{+agent}/testCases:calculateCoverage", + "response": { + "$ref": "GoogleCloudDialogflowCxV3CalculateCoverageResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "create": { + "description": "Creates a test case for the given agent.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create the test case for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/testCases", + "request": { + "$ref": "GoogleCloudDialogflowCxV3TestCase" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3TestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "export": { + "description": "Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent where to export test cases from. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/testCases:export", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ExportTestCasesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Gets a test case.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.testCases.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the testcase. Format: `projects//locations//agents//testCases/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3TestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "import": { + "description": "Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwite any existing ones. The provided ID in the imported test case is neglected.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to import test cases to. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/testCases:import", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ImportTestCasesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Fetches a list of test cases for a given agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.testCases.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 20. Note that when TestCaseView = FULL, the maximum page size allowed is 20. When TestCaseView = BASIC, the maximum page size allowed is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all pages for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Specifies whether response should include all fields or just the metadata.", + "enum": [ + "TEST_CASE_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the test case, but not the conversation turns. This is the default value.", + "Include everything." + ], + "location": "query", + "type": "string" + } + }, + "path": "v3/{+parent}/testCases", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListTestCasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified test case.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.testCases.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to specify which fields should be updated. The `creationTime` and `lastTestResult` cannot be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3TestCase" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3TestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "run": { + "description": "Kicks off a test case run.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.testCases.run", + "parameterOrder": [ + "projectsId", + "locationsId", + "agentsId" + ], + "parameters": { + "agentsId": { + "location": "path", + "required": true, + "type": "string" + }, + "locationsId": { + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases:run", + "request": { + "$ref": "GoogleCloudDialogflowCxV3RunTestCaseRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + }, + "resources": { + "results": { + "methods": { + "list": { + "description": "Fetches a list of results for a given test case.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.testCases.results.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression used to filter test case results. See [API Filtering](https://aip.dev/160). The expression is case insensitive. Only 'AND' is supported for logical operators. The supported syntax is listed below in detail: [AND ] ... [AND latest] The supported fields and operators are: field operator `environment` `=`, `IN` (Use value `draft` for draft environment) `test_time` `>`, `<` `latest` only returns the latest test result in all results for each test case. Examples: * \"environment=draft AND latest\" matches the latest test result for each test case in the draft environment. * \"environment IN (e1,e2)\" matches any test case results with an environment resource name of either \"e1\" or \"e2\". * \"test_time > 1602540713\" matches any test case results with test time later than a unix timestamp in seconds 1602540713.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/results", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListTestCaseResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "webhooks": { + "methods": { + "create": { + "description": "Creates a webhook in the specified agent.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.webhooks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a webhook for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/webhooks", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified webhook.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.agents.webhooks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the webhook to delete. Format: `projects//locations//agents//webhooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified webhook.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.webhooks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the webhook. Format: `projects//locations//agents//webhooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all webhooks in the specified agent.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.agents.webhooks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 100 and at most 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The agent to list all webhooks for. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/webhooks", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListWebhooksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified webhook.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.agents.webhooks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, + "securitySettings": { + "methods": { + "create": { + "description": "Create security settings in the specified location.", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.securitySettings.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location to create an SecuritySettings for. Format: `projects//locations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/securitySettings", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettings" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "delete": { + "description": "Deletes the specified SecuritySettings.", + "httpMethod": "DELETE", + "id": "dialogflow.projects.locations.securitySettings.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SecuritySettings to delete. Format: `projects//locations//securitySettings/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.securitySettings.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Returns the list of all security settings in the specified location.", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.securitySettings.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return in a single page. By default 20 and at most 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location to list all security settings for. Format: `projects//locations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/securitySettings", + "response": { + "$ref": "GoogleCloudDialogflowCxV3ListSecuritySettingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "patch": { + "description": "Updates the specified SecuritySettings.", + "httpMethod": "PATCH", + "id": "dialogflow.projects.locations.securitySettings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}", + "request": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettings" + }, + "response": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "dialogflow.projects.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "dialogflow.projects.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "dialogflow.projects.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + } + } + } + }, + "revision": "20210130", + "rootUrl": "https://dialogflow.googleapis.com/", + "schemas": { + "GoogleCloudDialogflowCxV3Agent": { + "description": "Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way. After you create an agent, you can add Intents, Entity Types, Flows, Fulfillments, Webhooks, and so on to manage the conversation flows..", + "id": "GoogleCloudDialogflowCxV3Agent", + "properties": { + "avatarUri": { + "description": "The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.", + "type": "string" + }, + "defaultLanguageCode": { + "description": "Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.", + "type": "string" + }, + "description": { + "description": "The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the agent, unique within the location.", + "type": "string" + }, + "enableSpellCorrection": { + "description": "Indicates if automatic spell correction is enabled in detect intent requests.", + "type": "boolean" + }, + "enableStackdriverLogging": { + "description": "Indicates if stackdriver logging is enabled for the agent.", + "type": "boolean" + }, + "name": { + "description": "The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`.", + "type": "string" + }, + "securitySettings": { + "description": "Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`.", + "type": "string" + }, + "speechToTextSettings": { + "$ref": "GoogleCloudDialogflowCxV3SpeechToTextSettings", + "description": "Speech recognition related settings." + }, + "startFlow": { + "description": "Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3AgentValidationResult": { + "description": "The response message for Agents.GetAgentValidationResult.", + "id": "GoogleCloudDialogflowCxV3AgentValidationResult", + "properties": { + "flowValidationResults": { + "description": "Contains all flow validation results.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FlowValidationResult" + }, + "type": "array" + }, + "name": { + "description": "The unique identifier of the agent validation result. Format: `projects//locations//agents//validationResult`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3AudioInput": { + "description": "Represents the natural speech audio to be processed.", + "id": "GoogleCloudDialogflowCxV3AudioInput", + "properties": { + "audio": { + "description": "The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.", + "format": "byte", + "type": "string" + }, + "config": { + "$ref": "GoogleCloudDialogflowCxV3InputAudioConfig", + "description": "Required. Instructs the speech recognizer how to process the speech audio." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest": { + "description": "The request message for TestCases.BatchDeleteTestCases.", + "id": "GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest", + "properties": { + "names": { + "description": "Required. Format of test case names: `projects//locations/ /agents//testCases/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata": { + "description": "Metadata returned for the TestCases.BatchRunTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3BatchRunTestCasesMetadata", + "properties": { + "errors": { + "description": "The test errors.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3BatchRunTestCasesRequest": { + "description": "The request message for TestCases.BatchRunTestCases.", + "id": "GoogleCloudDialogflowCxV3BatchRunTestCasesRequest", + "properties": { + "environment": { + "description": "Optional. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.", + "type": "string" + }, + "testCases": { + "description": "Required. Format: `projects//locations//agents//testCases/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3BatchRunTestCasesResponse": { + "description": "The response message for TestCases.BatchRunTestCases.", + "id": "GoogleCloudDialogflowCxV3BatchRunTestCasesResponse", + "properties": { + "results": { + "description": "The test case results. The detailed conversation turns are empty in this response.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3CalculateCoverageResponse": { + "description": "The response message for TestCases.CalculateCoverage.", + "id": "GoogleCloudDialogflowCxV3CalculateCoverageResponse", + "properties": { + "agent": { + "description": "The agent to calculate coverage for. Format: `projects//locations//agents/`.", + "type": "string" + }, + "intentCoverage": { + "$ref": "GoogleCloudDialogflowCxV3IntentCoverage", + "description": "Intent coverage." + }, + "transitionCoverage": { + "$ref": "GoogleCloudDialogflowCxV3TransitionCoverage", + "description": "Transition coverage." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ConversationTurn": { + "description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.", + "id": "GoogleCloudDialogflowCxV3ConversationTurn", + "properties": { + "userInput": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurnUserInput", + "description": "The user input." + }, + "virtualAgentOutput": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput", + "description": "The virtual agent output." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ConversationTurnUserInput": { + "description": "The input from the human user.", + "id": "GoogleCloudDialogflowCxV3ConversationTurnUserInput", + "properties": { + "injectedParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Parameters that need to be injected into the conversation during intent detection.", + "type": "object" + }, + "input": { + "$ref": "GoogleCloudDialogflowCxV3QueryInput", + "description": "Supports text input, event input, dtmf input in the test case." + }, + "isWebhookEnabled": { + "description": "If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput": { + "description": "The output from the virtual agent.", + "id": "GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput", + "properties": { + "currentPage": { + "$ref": "GoogleCloudDialogflowCxV3Page", + "description": "The Page on which the utterance was spoken. Only some fields such as name and displayname will be set." + }, + "diagnosticInfo": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. Input only. The diagnostic info output for the turn.", + "type": "object" + }, + "differences": { + "description": "Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestRunDifference" + }, + "readOnly": true, + "type": "array" + }, + "sessionParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The session parameters available to the bot at this point.", + "type": "object" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "Response error from the agent in the test result. If set, other output is empty." + }, + "textResponses": { + "description": "The text responses from the agent for the turn.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText" + }, + "type": "array" + }, + "triggeredIntent": { + "$ref": "GoogleCloudDialogflowCxV3Intent", + "description": "The Intent that triggered the response. Only some fields such as name and displayname will be set." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": { + "description": "Metadata for CreateDocument operation.", + "id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": { + "description": "Metadata associated with the long running operation for Versions.CreateVersion.", + "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata", + "properties": { + "version": { + "description": "Name of the created version. Format: `projects//locations//agents//flows//versions/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { + "description": "Metadata for DeleteDocument operation.", + "id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DetectIntentRequest": { + "description": "The request to detect user's intent.", + "id": "GoogleCloudDialogflowCxV3DetectIntentRequest", + "properties": { + "outputAudioConfig": { + "$ref": "GoogleCloudDialogflowCxV3OutputAudioConfig", + "description": "Instructs the speech synthesizer how to generate the output audio." + }, + "queryInput": { + "$ref": "GoogleCloudDialogflowCxV3QueryInput", + "description": "Required. The input specification." + }, + "queryParams": { + "$ref": "GoogleCloudDialogflowCxV3QueryParameters", + "description": "The parameters of this query." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DetectIntentResponse": { + "description": "The message returned from the DetectIntent method.", + "id": "GoogleCloudDialogflowCxV3DetectIntentResponse", + "properties": { + "outputAudio": { + "description": "The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.response_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.", + "format": "byte", + "type": "string" + }, + "outputAudioConfig": { + "$ref": "GoogleCloudDialogflowCxV3OutputAudioConfig", + "description": "The config used by the speech synthesizer to generate the output audio." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowCxV3QueryResult", + "description": "The result of the conversational query." + }, + "responseId": { + "description": "Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3DtmfInput": { + "description": "Represents the input for dtmf event.", + "id": "GoogleCloudDialogflowCxV3DtmfInput", + "properties": { + "digits": { + "description": "The dtmf digits.", + "type": "string" + }, + "finishDigit": { + "description": "The finish digit (if any).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EntityType": { + "description": "Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application. When you define an entity, you can also include synonyms that all map to that entity. For example, \"soft drink\", \"soda\", \"pop\", and so on. There are three types of entities: * **System** - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the `EntityType` type. * **Custom** - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a `pizza.sauce` entity for red or white pizza sauce, a `pizza.cheese` entity for the different types of cheese on a pizza, a `pizza.topping` entity for different toppings, and so on. A custom entity is represented by the `EntityType` type. * **User** - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the SessionEntityType type. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).", + "id": "GoogleCloudDialogflowCxV3EntityType", + "properties": { + "autoExpansionMode": { + "description": "Indicates whether the entity type can be automatically expanded.", + "enum": [ + "AUTO_EXPANSION_MODE_UNSPECIFIED", + "AUTO_EXPANSION_MODE_DEFAULT" + ], + "enumDescriptions": [ + "Auto expansion disabled for the entity.", + "Allows an agent to recognize values that have not been explicitly listed in the entity." + ], + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the entity type, unique within the agent.", + "type": "string" + }, + "enableFuzzyExtraction": { + "description": "Enables fuzzy entity extraction during classification.", + "type": "boolean" + }, + "entities": { + "description": "The collection of entity entries associated with the entity type.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EntityTypeEntity" + }, + "type": "array" + }, + "excludedPhrases": { + "description": "Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry `giant`(an adjective), you might consider adding `giants`(a noun) as an exclusion. If the kind of entity type is `KIND_MAP`, then the phrases specified by entities and excluded phrases should be mutually exclusive.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EntityTypeExcludedPhrase" + }, + "type": "array" + }, + "kind": { + "description": "Required. Indicates the kind of entity type.", + "enum": [ + "KIND_UNSPECIFIED", + "KIND_MAP", + "KIND_LIST", + "KIND_REGEXP" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "Map entity types allow mapping of a group of synonyms to a canonical value.", + "List entity types contain a set of entries that do not map to canonical values. However, list entity types can contain references to other entity types (with or without aliases).", + "Regexp entity types allow to specify regular expressions in entries values." + ], + "type": "string" + }, + "name": { + "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: `projects//locations//agents//entityTypes/`.", + "type": "string" + }, + "redact": { + "description": "Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EntityTypeEntity": { + "description": "An **entity entry** for an associated entity type.", + "id": "GoogleCloudDialogflowCxV3EntityTypeEntity", + "properties": { + "synonyms": { + "description": "Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "value": { + "description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EntityTypeExcludedPhrase": { + "description": "An excluded entity phrase that should not be matched.", + "id": "GoogleCloudDialogflowCxV3EntityTypeExcludedPhrase", + "properties": { + "value": { + "description": "Required. The word or phrase to be excluded.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Environment": { + "description": "Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.", + "id": "GoogleCloudDialogflowCxV3Environment", + "properties": { + "description": { + "description": "The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.", + "type": "string" + }, + "name": { + "description": "The name of the environment. Format: `projects//locations//agents//environments/`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Update time of this environment.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "versionConfigs": { + "description": "Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from `Start Flow` in the agent. Otherwise, an error will be returned.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EnvironmentVersionConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EnvironmentVersionConfig": { + "description": "Configuration for the version.", + "id": "GoogleCloudDialogflowCxV3EnvironmentVersionConfig", + "properties": { + "version": { + "description": "Required. Format: projects//locations//agents//flows//versions/.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EventHandler": { + "description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3EventHandler", + "properties": { + "event": { + "description": "Required. The name of the event to handle.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this event handler.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3EventInput": { + "description": "Represents the event to trigger.", + "id": "GoogleCloudDialogflowCxV3EventInput", + "properties": { + "event": { + "description": "Name of the event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Experiment": { + "description": "Represents an experiment in an environment.", + "id": "GoogleCloudDialogflowCxV3Experiment", + "properties": { + "createTime": { + "description": "Creation time of this experiment.", + "format": "google-datetime", + "type": "string" + }, + "definition": { + "$ref": "GoogleCloudDialogflowCxV3ExperimentDefinition", + "description": "The definition of the experiment." + }, + "description": { + "description": "The human-readable description of the experiment.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.", + "type": "string" + }, + "endTime": { + "description": "End time of this experiment.", + "format": "google-datetime", + "type": "string" + }, + "experimentLength": { + "description": "Maximum number of days to run the experiment.", + "format": "google-duration", + "type": "string" + }, + "lastUpdateTime": { + "description": "Last update time of this experiment.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "type": "string" + }, + "result": { + "$ref": "GoogleCloudDialogflowCxV3ExperimentResult", + "description": "Inference result of the experiment." + }, + "startTime": { + "description": "Start time of this experiment.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The current state of the experiment. Transition triggered by Expriments.StartExperiment: PENDING->RUNNING. Transition triggered by Expriments.CancelExperiment: PENDING->CANCELLED or RUNNING->CANCELLED.", + "enum": [ + "STATE_UNSPECIFIED", + "DRAFT", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The experiment is created but not started yet.", + "The experiment is running.", + "The experiment is done." + ], + "type": "string" + }, + "variantsHistory": { + "description": "The history of updates to the experiment variants.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3VariantsHistory" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExperimentDefinition": { + "description": "Definition of the experiment.", + "id": "GoogleCloudDialogflowCxV3ExperimentDefinition", + "properties": { + "condition": { + "description": "The condition defines which subset of sessions are selected for this experiment. If not specified, all sessions are eligible. E.g. \"query_input.language_code=en\" See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).", + "type": "string" + }, + "versionVariants": { + "$ref": "GoogleCloudDialogflowCxV3VersionVariants", + "description": "The flow versions as the variants of this experiment." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExperimentResult": { + "description": "The inference result which includes an objective metric to optimize and the confidence interval.", + "id": "GoogleCloudDialogflowCxV3ExperimentResult", + "properties": { + "lastUpdateTime": { + "description": "The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.", + "format": "google-datetime", + "type": "string" + }, + "versionMetrics": { + "description": "Version variants and metrics.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExperimentResultConfidenceInterval": { + "description": "A confidence interval is a range of possible values for the experiment objective you are trying to measure.", + "id": "GoogleCloudDialogflowCxV3ExperimentResultConfidenceInterval", + "properties": { + "confidenceLevel": { + "description": "The confidence level used to construct the interval, i.e. there is X% chance that the true value is within this interval.", + "format": "double", + "type": "number" + }, + "lowerBound": { + "description": "Lower bound of the interval.", + "format": "double", + "type": "number" + }, + "ratio": { + "description": "The percent change between an experiment metric's value and the value for its control.", + "format": "double", + "type": "number" + }, + "upperBound": { + "description": "Upper bound of the interval.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExperimentResultMetric": { + "description": "Metric and corresponding confidence intervals.", + "id": "GoogleCloudDialogflowCxV3ExperimentResultMetric", + "properties": { + "confidenceInterval": { + "$ref": "GoogleCloudDialogflowCxV3ExperimentResultConfidenceInterval", + "description": "The probability that the treatment is better than all other treatments in the experiment" + }, + "count": { + "description": "Count value of a metric.", + "format": "double", + "type": "number" + }, + "countType": { + "description": "Count-based metric type. Only one of type or count_type is specified in each Metric.", + "enum": [ + "COUNT_TYPE_UNSPECIFIED", + "TOTAL_NO_MATCH_COUNT", + "TOTAL_TURN_COUNT", + "AVERAGE_TURN_COUNT" + ], + "enumDescriptions": [ + "Count type unspecified.", + "Total number of occurrences of a 'NO_MATCH'.", + "Total number of turn counts.", + "Average turn count in a session." + ], + "type": "string" + }, + "ratio": { + "description": "Ratio value of a metric.", + "format": "double", + "type": "number" + }, + "type": { + "description": "Ratio-based metric type. Only one of type or count_type is specified in each Metric.", + "enum": [ + "METRIC_UNSPECIFIED", + "CONTAINED_SESSION_NO_CALLBACK_RATE", + "LIVE_AGENT_HANDOFF_RATE", + "CALLBACK_SESSION_RATE", + "ABANDONED_SESSION_RATE", + "SESSION_END_RATE" + ], + "enumDescriptions": [ + "Metric unspecified.", + "Percentage of contained sessions without user calling back in 24 hours.", + "Percentage of sessions that were handed to a human agent.", + "Percentage of sessions with the same user calling back.", + "Percentage of sessions where user hung up.", + "Percentage of sessions reached Dialogflow 'END_PAGE' or 'END_SESSION'." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics": { + "description": "Version variant and associated metrics.", + "id": "GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics", + "properties": { + "metrics": { + "description": "The metrics and corresponding confidence intervals in the inference result.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ExperimentResultMetric" + }, + "type": "array" + }, + "sessionCount": { + "description": "Number of sessions that were allocated to this version.", + "format": "int32", + "type": "integer" + }, + "version": { + "description": "The name of the flow Version. Format: `projects//locations//agents//flows//versions/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportAgentRequest": { + "description": "The request message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowCxV3ExportAgentRequest", + "properties": { + "agentUri": { + "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowCxV3ExportAgentResponse", + "properties": { + "agentContent": { + "description": "Uncompressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportTestCasesRequest": { + "description": "The request message for TestCases.ExportTestCases.", + "id": "GoogleCloudDialogflowCxV3ExportTestCasesRequest", + "properties": { + "dataFormat": { + "description": "The data format of the exported test cases. If not specified, `BLOB` is assumed.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "BLOB", + "JSON" + ], + "enumDescriptions": [ + "Unspecified format.", + "Raw bytes.", + "JSON format." + ], + "type": "string" + }, + "filter": { + "description": "The filter expression used to filter exported test cases, see [API Filtering](https://aip.dev/160). The expression is case insensitive and supports the following syntax: name = [OR name = ] ... For example: * \"name = t1 OR name = t2\" matches the test case with the exact resource name \"t1\" or \"t2\".", + "type": "string" + }, + "gcsUri": { + "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the test cases to. The format of this URI must be `gs:///`. If unspecified, the serialized test cases is returned inline.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportTestCasesResponse": { + "description": "The response message for TestCases.ExportTestCases.", + "id": "GoogleCloudDialogflowCxV3ExportTestCasesResponse", + "properties": { + "content": { + "description": "Uncompressed raw byte content for test cases.", + "format": "byte", + "type": "string" + }, + "gcsUri": { + "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Flow": { + "description": "Flows represents the conversation flows when you build your chatbot agent. A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started. Usually, when a transition route is followed by a matched intent, the intent will be \"consumed\". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.", + "id": "GoogleCloudDialogflowCxV3Flow", + "properties": { + "description": { + "description": "The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the flow.", + "type": "string" + }, + "eventHandlers": { + "description": "A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EventHandler" + }, + "type": "array" + }, + "name": { + "description": "The unique identifier of the flow. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "nluSettings": { + "$ref": "GoogleCloudDialogflowCxV3NluSettings", + "description": "NLU related settings of the flow." + }, + "transitionRoutes": { + "description": "A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying \"help\" or \"can I talk to a human?\", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified.. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FlowValidationResult": { + "description": "The response message for Flows.GetFlowValidationResult.", + "id": "GoogleCloudDialogflowCxV3FlowValidationResult", + "properties": { + "name": { + "description": "The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`.", + "type": "string" + }, + "updateTime": { + "description": "Last time the flow was validated.", + "format": "google-datetime", + "type": "string" + }, + "validationMessages": { + "description": "Contains all validation messages.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ValidationMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Form": { + "description": "A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.", + "id": "GoogleCloudDialogflowCxV3Form", + "properties": { + "parameters": { + "description": "Parameters to collect from the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FormParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FormParameter": { + "description": "Represents a form parameter.", + "id": "GoogleCloudDialogflowCxV3FormParameter", + "properties": { + "defaultValue": { + "description": "The default value of an optional parameter. If the parameter is required, the default value will be ignored.", + "type": "any" + }, + "displayName": { + "description": "Required. The human-readable name of the parameter, unique within the form.", + "type": "string" + }, + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "fillBehavior": { + "$ref": "GoogleCloudDialogflowCxV3FormParameterFillBehavior", + "description": "Required. Defines fill behavior for the parameter." + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + }, + "required": { + "description": "Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FormParameterFillBehavior": { + "description": "Configuration for how the filling of a parameter should be handled.", + "id": "GoogleCloudDialogflowCxV3FormParameterFillBehavior", + "properties": { + "initialPromptFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter." + }, + "repromptEventHandlers": { + "description": "The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EventHandler" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillIntentRequest": { + "description": "Request of FulfillIntent", + "id": "GoogleCloudDialogflowCxV3FulfillIntentRequest", + "properties": { + "match": { + "$ref": "GoogleCloudDialogflowCxV3Match", + "description": "The matched intent/event to fulfill." + }, + "matchIntentRequest": { + "$ref": "GoogleCloudDialogflowCxV3MatchIntentRequest", + "description": "Must be same as the corresponding MatchIntent request, otherwise the behavior is undefined." + }, + "outputAudioConfig": { + "$ref": "GoogleCloudDialogflowCxV3OutputAudioConfig", + "description": "Instructs the speech synthesizer how to generate output audio." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillIntentResponse": { + "description": "Response of FulfillIntent", + "id": "GoogleCloudDialogflowCxV3FulfillIntentResponse", + "properties": { + "outputAudio": { + "description": "The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.response_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.", + "format": "byte", + "type": "string" + }, + "outputAudioConfig": { + "$ref": "GoogleCloudDialogflowCxV3OutputAudioConfig", + "description": "The config used by the speech synthesizer to generate the output audio." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowCxV3QueryResult", + "description": "The result of the conversational query." + }, + "responseId": { + "description": "Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Fulfillment": { + "description": "A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.", + "id": "GoogleCloudDialogflowCxV3Fulfillment", + "properties": { + "conditionalCases": { + "description": "Conditional cases for this fulfillment.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases" + }, + "type": "array" + }, + "messages": { + "description": "The list of rich message responses to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" + }, + "type": "array" + }, + "setParameterActions": { + "description": "Set parameter values before executing the webhook.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction" + }, + "type": "array" + }, + "tag": { + "description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified.", + "type": "string" + }, + "webhook": { + "description": "The webhook to call. Format: `projects//locations//agents//webhooks/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentConditionalCases": { + "description": "A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.", + "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases", + "properties": { + "cases": { + "description": "A list of cascading if-else conditions.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase": { + "description": "Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.", + "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase", + "properties": { + "caseContent": { + "description": "A list of case content.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent" + }, + "type": "array" + }, + "condition": { + "description": "The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent": { + "description": "The list of messages or conditional cases to activate for this case.", + "id": "GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent", + "properties": { + "additionalCases": { + "$ref": "GoogleCloudDialogflowCxV3FulfillmentConditionalCases", + "description": "Additional cases to be evaluated." + }, + "message": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage", + "description": "Returned message." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction": { + "description": "Setting a parameter value.", + "id": "GoogleCloudDialogflowCxV3FulfillmentSetParameterAction", + "properties": { + "parameter": { + "description": "Display name of the parameter.", + "type": "string" + }, + "value": { + "description": "The new value of the parameter. A null value clears the parameter.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": { + "description": "Metadata in google::longrunning::Operation for Knowledge operations.", + "id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "properties": { + "state": { + "description": "Required. Output only. The current state of this operation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": { + "description": "Metadata for ImportDocuments operation.", + "id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportDocumentsResponse": { + "description": "Response message for Documents.ImportDocuments.", + "id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse", + "properties": { + "warnings": { + "description": "Includes details about skipped documents or any other warnings.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", + "properties": { + "errors": { + "description": "Errors for failed test cases.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportTestCasesRequest": { + "description": "The request message for TestCases.ImportTestCases.", + "id": "GoogleCloudDialogflowCxV3ImportTestCasesRequest", + "properties": { + "content": { + "description": "Uncompressed raw byte content for test cases.", + "format": "byte", + "type": "string" + }, + "gcsUri": { + "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import test cases from. The format of this URI must be `gs:///`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportTestCasesResponse": { + "description": "The response message for TestCases.ImportTestCases.", + "id": "GoogleCloudDialogflowCxV3ImportTestCasesResponse", + "properties": { + "names": { + "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3InputAudioConfig": { + "description": "Instructs the speech recognizer on how to process the audio content.", + "id": "GoogleCloudDialogflowCxV3InputAudioConfig", + "properties": { + "audioEncoding": { + "description": "Required. Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "model": { + "description": "Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.", + "type": "string" + }, + "modelVariant": { + "description": "Optional. Which variant of the Speech model to use.", + "enum": [ + "SPEECH_MODEL_VARIANT_UNSPECIFIED", + "USE_BEST_AVAILABLE", + "USE_STANDARD", + "USE_ENHANCED" + ], + "enumDescriptions": [ + "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", + "Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.", + "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", + "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible." + ], + "type": "string" + }, + "phraseHints": { + "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, + "singleUtterance": { + "description": "Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Intent": { + "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.", + "id": "GoogleCloudDialogflowCxV3Intent", + "properties": { + "description": { + "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the intent, unique within the agent.", + "type": "string" + }, + "isFallback": { + "description": "Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.", + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys.\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys.head * sys.contextual The above labels do not require value. \"sys.head\" means the intent is a head intent. \"sys.contextual\" means the intent is a contextual intent.", + "type": "object" + }, + "name": { + "description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.", + "type": "string" + }, + "parameters": { + "description": "The collection of parameters associated with the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3IntentParameter" + }, + "type": "array" + }, + "priority": { + "description": "The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", + "format": "int32", + "type": "integer" + }, + "trainingPhrases": { + "description": "The collection of training phrases the agent is trained on to identify the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3IntentTrainingPhrase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentCoverage": { + "description": "Intent coverage represents the percentage of all possible intents in the agent that are triggered in any of a parent's test cases.", + "id": "GoogleCloudDialogflowCxV3IntentCoverage", + "properties": { + "coverageScore": { + "description": "The percent of intents in the agent that are covered.", + "format": "float", + "type": "number" + }, + "intents": { + "description": "The list of Intents present in the agent", + "items": { + "$ref": "GoogleCloudDialogflowCxV3IntentCoverageIntent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentCoverageIntent": { + "description": "The agent's intent.", + "id": "GoogleCloudDialogflowCxV3IntentCoverageIntent", + "properties": { + "covered": { + "description": "Whether or not the intent is covered by at least one of the agent's test cases.", + "type": "boolean" + }, + "intent": { + "description": "The intent full resource name", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentInput": { + "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing.", + "id": "GoogleCloudDialogflowCxV3IntentInput", + "properties": { + "intent": { + "description": "Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentParameter": { + "description": "Represents an intent parameter.", + "id": "GoogleCloudDialogflowCxV3IntentParameter", + "properties": { + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "id": { + "description": "Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.", + "type": "string" + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentTrainingPhrase": { + "description": "Represents an example that the agent is trained on to identify the intent.", + "id": "GoogleCloudDialogflowCxV3IntentTrainingPhrase", + "properties": { + "id": { + "description": "Output only. The unique identifier of the training phrase.", + "type": "string" + }, + "parts": { + "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart" + }, + "type": "array" + }, + "repeatCount": { + "description": "Indicates how many times this example was added to the intent.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart": { + "description": "Represents a part of a training phrase.", + "id": "GoogleCloudDialogflowCxV3IntentTrainingPhrasePart", + "properties": { + "parameterId": { + "description": "The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "text": { + "description": "Required. The text for this part.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListAgentsResponse": { + "description": "The response message for Agents.ListAgents.", + "id": "GoogleCloudDialogflowCxV3ListAgentsResponse", + "properties": { + "agents": { + "description": "The list of agents. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Agent" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListEntityTypesResponse": { + "description": "The response message for EntityTypes.ListEntityTypes.", + "id": "GoogleCloudDialogflowCxV3ListEntityTypesResponse", + "properties": { + "entityTypes": { + "description": "The list of entity types. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EntityType" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListEnvironmentsResponse": { + "description": "The response message for Environments.ListEnvironments.", + "id": "GoogleCloudDialogflowCxV3ListEnvironmentsResponse", + "properties": { + "environments": { + "description": "The list of environments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Environment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListExperimentsResponse": { + "description": "The response message for Experiments.ListExperiments.", + "id": "GoogleCloudDialogflowCxV3ListExperimentsResponse", + "properties": { + "experiments": { + "description": "The list of experiments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Experiment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListFlowsResponse": { + "description": "The response message for Flows.ListFlows.", + "id": "GoogleCloudDialogflowCxV3ListFlowsResponse", + "properties": { + "flows": { + "description": "The list of flows. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Flow" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListIntentsResponse": { + "description": "The response message for Intents.ListIntents.", + "id": "GoogleCloudDialogflowCxV3ListIntentsResponse", + "properties": { + "intents": { + "description": "The list of intents. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Intent" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListPagesResponse": { + "description": "The response message for Pages.ListPages.", + "id": "GoogleCloudDialogflowCxV3ListPagesResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "pages": { + "description": "The list of pages. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Page" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListSecuritySettingsResponse": { + "description": "The response message for SecuritySettings.ListSecuritySettings.", + "id": "GoogleCloudDialogflowCxV3ListSecuritySettingsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "securitySettings": { + "description": "The list of security settings.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3SecuritySettings" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse": { + "description": "The response message for SessionEntityTypes.ListSessionEntityTypes.", + "id": "GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "sessionEntityTypes": { + "description": "The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListTestCaseResultsResponse": { + "description": "The response message for TestCases.ListTestCaseResults.", + "id": "GoogleCloudDialogflowCxV3ListTestCaseResultsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "testCaseResults": { + "description": "The list of test case results.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListTestCasesResponse": { + "description": "The response message for TestCases.ListTestCases.", + "id": "GoogleCloudDialogflowCxV3ListTestCasesResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "testCases": { + "description": "The list of test cases. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TestCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse": { + "description": "The response message for TransitionRouteGroups.ListTransitionRouteGroups.", + "id": "GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "transitionRouteGroups": { + "description": "The list of transition route groups. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRouteGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListVersionsResponse": { + "description": "The response message for Versions.ListVersions.", + "id": "GoogleCloudDialogflowCxV3ListVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "versions": { + "description": "A list of versions. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Version" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ListWebhooksResponse": { + "description": "The response message for Webhooks.ListWebhooks.", + "id": "GoogleCloudDialogflowCxV3ListWebhooksResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "webhooks": { + "description": "The list of webhooks. There will be a maximum number of items returned based on the page_size field in the request.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Webhook" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3LoadVersionRequest": { + "description": "The request message for Versions.LoadVersion.", + "id": "GoogleCloudDialogflowCxV3LoadVersionRequest", + "properties": { + "allowOverrideAgentResources": { + "description": "This field is used to prevent accidental overwrite of other agent resources in the draft version, which can potentially impact other flow's behavior. If `allow_override_agent_resources` is false, conflicted agent-level resources will not be overridden (i.e. intents, entities, webhooks).", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse": { + "description": "The response message for Environments.LookupEnvironmentHistory.", + "id": "GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse", + "properties": { + "environments": { + "description": "Represents a list of snapshots for an environment. Time of the snapshots is stored in `update_time`.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Environment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Match": { + "description": "Represents one match result of MatchIntent.", + "id": "GoogleCloudDialogflowCxV3Match", + "properties": { + "confidence": { + "description": "The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" + }, + "event": { + "description": "The event that matched the query. Only filled for `EVENT` match type.", + "type": "string" + }, + "intent": { + "$ref": "GoogleCloudDialogflowCxV3Intent", + "description": "The Intent that matched the query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. Only filled for `INTENT` match type." + }, + "matchType": { + "description": "Type of this Match.", + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "INTENT", + "DIRECT_INTENT", + "PARAMETER_FILLING", + "NO_MATCH", + "NO_INPUT", + "EVENT" + ], + "enumDescriptions": [ + "Not specified. Should never be used.", + "The query was matched to an intent.", + "The query directly triggered an intent.", + "The query was used for parameter filling.", + "No match was found for the query.", + "Indicates an empty query.", + "The query directly triggered an event." + ], + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The collection of parameters extracted from the query. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + }, + "resolvedInput": { + "description": "Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3MatchIntentRequest": { + "description": "Request of MatchIntent.", + "id": "GoogleCloudDialogflowCxV3MatchIntentRequest", + "properties": { + "queryInput": { + "$ref": "GoogleCloudDialogflowCxV3QueryInput", + "description": "Required. The input specification." + }, + "queryParams": { + "$ref": "GoogleCloudDialogflowCxV3QueryParameters", + "description": "The parameters of this query." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3MatchIntentResponse": { + "description": "Response of MatchIntent.", + "id": "GoogleCloudDialogflowCxV3MatchIntentResponse", + "properties": { + "currentPage": { + "$ref": "GoogleCloudDialogflowCxV3Page", + "description": "The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`." + }, + "matches": { + "description": "Match results, if more than one, ordered descendingly by the confidence we have that the particular intent matches the query.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3Match" + }, + "type": "array" + }, + "text": { + "description": "If natural language text was provided as input, this field will contain a copy of the text.", + "type": "string" + }, + "transcript": { + "description": "If natural language speech audio was provided as input, this field will contain the trascript for the audio.", + "type": "string" + }, + "triggerEvent": { + "description": "If an event was provided as input, this field will contain a copy of the event name.", + "type": "string" + }, + "triggerIntent": { + "description": "If an intent was provided as input, this field will contain a copy of the intent identifier.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3NluSettings": { + "description": "Settings related to NLU.", + "id": "GoogleCloudDialogflowCxV3NluSettings", + "properties": { + "classificationThreshold": { + "description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.", + "format": "float", + "type": "number" + }, + "modelTrainingMode": { + "description": "Indicates NLU model training mode.", + "enum": [ + "MODEL_TRAINING_MODE_UNSPECIFIED", + "MODEL_TRAINING_MODE_AUTOMATIC", + "MODEL_TRAINING_MODE_MANUAL" + ], + "enumDescriptions": [ + "Not specified. `MODEL_TRAINING_MODE_AUTOMATIC` will be used.", + "NLU model training is automatically triggered when a flow gets modified. User can also manually trigger model training in this mode.", + "User needs to manually trigger NLU model training. Best for large flows whose models take long time to train." + ], + "type": "string" + }, + "modelType": { + "description": "Indicates the type of NLU model.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "MODEL_TYPE_STANDARD", + "MODEL_TYPE_ADVANCED" + ], + "enumDescriptions": [ + "Not specified. `MODEL_TYPE_STANDARD` will be used.", + "Use standard NLU model.", + "Use advanced NLU model." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3OutputAudioConfig": { + "description": "Instructs the speech synthesizer how to generate the output audio content.", + "id": "GoogleCloudDialogflowCxV3OutputAudioConfig", + "properties": { + "audioEncoding": { + "description": "Required. Audio encoding of the synthesized audio content.", + "enum": [ + "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", + "OUTPUT_AUDIO_ENCODING_LINEAR_16", + "OUTPUT_AUDIO_ENCODING_MP3", + "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", + "OUTPUT_AUDIO_ENCODING_OGG_OPUS", + "OUTPUT_AUDIO_ENCODING_MULAW" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", + "MP3 audio at 32kbps.", + "MP3 audio at 64kbps.", + "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + ], + "type": "string" + }, + "sampleRateHertz": { + "description": "Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).", + "format": "int32", + "type": "integer" + }, + "synthesizeSpeechConfig": { + "$ref": "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig", + "description": "Optional. Configuration of how speech should be synthesized." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Page": { + "description": "A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", + "id": "GoogleCloudDialogflowCxV3Page", + "properties": { + "displayName": { + "description": "Required. The human-readable name of the page, unique within the agent.", + "type": "string" + }, + "entryFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "The fulfillment to call when the session is entering the page." + }, + "eventHandlers": { + "description": "Handlers associated with the page to handle events such as webhook errors, no match or no input.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EventHandler" + }, + "type": "array" + }, + "form": { + "$ref": "GoogleCloudDialogflowCxV3Form", + "description": "The form associated with the page, used for collecting parameters relevant to the page." + }, + "name": { + "description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "transitionRouteGroups": { + "description": "Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "transitionRoutes": { + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PageInfo": { + "description": "Represents page information communicated to and from the webhook.", + "id": "GoogleCloudDialogflowCxV3PageInfo", + "properties": { + "currentPage": { + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "formInfo": { + "$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfo", + "description": "Optional for both WebhookRequest and WebhookResponse. Information about the form." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PageInfoFormInfo": { + "description": "Represents form information.", + "id": "GoogleCloudDialogflowCxV3PageInfoFormInfo", + "properties": { + "parameterInfo": { + "description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo": { + "description": "Represents parameter information.", + "id": "GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo", + "properties": { + "displayName": { + "description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.", + "type": "string" + }, + "justCollected": { + "description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.", + "type": "boolean" + }, + "required": { + "description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", + "type": "boolean" + }, + "state": { + "description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.", + "enum": [ + "PARAMETER_STATE_UNSPECIFIED", + "EMPTY", + "INVALID", + "FILLED" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "Indicates that the parameter does not have a value.", + "Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", + "Indicates that the parameter has a value." + ], + "type": "string" + }, + "value": { + "description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3QueryInput": { + "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. ", + "id": "GoogleCloudDialogflowCxV3QueryInput", + "properties": { + "audio": { + "$ref": "GoogleCloudDialogflowCxV3AudioInput", + "description": "The natural language speech audio to be processed." + }, + "dtmf": { + "$ref": "GoogleCloudDialogflowCxV3DtmfInput", + "description": "The DTMF event to be handled." + }, + "event": { + "$ref": "GoogleCloudDialogflowCxV3EventInput", + "description": "The event to be triggered." + }, + "intent": { + "$ref": "GoogleCloudDialogflowCxV3IntentInput", + "description": "The intent to be triggered." + }, + "languageCode": { + "description": "Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, + "text": { + "$ref": "GoogleCloudDialogflowCxV3TextInput", + "description": "The natural language text to be processed." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3QueryParameters": { + "description": "Represents the parameters of a conversational query.", + "id": "GoogleCloudDialogflowCxV3QueryParameters", + "properties": { + "analyzeQueryTextSentiment": { + "description": "Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.", + "type": "boolean" + }, + "geoLocation": { + "$ref": "GoogleTypeLatLng", + "description": "The geo location of this conversational query." + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.", + "type": "object" + }, + "sessionEntityTypes": { + "description": "Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3SessionEntityType" + }, + "type": "array" + }, + "timeZone": { + "description": "The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.", + "type": "string" + }, + "webhookHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: \"Host\", \"Content-Length\", \"Connection\", \"From\", \"User-Agent\", \"Accept-Encoding\", \"If-Modified-Since\", \"If-None-Match\", \"X-Forwarded-For\", etc.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3QueryResult": { + "description": "Represents the result of a conversational query.", + "id": "GoogleCloudDialogflowCxV3QueryResult", + "properties": { + "currentPage": { + "$ref": "GoogleCloudDialogflowCxV3Page", + "description": "The current Page. Some, not all fields are filled in this message, including but not limited to `name` and `display_name`." + }, + "diagnosticInfo": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice.", + "type": "object" + }, + "intent": { + "$ref": "GoogleCloudDialogflowCxV3Intent", + "description": "The Intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name` and `display_name`. This field is deprecated, please use QueryResult.match instead." + }, + "intentDetectionConfidence": { + "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. This field is deprecated, please use QueryResult.match instead.", + "format": "float", + "type": "number" + }, + "languageCode": { + "description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "type": "string" + }, + "match": { + "$ref": "GoogleCloudDialogflowCxV3Match", + "description": "Intent match result, could be an intent or an event." + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The collected session parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + }, + "responseMessages": { + "description": "The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" + }, + "type": "array" + }, + "sentimentAnalysisResult": { + "$ref": "GoogleCloudDialogflowCxV3SentimentAnalysisResult", + "description": "The sentiment analyss result, which depends on `analyze_query_text_sentiment`, specified in the request." + }, + "text": { + "description": "If natural language text was provided as input, this field will contain a copy of the text.", + "type": "string" + }, + "transcript": { + "description": "If natural language speech audio was provided as input, this field will contain the trascript for the audio.", + "type": "string" + }, + "triggerEvent": { + "description": "If an event was provided as input, this field will contain the name of the event.", + "type": "string" + }, + "triggerIntent": { + "description": "If an intent was provided as input, this field will contain a copy of the intent identifier.", + "type": "string" + }, + "webhookPayloads": { + "description": "The list of webhook payload in WebhookResponse.payload, in the order of call sequence. If some webhook call fails or doesn't return any payload, an empty `Struct` would be used instead.", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "webhookStatuses": { + "description": "The list of webhook call status in the order of call sequence.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": { + "description": "Metadata for ReloadDocument operation.", + "id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResourceName": { + "description": "Resource name and display name.", + "id": "GoogleCloudDialogflowCxV3ResourceName", + "properties": { + "displayName": { + "description": "Display name.", + "type": "string" + }, + "name": { + "description": "Name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessage": { + "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", + "id": "GoogleCloudDialogflowCxV3ResponseMessage", + "properties": { + "conversationSuccess": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess", + "description": "Indicates that the conversation succeeded." + }, + "endInteraction": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction", + "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.", + "readOnly": true + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a human agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio", + "description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "readOnly": true + }, + "outputAudioText": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText", + "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "playAudio": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", + "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way." + }, + "text": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess": { + "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText": { + "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "ssml": { + "description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).", + "type": "string" + }, + "text": { + "description": "The raw text to be synthesized.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio": { + "description": "Specifies an audio clip to be played by the client as part of the response.", + "id": "GoogleCloudDialogflowCxV3ResponseMessagePlayAudio", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "audioUri": { + "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowCxV3ResponseMessageText", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "text": { + "description": "Required. A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RestoreAgentRequest": { + "description": "The request message for Agents.RestoreAgent.", + "id": "GoogleCloudDialogflowCxV3RestoreAgentRequest", + "properties": { + "agentContent": { + "description": "Uncompressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to restore agent from. The format of this URI must be `gs:///`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseMetadata": { + "description": "Metadata returned for the TestCases.RunTestCase long running operation.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseRequest": { + "description": "The request message for TestCases.RunTestCase.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseRequest", + "properties": { + "environment": { + "description": "Optional. Environment name. If not set, draft environment is assumed. Format: `projects//locations//agents//environments/`.", + "type": "string" + }, + "name": { + "description": "Required. Format of test case name to run: `projects//locations/ /agents//testCases/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3RunTestCaseResponse": { + "description": "The response message for TestCases.RunTestCase.", + "id": "GoogleCloudDialogflowCxV3RunTestCaseResponse", + "properties": { + "result": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", + "description": "The result." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SecuritySettings": { + "description": "Represents the settings related to security issues, such as data redaction and data retention. It may take hours for updates on the settings to propagate to all the related components and take effect.", + "id": "GoogleCloudDialogflowCxV3SecuritySettings", + "properties": { + "displayName": { + "description": "Required. The human-readable name of the security settings, unique within the location.", + "type": "string" + }, + "inspectTemplate": { + "description": "DLP inspect template name. Use this template to define inspect base settings. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`", + "type": "string" + }, + "name": { + "description": "Required. Resource name of the settings. Format: `projects//locations//securitySettings/`.", + "type": "string" + }, + "purgeDataTypes": { + "description": "List of types of data to remove when retention settings triggers purge.", + "items": { + "enum": [ + "PURGE_DATA_TYPE_UNSPECIFIED", + "DIALOGFLOW_HISTORY" + ], + "enumDescriptions": [ + "Unspecified. Do not use.", + "Dialogflow history. This does not include Stackdriver log, which is owned by the user not Dialogflow." + ], + "type": "string" + }, + "type": "array" + }, + "redactionScope": { + "description": "Defines on what data we apply redaction. Note that we don't redact data to which we don't have access, e.g., Stackdriver logs.", + "enum": [ + "REDACTION_SCOPE_UNSPECIFIED", + "REDACT_DISK_STORAGE" + ], + "enumDescriptions": [ + "Don't redact any kind of data.", + "On data to be written to disk or similar devices that are capable of holding data even if power is disconnected. This includes data that are temporarily saved on disk." + ], + "type": "string" + }, + "redactionStrategy": { + "description": "Strategy that defines how we do redaction.", + "enum": [ + "REDACTION_STRATEGY_UNSPECIFIED", + "REDACT_WITH_SERVICE" + ], + "enumDescriptions": [ + "Do not redact.", + "Call redaction service to clean up the data to be persisted." + ], + "type": "string" + }, + "retentionWindowDays": { + "description": "Retains the data for the specified number of days. User must Set a value lower than Dialogflow's default 30d TTL. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use Dialogflow's default TTL.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SentimentAnalysisResult": { + "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral.", + "id": "GoogleCloudDialogflowCxV3SentimentAnalysisResult", + "properties": { + "magnitude": { + "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", + "format": "float", + "type": "number" + }, + "score": { + "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SessionEntityType": { + "description": "Session entity types are referred to as **User** entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level to extend or replace a custom entity type at the user session level (we refer to the entity types defined at the agent level as \"custom entity types\"). Note: session entity types apply to all queries, regardless of the language. For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).", + "id": "GoogleCloudDialogflowCxV3SessionEntityType", + "properties": { + "entities": { + "description": "Required. The collection of entities to override or supplement the custom entity type.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3EntityTypeEntity" + }, + "type": "array" + }, + "entityOverrideMode": { + "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", + "enum": [ + "ENTITY_OVERRIDE_MODE_UNSPECIFIED", + "ENTITY_OVERRIDE_MODE_OVERRIDE", + "ENTITY_OVERRIDE_MODE_SUPPLEMENT" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", + "The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge." + ], + "type": "string" + }, + "name": { + "description": "Required. The unique identifier of the session entity type. Format: `projects//locations//agents//sessions//entityTypes/` or `projects//locations//agents//environments//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SessionInfo": { + "description": "Represents session information communicated to and from the webhook.", + "id": "GoogleCloudDialogflowCxV3SessionInfo", + "properties": { + "parameters": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", + "type": "object" + }, + "session": { + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SpeechToTextSettings": { + "description": "Settings related to speech recognition.", + "id": "GoogleCloudDialogflowCxV3SpeechToTextSettings", + "properties": { + "enableSpeechAdaptation": { + "description": "Whether to use speech adaptation for speech recognition.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3StartExperimentRequest": { + "description": "The request message for Experiments.StartExperiment.", + "id": "GoogleCloudDialogflowCxV3StartExperimentRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3StopExperimentRequest": { + "description": "The request message for Experiments.StopExperiment.", + "id": "GoogleCloudDialogflowCxV3StopExperimentRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig": { + "description": "Configuration of how speech should be synthesized.", + "id": "GoogleCloudDialogflowCxV3SynthesizeSpeechConfig", + "properties": { + "effectsProfileId": { + "description": "Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pitch": { + "description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.", + "format": "double", + "type": "number" + }, + "speakingRate": { + "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", + "format": "double", + "type": "number" + }, + "voice": { + "$ref": "GoogleCloudDialogflowCxV3VoiceSelectionParams", + "description": "Optional. The desired voice of the synthesized audio." + }, + "volumeGainDb": { + "description": "Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestCase": { + "description": "Represents a test case.", + "id": "GoogleCloudDialogflowCxV3TestCase", + "properties": { + "creationTime": { + "description": "Output only. When the test was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", + "type": "string" + }, + "lastTestResult": { + "$ref": "GoogleCloudDialogflowCxV3TestCaseResult", + "description": "The latest test result." + }, + "name": { + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "type": "string" + }, + "notes": { + "description": "Additional freeform notes about the test case. Limit of 400 characters.", + "type": "string" + }, + "tags": { + "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", + "items": { + "type": "string" + }, + "type": "array" + }, + "testCaseConversationTurns": { + "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" + }, + "type": "array" + }, + "testConfig": { + "$ref": "GoogleCloudDialogflowCxV3TestConfig", + "description": "Config for the test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestCaseError": { + "description": "Error info for importing a test.", + "id": "GoogleCloudDialogflowCxV3TestCaseError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test case." + }, + "testCase": { + "$ref": "GoogleCloudDialogflowCxV3TestCase", + "description": "The test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestCaseResult": { + "description": "Represents a result from running a test case in an agent environment.", + "id": "GoogleCloudDialogflowCxV3TestCaseResult", + "properties": { + "conversationTurns": { + "description": "The conversation turns uttered during the test case replay in chronological order.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ConversationTurn" + }, + "type": "array" + }, + "environment": { + "description": "Environment where the test was run. If not set, it indicates the draft environment.", + "type": "string" + }, + "name": { + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "type": "string" + }, + "testResult": { + "description": "Whether the test case passed in the agent environment.", + "enum": [ + "TEST_RESULT_UNSPECIFIED", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "Not specified. Should never be used.", + "The test passed.", + "The test did not pass." + ], + "type": "string" + }, + "testTime": { + "description": "The time that the test was run.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestConfig": { + "description": "Represents configurations for a test case.", + "id": "GoogleCloudDialogflowCxV3TestConfig", + "properties": { + "flow": { + "description": "Flow name. If not set, default start flow is assumed. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "trackingParameters": { + "description": "Session parameters to be compared when calculating differences.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestError": { + "description": "Error info for running a test.", + "id": "GoogleCloudDialogflowCxV3TestError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test." + }, + "testCase": { + "description": "The test case resource name.", + "type": "string" + }, + "testTime": { + "description": "The timestamp when the test was completed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TestRunDifference": { + "description": "The description of differences between original and replayed agent output.", + "id": "GoogleCloudDialogflowCxV3TestRunDifference", + "properties": { + "description": { + "description": "A description of the diff, showing the actual output vs expected output.", + "type": "string" + }, + "type": { + "description": "The type of diff.", + "enum": [ + "DIFF_TYPE_UNSPECIFIED", + "INTENT", + "PAGE", + "PARAMETERS", + "UTTERANCE" + ], + "enumDescriptions": [ + "Should never be used.", + "The intent.", + "The page.", + "The parameters.", + "The message utterance." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TextInput": { + "description": "Represents the natural language text to be processed.", + "id": "GoogleCloudDialogflowCxV3TextInput", + "properties": { + "text": { + "description": "Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TrainFlowRequest": { + "description": "The request message for Flows.TrainFlow.", + "id": "GoogleCloudDialogflowCxV3TrainFlowRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TransitionCoverage": { + "description": "Transition coverage represents the percentage of all possible transitions present within any of a parent's test cases.", + "id": "GoogleCloudDialogflowCxV3TransitionCoverage", + "properties": { + "coverageScore": { + "description": "The percent of transitions in the agent that are covered.", + "format": "float", + "type": "number" + }, + "transitions": { + "description": "The list of Transitions present in the agent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TransitionCoverageTransition" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TransitionCoverageTransition": { + "description": "A transition in the agent's graph.", + "id": "GoogleCloudDialogflowCxV3TransitionCoverageTransition", + "properties": { + "covered": { + "description": "Whether or not the transition is covered by at least one of the agent's test cases.", + "type": "boolean" + }, + "eventHandler": { + "$ref": "GoogleCloudDialogflowCxV3EventHandler", + "description": "Event handler." + }, + "index": { + "description": "The index of a transition in the transition list. Starting from 0.", + "format": "int32", + "type": "integer" + }, + "source": { + "$ref": "GoogleCloudDialogflowCxV3TransitionCoverageTransitionNode", + "description": "The start node of a transition." + }, + "target": { + "$ref": "GoogleCloudDialogflowCxV3TransitionCoverageTransitionNode", + "description": "The end node of a transition." + }, + "transitionRoute": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRoute", + "description": "Intent route or condition route." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TransitionCoverageTransitionNode": { + "description": "The source or target of a transition.", + "id": "GoogleCloudDialogflowCxV3TransitionCoverageTransitionNode", + "properties": { + "flow": { + "$ref": "GoogleCloudDialogflowCxV3Flow", + "description": "Indicates a transition to a Flow. Only some fields such as name and displayname will be set." + }, + "page": { + "$ref": "GoogleCloudDialogflowCxV3Page", + "description": "Indicates a transition to a Page. Only some fields such as name and displayname will be set." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TransitionRoute": { + "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3TransitionRoute", + "properties": { + "condition": { + "description": "The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "intent": { + "description": "The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this transition route.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3Fulfillment", + "description": "The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3TransitionRouteGroup": { + "description": "An TransitionRouteGroup represents a group of `TransitionRoutes` to be used by a Page.", + "id": "GoogleCloudDialogflowCxV3TransitionRouteGroup", + "properties": { + "displayName": { + "description": "Required. The human-readable name of the transition route group, unique within the Agent. The display name can be no longer than 30 characters.", + "type": "string" + }, + "name": { + "description": "The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/`.", + "type": "string" + }, + "transitionRoutes": { + "description": "Transition routes associated with the TransitionRouteGroup.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3TransitionRoute" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": { + "description": "Metadata for UpdateDocument operation.", + "id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ValidateAgentRequest": { + "description": "The request message for Agents.ValidateAgent.", + "id": "GoogleCloudDialogflowCxV3ValidateAgentRequest", + "properties": { + "languageCode": { + "description": "If not specified, the agent's default language is used.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ValidateFlowRequest": { + "description": "The request message for Flows.ValidateFlow.", + "id": "GoogleCloudDialogflowCxV3ValidateFlowRequest", + "properties": { + "languageCode": { + "description": "If not specified, the agent's default language is used.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ValidationMessage": { + "description": "Agent/flow validation message.", + "id": "GoogleCloudDialogflowCxV3ValidationMessage", + "properties": { + "detail": { + "description": "The message detail.", + "type": "string" + }, + "resourceNames": { + "description": "The resource names of the resources where the message is found.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResourceName" + }, + "type": "array" + }, + "resourceType": { + "description": "The type of the resources where the message is found.", + "enum": [ + "RESOURCE_TYPE_UNSPECIFIED", + "AGENT", + "INTENT", + "INTENT_TRAINING_PHRASE", + "INTENT_PARAMETER", + "INTENTS", + "INTENT_TRAINING_PHRASES", + "ENTITY_TYPE", + "ENTITY_TYPES", + "WEBHOOK", + "FLOW", + "PAGE", + "PAGES", + "TRANSITION_ROUTE_GROUP" + ], + "enumDescriptions": [ + "Unspecified.", + "Agent.", + "Intent.", + "Intent training phrase.", + "Intent parameter.", + "Multiple intents.", + "Multiple training phrases.", + "Entity type.", + "Multiple entity types.", + "Webhook.", + "Flow.", + "Page.", + "Multiple pages.", + "Transition route group." + ], + "type": "string" + }, + "resources": { + "description": "The names of the resources where the message is found.", + "items": { + "type": "string" + }, + "type": "array" + }, + "severity": { + "description": "Indicates the severity of the message.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "INFO", + "WARNING", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified.", + "The agent doesn't follow Dialogflow best practices.", + "The agent may not behave as expected.", + "The agent may experience failures." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3VariantsHistory": { + "description": "The history of variants update.", + "id": "GoogleCloudDialogflowCxV3VariantsHistory", + "properties": { + "updateTime": { + "description": "Update time of the variants.", + "format": "google-datetime", + "type": "string" + }, + "versionVariants": { + "$ref": "GoogleCloudDialogflowCxV3VersionVariants", + "description": "The flow versions as the variants." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Version": { + "description": "Represents a version of a flow.", + "id": "GoogleCloudDialogflowCxV3Version", + "properties": { + "createTime": { + "description": "Output only. Create time of the version.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the version. Limit of 64 characters.", + "type": "string" + }, + "name": { + "description": "Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.", + "type": "string" + }, + "nluSettings": { + "$ref": "GoogleCloudDialogflowCxV3NluSettings", + "description": "Output only. The NLU settings of the flow at version creation.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of this version. This field is read-only and cannot be set by create and update methods.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Not specified. This value is not used.", + "Version is not ready to serve (e.g. training is running).", + "Training has succeeded and this version is ready to serve.", + "Version training failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3VersionVariants": { + "description": "A list of flow version variants.", + "id": "GoogleCloudDialogflowCxV3VersionVariants", + "properties": { + "variants": { + "description": "A list of flow version variants.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3VersionVariantsVariant" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3VersionVariantsVariant": { + "description": "A single flow version with specified traffic allocation.", + "id": "GoogleCloudDialogflowCxV3VersionVariantsVariant", + "properties": { + "isControlGroup": { + "description": "Whether the variant is for the control group.", + "type": "boolean" + }, + "trafficAllocation": { + "description": "Percentage of the traffic which should be routed to this version of flow. Traffic allocation for a single flow must sum up to 1.0.", + "format": "float", + "type": "number" + }, + "version": { + "description": "The name of the flow version. Format: `projects//locations//agents//flows//versions/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3VoiceSelectionParams": { + "description": "Description of which voice to use for speech synthesis.", + "id": "GoogleCloudDialogflowCxV3VoiceSelectionParams", + "properties": { + "name": { + "description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices).", + "type": "string" + }, + "ssmlGender": { + "description": "Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.", + "enum": [ + "SSML_VOICE_GENDER_UNSPECIFIED", + "SSML_VOICE_GENDER_MALE", + "SSML_VOICE_GENDER_FEMALE", + "SSML_VOICE_GENDER_NEUTRAL" + ], + "enumDescriptions": [ + "An unspecified gender, which means that the client doesn't care which gender the selected voice will have.", + "A male voice.", + "A female voice.", + "A gender-neutral voice." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3Webhook": { + "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", + "id": "GoogleCloudDialogflowCxV3Webhook", + "properties": { + "disabled": { + "description": "Indicates whether the webhook is disabled.", + "type": "boolean" + }, + "displayName": { + "description": "Required. The human-readable name of the webhook, unique within the agent.", + "type": "string" + }, + "genericWebService": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebService", + "description": "Configuration for a generic web service." + }, + "name": { + "description": "The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.", + "type": "string" + }, + "timeout": { + "description": "Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookGenericWebService": { + "description": "Represents configuration for a generic web service.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebService", + "properties": { + "password": { + "description": "The password for HTTP Basic authentication.", + "type": "string" + }, + "requestHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "The HTTP request headers to send together with webhook requests.", + "type": "object" + }, + "uri": { + "description": "Required. The webhook URI for receiving POST requests. It must use https protocol.", + "type": "string" + }, + "username": { + "description": "The user name for HTTP Basic authentication.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequest": { + "description": "The request message for a webhook call.", + "id": "GoogleCloudDialogflowCxV3WebhookRequest", + "properties": { + "detectIntentResponseId": { + "description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.", + "type": "string" + }, + "fulfillmentInfo": { + "$ref": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo", + "description": "Always present. Information about the fulfillment that triggered this webhook call." + }, + "intentInfo": { + "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", + "description": "Information about the last matched intent." + }, + "messages": { + "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" + }, + "type": "array" + }, + "pageInfo": { + "$ref": "GoogleCloudDialogflowCxV3PageInfo", + "description": "Information about page status." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom data set in QueryParameters.payload.", + "type": "object" + }, + "sessionInfo": { + "$ref": "GoogleCloudDialogflowCxV3SessionInfo", + "description": "Information about session status." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo": { + "description": "Represents fulfillment information communicated to the webhook.", + "id": "GoogleCloudDialogflowCxV3WebhookRequestFulfillmentInfo", + "properties": { + "tag": { + "description": "Always present. The tag used to identify which fulfillment is being called.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo": { + "description": "Represents intent information communicated to the webhook.", + "id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfo", + "properties": { + "confidence": { + "description": "The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).", + "format": "float", + "type": "number" + }, + "displayName": { + "description": "Always present. The display name of the last matched intent.", + "type": "string" + }, + "lastMatchedIntent": { + "description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue" + }, + "description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue": { + "description": "Represents a value for an intent parameter.", + "id": "GoogleCloudDialogflowCxV3WebhookRequestIntentInfoIntentParameterValue", + "properties": { + "originalValue": { + "description": "Always present. Original text value extracted from user utterance.", + "type": "string" + }, + "resolvedValue": { + "description": "Always present. Structured value for the parameter extracted from user utterance.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookResponse": { + "description": "The response message for a webhook call.", + "id": "GoogleCloudDialogflowCxV3WebhookResponse", + "properties": { + "fulfillmentResponse": { + "$ref": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse", + "description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user." + }, + "pageInfo": { + "$ref": "GoogleCloudDialogflowCxV3PageInfo", + "description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Value to append directly to QueryResult.webhook_payloads.", + "type": "object" + }, + "sessionInfo": { + "$ref": "GoogleCloudDialogflowCxV3SessionInfo", + "description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status." + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse": { + "description": "Represents a fulfillment response to the user.", + "id": "GoogleCloudDialogflowCxV3WebhookResponseFulfillmentResponse", + "properties": { + "mergeBehavior": { + "description": "Merge behavior for `messages`.", + "enum": [ + "MERGE_BEHAVIOR_UNSPECIFIED", + "APPEND", + "REPLACE" + ], + "enumDescriptions": [ + "Not specified. `APPEND` will be used.", + "`messages` will be appended to the list of messages waiting to be sent to the user.", + "`messages` will replace the list of messages waiting to be sent to the user." + ], + "type": "string" + }, + "messages": { + "description": "The list of rich message responses to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3ResponseMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1AudioInput": { + "description": "Represents the natural speech audio to be processed.", + "id": "GoogleCloudDialogflowCxV3beta1AudioInput", + "properties": { + "audio": { + "description": "The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes. For non-streaming audio detect intent, both `config` and `audio` must be provided. For streaming audio detect intent, `config` must be provided in the first request and `audio` must be provided in all following requests.", + "format": "byte", + "type": "string" + }, + "config": { + "$ref": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", + "description": "Required. Instructs the speech recognizer how to process the speech audio." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata": { + "description": "Metadata returned for the TestCases.BatchRunTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesMetadata", + "properties": { + "errors": { + "description": "The test errors.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse": { + "description": "The response message for TestCases.BatchRunTestCases.", + "id": "GoogleCloudDialogflowCxV3beta1BatchRunTestCasesResponse", + "properties": { + "results": { + "description": "The test case results. The detailed conversation turns are empty in this response.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ConversationTurn": { + "description": "One interaction between a human and virtual agent. The human provides some input and the virtual agent provides a response.", + "id": "GoogleCloudDialogflowCxV3beta1ConversationTurn", + "properties": { + "userInput": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput", + "description": "The user input." + }, + "virtualAgentOutput": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput", + "description": "The virtual agent output." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput": { + "description": "The input from the human user.", + "id": "GoogleCloudDialogflowCxV3beta1ConversationTurnUserInput", + "properties": { + "injectedParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Parameters that need to be injected into the conversation during intent detection.", + "type": "object" + }, + "input": { + "$ref": "GoogleCloudDialogflowCxV3beta1QueryInput", + "description": "Supports text input, event input, dtmf input in the test case." + }, + "isWebhookEnabled": { + "description": "If webhooks should be allowed to trigger in response to the user utterance. Often if parameters are injected, webhooks should not be enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput": { + "description": "The output from the virtual agent.", + "id": "GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput", + "properties": { + "currentPage": { + "$ref": "GoogleCloudDialogflowCxV3beta1Page", + "description": "The Page on which the utterance was spoken. Only some fields such as name and displayname will be set." + }, + "diagnosticInfo": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. Input only. The diagnostic info output for the turn.", + "type": "object" + }, + "differences": { + "description": "Output only. If this is part of a result conversation turn, the list of differences between the original run and the replay for this output, if any.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestRunDifference" + }, + "readOnly": true, + "type": "array" + }, + "sessionParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The session parameters available to the bot at this point.", + "type": "object" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "Response error from the agent in the test result. If set, other output is empty." + }, + "textResponses": { + "description": "The text responses from the agent for the turn.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText" + }, + "type": "array" + }, + "triggeredIntent": { + "$ref": "GoogleCloudDialogflowCxV3beta1Intent", + "description": "The Intent that triggered the response. Only some fields such as name and displayname will be set." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": { + "description": "Metadata for CreateDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { + "description": "Metadata associated with the long running operation for Versions.CreateVersion.", + "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", + "properties": { + "version": { + "description": "Name of the created version. Format: `projects//locations//agents//flows//versions/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { + "description": "Metadata for DeleteDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1DtmfInput": { + "description": "Represents the input for dtmf event.", + "id": "GoogleCloudDialogflowCxV3beta1DtmfInput", + "properties": { + "digits": { + "description": "The dtmf digits.", + "type": "string" + }, + "finishDigit": { + "description": "The finish digit (if any).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1EventHandler": { + "description": "An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the event, it will be called. * If there is a `target_page` associated with the event, the session will transition into the specified page. * If there is a `target_flow` associated with the event, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3beta1EventHandler", + "properties": { + "event": { + "description": "Required. The name of the event to handle.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this event handler.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1EventInput": { + "description": "Represents the event to trigger.", + "id": "GoogleCloudDialogflowCxV3beta1EventInput", + "properties": { + "event": { + "description": "Name of the event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", + "properties": { + "agentContent": { + "description": "Uncompressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse": { + "description": "The response message for TestCases.ExportTestCases.", + "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesResponse", + "properties": { + "content": { + "description": "Uncompressed raw byte content for test cases.", + "format": "byte", + "type": "string" + }, + "gcsUri": { + "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Form": { + "description": "A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session.", + "id": "GoogleCloudDialogflowCxV3beta1Form", + "properties": { + "parameters": { + "description": "Parameters to collect from the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FormParameter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FormParameter": { + "description": "Represents a form parameter.", + "id": "GoogleCloudDialogflowCxV3beta1FormParameter", + "properties": { + "defaultValue": { + "description": "The default value of an optional parameter. If the parameter is required, the default value will be ignored.", + "type": "any" + }, + "displayName": { + "description": "Required. The human-readable name of the parameter, unique within the form.", + "type": "string" + }, + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "fillBehavior": { + "$ref": "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior", + "description": "Required. Defines fill behavior for the parameter." + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + }, + "required": { + "description": "Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior": { + "description": "Configuration for how the filling of a parameter should be handled.", + "id": "GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior", + "properties": { + "initialPromptFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter." + }, + "repromptEventHandlers": { + "description": "The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are: * `sys.no-match-`, where N can be from 1 to 6 * `sys.no-match-default` * `sys.no-input-`, where N can be from 1 to 6 * `sys.no-input-default` * `sys.invalid-parameter` `initial_prompt_fulfillment` provides the first prompt for the parameter. If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the `sys.no-match-1`/`sys.no-input-1` handler (if defined) will be called to provide a prompt. The `sys.no-match-2`/`sys.no-input-2` handler (if defined) will respond to the next no-match/no-input event, and so on. A `sys.no-match-default` or `sys.no-input-default` handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed. A `sys.invalid-parameter` handler can be defined to handle the case where the parameter values have been `invalidated` by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the `sys.invalid-parameter` handler (if defined) will be called to provide a prompt. If the event handler for the corresponding event can't be found on the parameter, `initial_prompt_fulfillment` will be re-prompted.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1EventHandler" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Fulfillment": { + "description": "A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.", + "id": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "properties": { + "conditionalCases": { + "description": "Conditional cases for this fulfillment.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases" + }, + "type": "array" + }, + "messages": { + "description": "The list of rich message responses to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" + }, + "type": "array" + }, + "setParameterActions": { + "description": "Set parameter values before executing the webhook.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction" + }, + "type": "array" + }, + "tag": { + "description": "The tag used by the webhook to identify which fulfillment is being called. This field is required if `webhook` is specified.", + "type": "string" + }, + "webhook": { + "description": "The webhook to call. Format: `projects//locations//agents//webhooks/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases": { + "description": "A list of cascading if-else conditions. Cases are mutually exclusive. The first one with a matching condition is selected, all the rest ignored.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases", + "properties": { + "cases": { + "description": "A list of cascading if-else conditions.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase": { + "description": "Each case has a Boolean condition. When it is evaluated to be True, the corresponding messages will be selected and evaluated recursively.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCase", + "properties": { + "caseContent": { + "description": "A list of case content.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent" + }, + "type": "array" + }, + "condition": { + "description": "The condition to activate and select this case. Empty means the condition is always true. The condition is evaluated against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent": { + "description": "The list of messages or conditional cases to activate for this case.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCasesCaseCaseContent", + "properties": { + "additionalCases": { + "$ref": "GoogleCloudDialogflowCxV3beta1FulfillmentConditionalCases", + "description": "Additional cases to be evaluated." + }, + "message": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage", + "description": "Returned message." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction": { + "description": "Setting a parameter value.", + "id": "GoogleCloudDialogflowCxV3beta1FulfillmentSetParameterAction", + "properties": { + "parameter": { + "description": "Display name of the parameter.", + "type": "string" + }, + "value": { + "description": "The new value of the parameter. A null value clears the parameter.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": { + "description": "Metadata in google::longrunning::Operation for Knowledge operations.", + "id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "properties": { + "state": { + "description": "Required. Output only. The current state of this operation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": { + "description": "Metadata for ImportDocuments operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": { + "description": "Response message for Documents.ImportDocuments.", + "id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse", + "properties": { + "warnings": { + "description": "Includes details about skipped documents or any other warnings.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { + "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", + "properties": { + "errors": { + "description": "Errors for failed test cases.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseError" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse": { + "description": "The response message for TestCases.ImportTestCases.", + "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesResponse", + "properties": { + "names": { + "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1InputAudioConfig": { + "description": "Instructs the speech recognizer on how to process the audio content.", + "id": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", + "properties": { + "audioEncoding": { + "description": "Required. Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "model": { + "description": "Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.", + "type": "string" + }, + "modelVariant": { + "description": "Optional. Which variant of the Speech model to use.", + "enum": [ + "SPEECH_MODEL_VARIANT_UNSPECIFIED", + "USE_BEST_AVAILABLE", + "USE_STANDARD", + "USE_ENHANCED" + ], + "enumDescriptions": [ + "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", + "Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.", + "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", + "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible." + ], + "type": "string" + }, + "phraseHints": { + "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, + "singleUtterance": { + "description": "Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Intent": { + "description": "An intent represents a user's intent to interact with a conversational agent. You can provide information for the Dialogflow API to use to match user input to an intent by adding training phrases (i.e., examples of user input) to your intent.", + "id": "GoogleCloudDialogflowCxV3beta1Intent", + "properties": { + "description": { + "description": "Optional. Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.", + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the intent, unique within the agent.", + "type": "string" + }, + "isFallback": { + "description": "Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event.", + "type": "boolean" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix \"sys-\" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. \"sys-head\" means the intent is a head intent. \"sys-contextual\" means the intent is a contextual intent.", + "type": "object" + }, + "name": { + "description": "The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`.", + "type": "string" + }, + "parameters": { + "description": "The collection of parameters associated with the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentParameter" + }, + "type": "array" + }, + "priority": { + "description": "The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", + "format": "int32", + "type": "integer" + }, + "trainingPhrases": { + "description": "The collection of training phrases the agent is trained on to identify the intent.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentInput": { + "description": "Represents the intent to trigger programmatically rather than as a result of natural language processing.", + "id": "GoogleCloudDialogflowCxV3beta1IntentInput", + "properties": { + "intent": { + "description": "Required. The unique identifier of the intent. Format: `projects//locations//agents//intents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentParameter": { + "description": "Represents an intent parameter.", + "id": "GoogleCloudDialogflowCxV3beta1IntentParameter", + "properties": { + "entityType": { + "description": "Required. The entity type of the parameter. Format: `projects/-/locations/-/agents/-/entityTypes/` for system entity types (for example, `projects/-/locations/-/agents/-/entityTypes/sys.date`), or `projects//locations//agents//entityTypes/` for developer entity types.", + "type": "string" + }, + "id": { + "description": "Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.", + "type": "string" + }, + "isList": { + "description": "Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "redact": { + "description": "Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase": { + "description": "Represents an example that the agent is trained on to identify the intent.", + "id": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrase", + "properties": { + "id": { + "description": "Output only. The unique identifier of the training phrase.", + "type": "string" + }, + "parts": { + "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `parameter_id` field is set.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart" + }, + "type": "array" + }, + "repeatCount": { + "description": "Indicates how many times this example was added to the intent.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart": { + "description": "Represents a part of a training phrase.", + "id": "GoogleCloudDialogflowCxV3beta1IntentTrainingPhrasePart", + "properties": { + "parameterId": { + "description": "The parameter used to annotate this part of the training phrase. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "text": { + "description": "Required. The text for this part.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1Page": { + "description": "A Dialogflow CX conversation (session) can be described and visualized as a state machine. The states of a CX session are represented by pages. For each flow, you define many pages, where your combined pages can handle a complete conversation on the topics the flow is designed for. At any given moment, exactly one page is the current page, the current page is considered active, and the flow associated with that page is considered active. Every flow has a special start page. When a flow initially becomes active, the start page page becomes the current page. For each conversational turn, the current page will either stay the same or transition to another page. You configure each page to collect information from the end-user that is relevant for the conversational state represented by the page. For more information, see the [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).", + "id": "GoogleCloudDialogflowCxV3beta1Page", + "properties": { + "displayName": { + "description": "Required. The human-readable name of the page, unique within the agent.", + "type": "string" + }, + "entryFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "The fulfillment to call when the session is entering the page." + }, + "eventHandlers": { + "description": "Handlers associated with the page to handle events such as webhook errors, no match or no input.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1EventHandler" + }, + "type": "array" + }, + "form": { + "$ref": "GoogleCloudDialogflowCxV3beta1Form", + "description": "The form associated with the page, used for collecting parameters relevant to the page." + }, + "name": { + "description": "The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "transitionRouteGroups": { + "description": "Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "transitionRoutes": { + "description": "A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TransitionRoute" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1PageInfo": { + "description": "Represents page information communicated to and from the webhook.", + "id": "GoogleCloudDialogflowCxV3beta1PageInfo", + "properties": { + "currentPage": { + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "formInfo": { + "$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo", + "description": "Optional for both WebhookRequest and WebhookResponse. Information about the form." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo": { + "description": "Represents form information.", + "id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo", + "properties": { + "parameterInfo": { + "description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo": { + "description": "Represents parameter information.", + "id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo", + "properties": { + "displayName": { + "description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.", + "type": "string" + }, + "justCollected": { + "description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.", + "type": "boolean" + }, + "required": { + "description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", + "type": "boolean" + }, + "state": { + "description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.", + "enum": [ + "PARAMETER_STATE_UNSPECIFIED", + "EMPTY", + "INVALID", + "FILLED" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "Indicates that the parameter does not have a value.", + "Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", + "Indicates that the parameter has a value." + ], + "type": "string" + }, + "value": { + "description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1QueryInput": { + "description": "Represents the query input. It can contain one of: 1. A conversational query in the form of text. 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be processed. 4. An event to be triggered. ", + "id": "GoogleCloudDialogflowCxV3beta1QueryInput", + "properties": { + "audio": { + "$ref": "GoogleCloudDialogflowCxV3beta1AudioInput", + "description": "The natural language speech audio to be processed." + }, + "dtmf": { + "$ref": "GoogleCloudDialogflowCxV3beta1DtmfInput", + "description": "The DTMF event to be handled." + }, + "event": { + "$ref": "GoogleCloudDialogflowCxV3beta1EventInput", + "description": "The event to be triggered." + }, + "intent": { + "$ref": "GoogleCloudDialogflowCxV3beta1IntentInput", + "description": "The intent to be triggered." + }, + "languageCode": { + "description": "Required. The language of the input. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, + "text": { + "$ref": "GoogleCloudDialogflowCxV3beta1TextInput", + "description": "The natural language text to be processed." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": { + "description": "Metadata for ReloadDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessage": { + "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessage", + "properties": { + "conversationSuccess": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess", + "description": "Indicates that the conversation succeeded." + }, + "endInteraction": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction", + "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.", + "readOnly": true + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a human agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio", + "description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "readOnly": true + }, + "outputAudioText": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText", + "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "playAudio": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio", + "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way." + }, + "text": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess": { + "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": { + "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "ssml": { + "description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).", + "type": "string" + }, + "text": { + "description": "The raw text to be synthesized.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": { + "description": "Specifies an audio clip to be played by the client as part of the response.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "audioUri": { + "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", + "properties": { + "allowPlaybackInterruption": { + "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", + "readOnly": true, + "type": "boolean" + }, + "text": { + "description": "Required. A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata": { + "description": "Metadata returned for the TestCases.RunTestCase long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1RunTestCaseMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1RunTestCaseResponse": { + "description": "The response message for TestCases.RunTestCase.", + "id": "GoogleCloudDialogflowCxV3beta1RunTestCaseResponse", + "properties": { + "result": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult", + "description": "The result." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1SessionInfo": { + "description": "Represents session information communicated to and from the webhook.", + "id": "GoogleCloudDialogflowCxV3beta1SessionInfo", + "properties": { + "parameters": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", + "type": "object" + }, + "session": { + "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a session. Format: `projects//locations//agents//sessions/` or `projects//locations//agents//environments//sessions/` if environment is specified.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestCase": { + "description": "Represents a test case.", + "id": "GoogleCloudDialogflowCxV3beta1TestCase", + "properties": { + "creationTime": { + "description": "Output only. When the test was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters.", + "type": "string" + }, + "lastTestResult": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCaseResult", + "description": "The latest test result." + }, + "name": { + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "type": "string" + }, + "notes": { + "description": "Additional freeform notes about the test case. Limit of 400 characters.", + "type": "string" + }, + "tags": { + "description": "Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with \"#\" and has a limit of 30 characters.", + "items": { + "type": "string" + }, + "type": "array" + }, + "testCaseConversationTurns": { + "description": "The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurn" + }, + "type": "array" + }, + "testConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestConfig", + "description": "Config for the test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestCaseError": { + "description": "Error info for importing a test.", + "id": "GoogleCloudDialogflowCxV3beta1TestCaseError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test case." + }, + "testCase": { + "$ref": "GoogleCloudDialogflowCxV3beta1TestCase", + "description": "The test case." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestCaseResult": { + "description": "Represents a result from running a test case in an agent environment.", + "id": "GoogleCloudDialogflowCxV3beta1TestCaseResult", + "properties": { + "conversationTurns": { + "description": "The conversation turns uttered during the test case replay in chronological order.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ConversationTurn" + }, + "type": "array" + }, + "environment": { + "description": "Environment where the test was run. If not set, it indicates the draft environment.", + "type": "string" + }, + "name": { + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "type": "string" + }, + "testResult": { + "description": "Whether the test case passed in the agent environment.", + "enum": [ + "TEST_RESULT_UNSPECIFIED", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "Not specified. Should never be used.", + "The test passed.", + "The test did not pass." + ], + "type": "string" + }, + "testTime": { + "description": "The time that the test was run.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestConfig": { + "description": "Represents configurations for a test case.", + "id": "GoogleCloudDialogflowCxV3beta1TestConfig", + "properties": { + "flow": { + "description": "Flow name. If not set, default start flow is assumed. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "trackingParameters": { + "description": "Session parameters to be compared when calculating differences.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestError": { + "description": "Error info for running a test.", + "id": "GoogleCloudDialogflowCxV3beta1TestError", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status associated with the test." + }, + "testCase": { + "description": "The test case resource name.", + "type": "string" + }, + "testTime": { + "description": "The timestamp when the test was completed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TestRunDifference": { + "description": "The description of differences between original and replayed agent output.", + "id": "GoogleCloudDialogflowCxV3beta1TestRunDifference", + "properties": { + "description": { + "description": "A description of the diff, showing the actual output vs expected output.", + "type": "string" + }, + "type": { + "description": "The type of diff.", + "enum": [ + "DIFF_TYPE_UNSPECIFIED", + "INTENT", + "PAGE", + "PARAMETERS", + "UTTERANCE" + ], + "enumDescriptions": [ + "Should never be used.", + "The intent.", + "The page.", + "The parameters.", + "The message utterance." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TextInput": { + "description": "Represents the natural language text to be processed.", + "id": "GoogleCloudDialogflowCxV3beta1TextInput", + "properties": { + "text": { + "description": "Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TransitionRoute": { + "description": "A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a `trigger_fulfillment` associated with the transition, it will be called. * If there is a `target_page` associated with the transition, the session will transition into the specified page. * If there is a `target_flow` associated with the transition, the session will transition into the specified flow.", + "id": "GoogleCloudDialogflowCxV3beta1TransitionRoute", + "properties": { + "condition": { + "description": "The condition to evaluate against form parameters or session parameters. See the [conditions reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition). At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "intent": { + "description": "The unique identifier of an Intent. Format: `projects//locations//agents//intents/`. Indicates that the transition can only happen when the given intent is matched. At least one of `intent` or `condition` must be specified. When both `intent` and `condition` are specified, the transition can only happen when both are fulfilled.", + "type": "string" + }, + "name": { + "description": "Output only. The unique identifier of this transition route.", + "readOnly": true, + "type": "string" + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + }, + "triggerFulfillment": { + "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", + "description": "The fulfillment to call when the condition is satisfied. At least one of `trigger_fulfillment` and `target` must be specified. When both are defined, `trigger_fulfillment` is executed first." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { + "description": "Metadata for UpdateDocument operation.", + "id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1WebhookRequest": { + "description": "The request message for a webhook call.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", + "properties": { + "detectIntentResponseId": { + "description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.", + "type": "string" + }, + "fulfillmentInfo": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo", + "description": "Always present. Information about the fulfillment that triggered this webhook call." + }, + "intentInfo": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", + "description": "Information about the last matched intent." + }, + "messages": { + "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" + }, + "type": "array" + }, + "pageInfo": { + "$ref": "GoogleCloudDialogflowCxV3beta1PageInfo", + "description": "Information about page status." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom data set in QueryParameters.payload.", + "type": "object" + }, + "sessionInfo": { + "$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo", + "description": "Information about session status." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo": { + "description": "Represents fulfillment information communicated to the webhook.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo", + "properties": { + "tag": { + "description": "Always present. The tag used to identify which fulfillment is being called.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo": { + "description": "Represents intent information communicated to the webhook.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", + "properties": { + "confidence": { + "description": "The confidence of the matched intent. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).", + "format": "float", + "type": "number" + }, + "displayName": { + "description": "Always present. The display name of the last matched intent.", + "type": "string" + }, + "lastMatchedIntent": { + "description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue" + }, + "description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue": { + "description": "Represents a value for an intent parameter.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue", + "properties": { + "originalValue": { + "description": "Always present. Original text value extracted from user utterance.", + "type": "string" + }, + "resolvedValue": { + "description": "Always present. Structured value for the parameter extracted from user utterance.", + "type": "any" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1WebhookResponse": { + "description": "The response message for a webhook call.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookResponse", + "properties": { + "fulfillmentResponse": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse", + "description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user." + }, + "pageInfo": { + "$ref": "GoogleCloudDialogflowCxV3beta1PageInfo", + "description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Value to append directly to QueryResult.webhook_payloads.", + "type": "object" + }, + "sessionInfo": { + "$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo", + "description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status." + }, + "targetFlow": { + "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", + "type": "string" + }, + "targetPage": { + "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse": { + "description": "Represents a fulfillment response to the user.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse", + "properties": { + "mergeBehavior": { + "description": "Merge behavior for `messages`.", + "enum": [ + "MERGE_BEHAVIOR_UNSPECIFIED", + "APPEND", + "REPLACE" + ], + "enumDescriptions": [ + "Not specified. `APPEND` will be used.", + "`messages` will be appended to the list of messages waiting to be sent to the user.", + "`messages` will replace the list of messages waiting to be sent to the user." + ], + "type": "string" + }, + "messages": { + "description": "The list of rich message responses to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2AnnotatedMessagePart": { + "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", + "id": "GoogleCloudDialogflowV2AnnotatedMessagePart", + "properties": { + "entityType": { + "description": "The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity.", + "type": "string" + }, + "formattedValue": { + "description": "The [Dialogflow system entity formatted value ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. For example for a system entity of type `@sys.unit-currency`, this may contain: { \"amount\": 5, \"currency\": \"USD\" } ", + "type": "any" + }, + "text": { + "description": "A part of a message possibly annotated with an entity.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse": { + "description": "The response message for EntityTypes.BatchUpdateEntityTypes.", + "id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse", + "properties": { + "entityTypes": { + "description": "The collection of updated or created entity types.", + "items": { + "$ref": "GoogleCloudDialogflowV2EntityType" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2BatchUpdateIntentsResponse": { + "description": "The response message for Intents.BatchUpdateIntents.", + "id": "GoogleCloudDialogflowV2BatchUpdateIntentsResponse", + "properties": { + "intents": { + "description": "The collection of updated or created intents.", + "items": { + "$ref": "GoogleCloudDialogflowV2Intent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2Context": { + "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", + "id": "GoogleCloudDialogflowV2Context", + "properties": { + "lifespanCount": { + "description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ConversationEvent": { + "description": "Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.", + "id": "GoogleCloudDialogflowV2ConversationEvent", + "properties": { + "conversation": { + "description": "The unique identifier of the conversation this notification refers to. Format: `projects//conversations/`.", + "type": "string" + }, + "errorStatus": { + "$ref": "GoogleRpcStatus", + "description": "More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL." + }, + "newMessagePayload": { + "$ref": "GoogleCloudDialogflowV2Message", + "description": "Payload of NEW_MESSAGE event." + }, + "type": { + "description": "The type of the event that this notification refers to.", + "enum": [ + "TYPE_UNSPECIFIED", + "CONVERSATION_STARTED", + "CONVERSATION_FINISHED", + "HUMAN_INTERVENTION_NEEDED", + "NEW_MESSAGE", + "UNRECOVERABLE_ERROR" + ], + "enumDescriptions": [ + "Type not set.", + "A new conversation has been opened. This is fired when a telephone call is answered, or a conversation is created via the API.", + "An existing conversation has closed. This is fired when a telephone call is terminated, or a conversation is closed via the API.", + "An existing conversation has received notification from Dialogflow that human intervention is required.", + "An existing conversation has received a new message, either from API or telephony. It is configured in ConversationProfile.new_message_event_notification_config", + "Unrecoverable error during a telephone call. In general non-recoverable errors only occur if something was misconfigured in the ConversationProfile corresponding to the call. After a non-recoverable error, Dialogflow may stop responding. We don't fire this event: * in an API call because we can directly return the error, or, * when we can recover from an error." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2EntityType": { + "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", + "id": "GoogleCloudDialogflowV2EntityType", + "properties": { + "autoExpansionMode": { + "description": "Optional. Indicates whether the entity type can be automatically expanded.", + "enum": [ + "AUTO_EXPANSION_MODE_UNSPECIFIED", + "AUTO_EXPANSION_MODE_DEFAULT" + ], + "enumDescriptions": [ + "Auto expansion disabled for the entity.", + "Allows an agent to recognize values that have not been explicitly listed in the entity." + ], + "type": "string" + }, + "displayName": { + "description": "Required. The name of the entity type.", + "type": "string" + }, + "enableFuzzyExtraction": { + "description": "Optional. Enables fuzzy entity extraction during classification.", + "type": "boolean" + }, + "entities": { + "description": "Optional. The collection of entity entries associated with the entity type.", + "items": { + "$ref": "GoogleCloudDialogflowV2EntityTypeEntity" + }, + "type": "array" + }, + "kind": { + "description": "Required. Indicates the kind of entity type.", + "enum": [ + "KIND_UNSPECIFIED", + "KIND_MAP", + "KIND_LIST", + "KIND_REGEXP" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "Map entity types allow mapping of a group of synonyms to a reference value.", + "List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).", + "Regexp entity types allow to specify regular expressions in entries values." + ], + "type": "string" + }, + "name": { + "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2EntityTypeEntity": { + "description": "An **entity entry** for an associated entity type.", + "id": "GoogleCloudDialogflowV2EntityTypeEntity", + "properties": { + "synonyms": { + "description": "Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "value": { + "description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2EventInput": { + "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", + "id": "GoogleCloudDialogflowV2EventInput", + "properties": { + "languageCode": { + "description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, + "name": { + "description": "Required. The unique identifier of the event.", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowV2ExportAgentResponse", + "properties": { + "agentContent": { + "description": "Zip compressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2Intent": { + "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", + "id": "GoogleCloudDialogflowV2Intent", + "properties": { + "action": { + "description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.", + "type": "string" + }, + "defaultResponsePlatforms": { + "description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).", + "items": { + "enum": [ + "PLATFORM_UNSPECIFIED", + "FACEBOOK", + "SLACK", + "TELEGRAM", + "KIK", + "SKYPE", + "LINE", + "VIBER", + "ACTIONS_ON_GOOGLE", + "GOOGLE_HANGOUTS" + ], + "enumDescriptions": [ + "Default platform.", + "Facebook.", + "Slack.", + "Telegram.", + "Kik.", + "Skype.", + "Line.", + "Viber.", + "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "Google Hangouts." + ], + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The name of this intent.", + "type": "string" + }, + "events": { + "description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.", + "items": { + "type": "string" + }, + "type": "array" + }, + "followupIntentInfo": { + "description": "Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentFollowupIntentInfo" + }, + "type": "array" + }, + "inputContextNames": { + "description": "Optional. The list of context names required for this intent to be triggered. Format: `projects//agent/sessions/-/contexts/`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "isFallback": { + "description": "Optional. Indicates whether this is a fallback intent.", + "type": "boolean" + }, + "messages": { + "description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessage" + }, + "type": "array" + }, + "mlDisabled": { + "description": "Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.", + "type": "boolean" + }, + "name": { + "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`.", + "type": "string" + }, + "outputContexts": { + "description": "Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.", + "items": { + "$ref": "GoogleCloudDialogflowV2Context" + }, + "type": "array" + }, + "parameters": { + "description": "Optional. The collection of parameters associated with the intent.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentParameter" + }, + "type": "array" + }, + "parentFollowupIntentName": { + "description": "Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.", + "type": "string" + }, + "priority": { + "description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", + "format": "int32", + "type": "integer" + }, + "resetContexts": { + "description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.", + "type": "boolean" + }, + "rootFollowupIntentName": { + "description": "Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects//agent/intents/`.", + "type": "string" + }, + "trainingPhrases": { + "description": "Optional. The collection of examples that the agent is trained on.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentTrainingPhrase" + }, + "type": "array" + }, + "webhookState": { + "description": "Optional. Indicates whether webhooks are enabled for the intent.", + "enum": [ + "WEBHOOK_STATE_UNSPECIFIED", + "WEBHOOK_STATE_ENABLED", + "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" + ], + "enumDescriptions": [ + "Webhook is disabled in the agent and in the intent.", + "Webhook is enabled in the agent and in the intent.", + "Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentFollowupIntentInfo": { + "description": "Represents a single followup intent in the chain.", + "id": "GoogleCloudDialogflowV2IntentFollowupIntentInfo", + "properties": { + "followupIntentName": { + "description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.", + "type": "string" + }, + "parentFollowupIntentName": { + "description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessage": { + "description": "A rich response message. Corresponds to the intent `Response` field in the Dialogflow console. For more information, see [Rich response messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).", + "id": "GoogleCloudDialogflowV2IntentMessage", + "properties": { + "basicCard": { + "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCard", + "description": "The basic card response for Actions on Google." + }, + "browseCarouselCard": { + "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard", + "description": "Browse carousel card for Actions on Google." + }, + "card": { + "$ref": "GoogleCloudDialogflowV2IntentMessageCard", + "description": "The card response." + }, + "carouselSelect": { + "$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelect", + "description": "The carousel card response for Actions on Google." + }, + "image": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "The image response." + }, + "linkOutSuggestion": { + "$ref": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion", + "description": "The link out suggestion chip for Actions on Google." + }, + "listSelect": { + "$ref": "GoogleCloudDialogflowV2IntentMessageListSelect", + "description": "The list card response for Actions on Google." + }, + "mediaContent": { + "$ref": "GoogleCloudDialogflowV2IntentMessageMediaContent", + "description": "The media content card for Actions on Google." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "A custom platform-specific response.", + "type": "object" + }, + "platform": { + "description": "Optional. The platform that this message is intended for.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "FACEBOOK", + "SLACK", + "TELEGRAM", + "KIK", + "SKYPE", + "LINE", + "VIBER", + "ACTIONS_ON_GOOGLE", + "GOOGLE_HANGOUTS" + ], + "enumDescriptions": [ + "Default platform.", + "Facebook.", + "Slack.", + "Telegram.", + "Kik.", + "Skype.", + "Line.", + "Viber.", + "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "Google Hangouts." + ], + "type": "string" + }, + "quickReplies": { + "$ref": "GoogleCloudDialogflowV2IntentMessageQuickReplies", + "description": "The quick replies response." + }, + "simpleResponses": { + "$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponses", + "description": "The voice and text-only responses for Actions on Google." + }, + "suggestions": { + "$ref": "GoogleCloudDialogflowV2IntentMessageSuggestions", + "description": "The suggestion chips for Actions on Google." + }, + "tableCard": { + "$ref": "GoogleCloudDialogflowV2IntentMessageTableCard", + "description": "Table card for Actions on Google." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2IntentMessageText", + "description": "The text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageBasicCard": { + "description": "The basic card message. Useful for displaying information.", + "id": "GoogleCloudDialogflowV2IntentMessageBasicCard", + "properties": { + "buttons": { + "description": "Optional. The collection of card buttons.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton" + }, + "type": "array" + }, + "formattedText": { + "description": "Required, unless image is present. The body text of the card.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "Optional. The image for the card." + }, + "subtitle": { + "description": "Optional. The subtitle of the card.", + "type": "string" + }, + "title": { + "description": "Optional. The title of the card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageBasicCardButton": { + "description": "The button object that appears at the bottom of a card.", + "id": "GoogleCloudDialogflowV2IntentMessageBasicCardButton", + "properties": { + "openUriAction": { + "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction", + "description": "Required. Action to take when a user taps on the button." + }, + "title": { + "description": "Required. The title of the button.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": { + "description": "Opens the given URI.", + "id": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction", + "properties": { + "uri": { + "description": "Required. The HTTP or HTTPS scheme URI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard": { + "description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel", + "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard", + "properties": { + "imageDisplayOptions": { + "description": "Optional. Settings for displaying the image. Applies to every image in items.", + "enum": [ + "IMAGE_DISPLAY_OPTIONS_UNSPECIFIED", + "GRAY", + "WHITE", + "CROPPED", + "BLURRED_BACKGROUND" + ], + "enumDescriptions": [ + "Fill the gaps between the image and the image container with gray bars.", + "Fill the gaps between the image and the image container with gray bars.", + "Fill the gaps between the image and the image container with white bars.", + "Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.", + "Pad the gaps between image and image frame with a blurred copy of the same image." + ], + "type": "string" + }, + "items": { + "description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem": { + "description": "Browsing carousel tile", + "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem", + "properties": { + "description": { + "description": "Optional. Description of the carousel item. Maximum of four lines of text.", + "type": "string" + }, + "footer": { + "description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "Optional. Hero image for the carousel item." + }, + "openUriAction": { + "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", + "description": "Required. Action to present to the user." + }, + "title": { + "description": "Required. Title of the carousel item. Maximum of two lines of text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": { + "description": "Actions on Google action to open a given url.", + "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", + "properties": { + "url": { + "description": "Required. URL", + "type": "string" + }, + "urlTypeHint": { + "description": "Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.", + "enum": [ + "URL_TYPE_HINT_UNSPECIFIED", + "AMP_ACTION", + "AMP_CONTENT" + ], + "enumDescriptions": [ + "Unspecified", + "Url would be an amp action", + "URL that points directly to AMP content, or to a canonical URL which refers to AMP content via ." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageCard": { + "description": "The card response message.", + "id": "GoogleCloudDialogflowV2IntentMessageCard", + "properties": { + "buttons": { + "description": "Optional. The collection of card buttons.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageCardButton" + }, + "type": "array" + }, + "imageUri": { + "description": "Optional. The public URI to an image file for the card.", + "type": "string" + }, + "subtitle": { + "description": "Optional. The subtitle of the card.", + "type": "string" + }, + "title": { + "description": "Optional. The title of the card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageCardButton": { + "description": "Contains information about a button.", + "id": "GoogleCloudDialogflowV2IntentMessageCardButton", + "properties": { + "postback": { + "description": "Optional. The text to send back to the Dialogflow API or a URI to open.", + "type": "string" + }, + "text": { + "description": "Optional. The text to show on the button.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageCarouselSelect": { + "description": "The card for presenting a carousel of options to select from.", + "id": "GoogleCloudDialogflowV2IntentMessageCarouselSelect", + "properties": { + "items": { + "description": "Required. Carousel items.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": { + "description": "An item in the carousel.", + "id": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem", + "properties": { + "description": { + "description": "Optional. The body text of the card.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "Optional. The image to display." + }, + "info": { + "$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo", + "description": "Required. Additional info about the option item." + }, + "title": { + "description": "Required. Title of the carousel item.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageColumnProperties": { + "description": "Column properties for TableCard.", + "id": "GoogleCloudDialogflowV2IntentMessageColumnProperties", + "properties": { + "header": { + "description": "Required. Column heading.", + "type": "string" + }, + "horizontalAlignment": { + "description": "Optional. Defines text alignment for all cells in this column.", + "enum": [ + "HORIZONTAL_ALIGNMENT_UNSPECIFIED", + "LEADING", + "CENTER", + "TRAILING" + ], + "enumDescriptions": [ + "Text is aligned to the leading edge of the column.", + "Text is aligned to the leading edge of the column.", + "Text is centered in the column.", + "Text is aligned to the trailing edge of the column." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageImage": { + "description": "The image response message.", + "id": "GoogleCloudDialogflowV2IntentMessageImage", + "properties": { + "accessibilityText": { + "description": "Optional. A text description of the image to be used for accessibility, e.g., screen readers.", + "type": "string" + }, + "imageUri": { + "description": "Optional. The public URI to an image file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion": { + "description": "The suggestion chip message that allows the user to jump out to the app or website associated with this agent.", + "id": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion", + "properties": { + "destinationName": { + "description": "Required. The name of the app or site this chip is linking to.", + "type": "string" + }, + "uri": { + "description": "Required. The URI of the app or site to open when the user taps the suggestion chip.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageListSelect": { + "description": "The card for presenting a list of options to select from.", + "id": "GoogleCloudDialogflowV2IntentMessageListSelect", + "properties": { + "items": { + "description": "Required. List items.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageListSelectItem" + }, + "type": "array" + }, + "subtitle": { + "description": "Optional. Subtitle of the list.", + "type": "string" + }, + "title": { + "description": "Optional. The overall title of the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageListSelectItem": { + "description": "An item in the list.", + "id": "GoogleCloudDialogflowV2IntentMessageListSelectItem", + "properties": { + "description": { + "description": "Optional. The main text describing the item.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "Optional. The image to display." + }, + "info": { + "$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo", + "description": "Required. Additional information about this option." + }, + "title": { + "description": "Required. The title of the list item.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageMediaContent": { + "description": "The media content card for Actions on Google.", + "id": "GoogleCloudDialogflowV2IntentMessageMediaContent", + "properties": { + "mediaObjects": { + "description": "Required. List of media objects.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject" + }, + "type": "array" + }, + "mediaType": { + "description": "Optional. What type of media is the content (ie \"audio\").", + "enum": [ + "RESPONSE_MEDIA_TYPE_UNSPECIFIED", + "AUDIO" + ], + "enumDescriptions": [ + "Unspecified.", + "Response media type is audio." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject": { + "description": "Response media object for media content card.", + "id": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject", + "properties": { + "contentUrl": { + "description": "Required. Url where the media is stored.", + "type": "string" + }, + "description": { + "description": "Optional. Description of media card.", + "type": "string" + }, + "icon": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "Optional. Icon to display above media content." + }, + "largeImage": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "Optional. Image to display above media content." + }, + "name": { + "description": "Required. Name of media card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageQuickReplies": { + "description": "The quick replies response message.", + "id": "GoogleCloudDialogflowV2IntentMessageQuickReplies", + "properties": { + "quickReplies": { + "description": "Optional. The collection of quick replies.", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Optional. The title of the collection of quick replies.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageSelectItemInfo": { + "description": "Additional info about the select item for when it is triggered in a dialog.", + "id": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo", + "properties": { + "key": { + "description": "Required. A unique key that will be sent back to the agent if this response is given.", + "type": "string" + }, + "synonyms": { + "description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageSimpleResponse": { + "description": "The simple response message containing speech or text.", + "id": "GoogleCloudDialogflowV2IntentMessageSimpleResponse", + "properties": { + "displayText": { + "description": "Optional. The text to display.", + "type": "string" + }, + "ssml": { + "description": "One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.", + "type": "string" + }, + "textToSpeech": { + "description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageSimpleResponses": { + "description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.", + "id": "GoogleCloudDialogflowV2IntentMessageSimpleResponses", + "properties": { + "simpleResponses": { + "description": "Required. The list of simple responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageSuggestion": { + "description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.", + "id": "GoogleCloudDialogflowV2IntentMessageSuggestion", + "properties": { + "title": { + "description": "Required. The text shown the in the suggestion chip.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageSuggestions": { + "description": "The collection of suggestions.", + "id": "GoogleCloudDialogflowV2IntentMessageSuggestions", + "properties": { + "suggestions": { + "description": "Required. The list of suggested replies.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageSuggestion" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageTableCard": { + "description": "Table card for Actions on Google.", + "id": "GoogleCloudDialogflowV2IntentMessageTableCard", + "properties": { + "buttons": { + "description": "Optional. List of buttons for the card.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton" + }, + "type": "array" + }, + "columnProperties": { + "description": "Optional. Display properties for the columns in this table.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageColumnProperties" + }, + "type": "array" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2IntentMessageImage", + "description": "Optional. Image which should be displayed on the card." + }, + "rows": { + "description": "Optional. Rows in this table of data.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageTableCardRow" + }, + "type": "array" + }, + "subtitle": { + "description": "Optional. Subtitle to the title.", + "type": "string" + }, + "title": { + "description": "Required. Title of the card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageTableCardCell": { + "description": "Cell of TableCardRow.", + "id": "GoogleCloudDialogflowV2IntentMessageTableCardCell", + "properties": { + "text": { + "description": "Required. Text in this cell.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageTableCardRow": { + "description": "Row of TableCard.", + "id": "GoogleCloudDialogflowV2IntentMessageTableCardRow", + "properties": { + "cells": { + "description": "Optional. List of cells that make up this row.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessageTableCardCell" + }, + "type": "array" + }, + "dividerAfter": { + "description": "Optional. Whether to add a visual divider after this row.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2IntentMessageText", + "properties": { + "text": { + "description": "Optional. The collection of the agent's responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentParameter": { + "description": "Represents intent parameters.", + "id": "GoogleCloudDialogflowV2IntentParameter", + "properties": { + "defaultValue": { + "description": "Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.", + "type": "string" + }, + "displayName": { + "description": "Required. The name of the parameter.", + "type": "string" + }, + "entityTypeDisplayName": { + "description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.", + "type": "string" + }, + "isList": { + "description": "Optional. Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "mandatory": { + "description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.", + "type": "boolean" + }, + "name": { + "description": "The unique identifier of this parameter.", + "type": "string" + }, + "prompts": { + "description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.", + "items": { + "type": "string" + }, + "type": "array" + }, + "value": { + "description": "Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentTrainingPhrase": { + "description": "Represents an example that the agent is trained on.", + "id": "GoogleCloudDialogflowV2IntentTrainingPhrase", + "properties": { + "name": { + "description": "Output only. The unique identifier of this training phrase.", + "type": "string" + }, + "parts": { + "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentTrainingPhrasePart" + }, + "type": "array" + }, + "timesAddedCount": { + "description": "Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Required. The type of the training phrase.", + "enum": [ + "TYPE_UNSPECIFIED", + "EXAMPLE", + "TEMPLATE" + ], + "enumDescriptions": [ + "Not specified. This value should never be used.", + "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", + "Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2IntentTrainingPhrasePart": { + "description": "Represents a part of a training phrase.", + "id": "GoogleCloudDialogflowV2IntentTrainingPhrasePart", + "properties": { + "alias": { + "description": "Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "entityType": { + "description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "text": { + "description": "Required. The text for this part.", + "type": "string" + }, + "userDefined": { + "description": "Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2Message": { + "description": "Represents a message posted into a conversation.", + "id": "GoogleCloudDialogflowV2Message", + "properties": { + "content": { + "description": "Required. The message content.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the message was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "languageCode": { + "description": "Optional. The message language. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", + "type": "string" + }, + "messageAnnotation": { + "$ref": "GoogleCloudDialogflowV2MessageAnnotation", + "description": "Output only. The annotation for the message.", + "readOnly": true + }, + "name": { + "description": "The unique identifier of the message. Format: `projects//locations//conversations//messages/`.", + "type": "string" + }, + "participant": { + "description": "Output only. The participant that sends this message.", + "readOnly": true, + "type": "string" + }, + "participantRole": { + "description": "Output only. The role of the participant.", + "enum": [ + "ROLE_UNSPECIFIED", + "HUMAN_AGENT", + "AUTOMATED_AGENT", + "END_USER" + ], + "enumDescriptions": [ + "Participant role not set.", + "Participant is a human agent.", + "Participant is an automated agent, such as a Dialogflow agent.", + "Participant is an end user that has called or chatted with Dialogflow services." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2MessageAnnotation": { + "description": "Represents the result of annotation for the message.", + "id": "GoogleCloudDialogflowV2MessageAnnotation", + "properties": { + "containEntities": { + "description": "Indicates whether the text message contains entities.", + "type": "boolean" + }, + "parts": { + "description": "The collection of annotated message parts ordered by their position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text].", + "items": { + "$ref": "GoogleCloudDialogflowV2AnnotatedMessagePart" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2OriginalDetectIntentRequest": { + "description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.", + "id": "GoogleCloudDialogflowV2OriginalDetectIntentRequest", + "properties": { + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.", + "type": "object" + }, + "source": { + "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.", + "type": "string" + }, + "version": { + "description": "Optional. The version of the protocol used for this request. This field is AoG-specific.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2QueryResult": { + "description": "Represents the result of conversational query or event processing.", + "id": "GoogleCloudDialogflowV2QueryResult", + "properties": { + "action": { + "description": "The action name from the matched intent.", + "type": "string" + }, + "allRequiredParamsPresent": { + "description": "This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.", + "type": "boolean" + }, + "diagnosticInfo": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors", + "type": "object" + }, + "fulfillmentMessages": { + "description": "The collection of rich messages to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessage" + }, + "type": "array" + }, + "fulfillmentText": { + "description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.", + "type": "string" + }, + "intent": { + "$ref": "GoogleCloudDialogflowV2Intent", + "description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`." + }, + "intentDetectionConfidence": { + "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.", + "format": "float", + "type": "number" + }, + "languageCode": { + "description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "type": "string" + }, + "outputContexts": { + "description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.", + "items": { + "$ref": "GoogleCloudDialogflowV2Context" + }, + "type": "array" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + }, + "queryText": { + "description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.", + "type": "string" + }, + "sentimentAnalysisResult": { + "$ref": "GoogleCloudDialogflowV2SentimentAnalysisResult", + "description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request." + }, + "speechRecognitionConfidence": { + "description": "The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.", + "format": "float", + "type": "number" + }, + "webhookPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.", + "type": "object" + }, + "webhookSource": { + "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2Sentiment": { + "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.", + "id": "GoogleCloudDialogflowV2Sentiment", + "properties": { + "magnitude": { + "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", + "format": "float", + "type": "number" + }, + "score": { + "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SentimentAnalysisResult": { + "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config", + "id": "GoogleCloudDialogflowV2SentimentAnalysisResult", + "properties": { + "queryTextSentiment": { + "$ref": "GoogleCloudDialogflowV2Sentiment", + "description": "The sentiment analysis result for `query_text`." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2SessionEntityType": { + "description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).", + "id": "GoogleCloudDialogflowV2SessionEntityType", + "properties": { + "entities": { + "description": "Required. The collection of entities associated with this session entity type.", + "items": { + "$ref": "GoogleCloudDialogflowV2EntityTypeEntity" + }, + "type": "array" + }, + "entityOverrideMode": { + "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", + "enum": [ + "ENTITY_OVERRIDE_MODE_UNSPECIFIED", + "ENTITY_OVERRIDE_MODE_OVERRIDE", + "ENTITY_OVERRIDE_MODE_SUPPLEMENT" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", + "The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge." + ], + "type": "string" + }, + "name": { + "description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2WebhookRequest": { + "description": "The request message for a webhook call.", + "id": "GoogleCloudDialogflowV2WebhookRequest", + "properties": { + "originalDetectIntentRequest": { + "$ref": "GoogleCloudDialogflowV2OriginalDetectIntentRequest", + "description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowV2QueryResult", + "description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`." + }, + "responseId": { + "description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.", + "type": "string" + }, + "session": { + "description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2WebhookResponse": { + "description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).", + "id": "GoogleCloudDialogflowV2WebhookResponse", + "properties": { + "followupEventInput": { + "$ref": "GoogleCloudDialogflowV2EventInput", + "description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields." + }, + "fulfillmentMessages": { + "description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.", + "items": { + "$ref": "GoogleCloudDialogflowV2IntentMessage" + }, + "type": "array" + }, + "fulfillmentText": { + "description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.", + "type": "string" + }, + "outputContexts": { + "description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.", + "items": { + "$ref": "GoogleCloudDialogflowV2Context" + }, + "type": "array" + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "type": "object" + }, + "sessionEntityTypes": { + "description": "Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.", + "items": { + "$ref": "GoogleCloudDialogflowV2SessionEntityType" + }, + "type": "array" + }, + "source": { + "description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": { + "description": "The response message for EntityTypes.BatchUpdateEntityTypes.", + "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse", + "properties": { + "entityTypes": { + "description": "The collection of updated or created entity types.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1EntityType" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse": { + "description": "The response message for Intents.BatchUpdateIntents.", + "id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse", + "properties": { + "intents": { + "description": "The collection of updated or created intents.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1Intent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1Context": { + "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", + "id": "GoogleCloudDialogflowV2beta1Context", + "properties": { + "lifespanCount": { + "description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1EntityType": { + "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", + "id": "GoogleCloudDialogflowV2beta1EntityType", + "properties": { + "autoExpansionMode": { + "description": "Optional. Indicates whether the entity type can be automatically expanded.", + "enum": [ + "AUTO_EXPANSION_MODE_UNSPECIFIED", + "AUTO_EXPANSION_MODE_DEFAULT" + ], + "enumDescriptions": [ + "Auto expansion disabled for the entity.", + "Allows an agent to recognize values that have not been explicitly listed in the entity." + ], + "type": "string" + }, + "displayName": { + "description": "Required. The name of the entity type.", + "type": "string" + }, + "enableFuzzyExtraction": { + "description": "Optional. Enables fuzzy entity extraction during classification.", + "type": "boolean" + }, + "entities": { + "description": "Optional. The collection of entity entries associated with the entity type.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" + }, + "type": "array" + }, + "kind": { + "description": "Required. Indicates the kind of entity type.", + "enum": [ + "KIND_UNSPECIFIED", + "KIND_MAP", + "KIND_LIST", + "KIND_REGEXP" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "Map entity types allow mapping of a group of synonyms to a reference value.", + "List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).", + "Regexp entity types allow to specify regular expressions in entries values." + ], + "type": "string" + }, + "name": { + "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1EntityTypeEntity": { + "description": "An **entity entry** for an associated entity type.", + "id": "GoogleCloudDialogflowV2beta1EntityTypeEntity", + "properties": { + "synonyms": { + "description": "Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "value": { + "description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1EventInput": { + "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", + "id": "GoogleCloudDialogflowV2beta1EventInput", + "properties": { + "languageCode": { + "description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, + "name": { + "description": "Required. The unique identifier of the event.", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "id": "GoogleCloudDialogflowV2beta1ExportAgentResponse", + "properties": { + "agentContent": { + "description": "Zip compressed raw byte content for agent.", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1Intent": { + "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", + "id": "GoogleCloudDialogflowV2beta1Intent", + "properties": { + "action": { + "description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.", + "type": "string" + }, + "defaultResponsePlatforms": { + "description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).", + "items": { + "enum": [ + "PLATFORM_UNSPECIFIED", + "FACEBOOK", + "SLACK", + "TELEGRAM", + "KIK", + "SKYPE", + "LINE", + "VIBER", + "ACTIONS_ON_GOOGLE", + "TELEPHONY", + "GOOGLE_HANGOUTS" + ], + "enumDescriptions": [ + "Not specified.", + "Facebook.", + "Slack.", + "Telegram.", + "Kik.", + "Skype.", + "Line.", + "Viber.", + "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "Telephony Gateway.", + "Google Hangouts." + ], + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The name of this intent.", + "type": "string" + }, + "endInteraction": { + "description": "Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.", + "type": "boolean" + }, + "events": { + "description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.", + "items": { + "type": "string" + }, + "type": "array" + }, + "followupIntentInfo": { + "description": "Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo" + }, + "readOnly": true, + "type": "array" + }, + "inputContextNames": { + "description": "Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`", + "items": { + "type": "string" + }, + "type": "array" + }, + "isFallback": { + "description": "Optional. Indicates whether this is a fallback intent.", + "type": "boolean" + }, + "messages": { + "description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" + }, + "type": "array" + }, + "mlDisabled": { + "description": "Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.", + "type": "boolean" + }, + "mlEnabled": { + "description": "Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.", + "type": "boolean" + }, + "name": { + "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", + "type": "string" + }, + "outputContexts": { + "description": "Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1Context" + }, + "type": "array" + }, + "parameters": { + "description": "Optional. The collection of parameters associated with the intent.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentParameter" + }, + "type": "array" + }, + "parentFollowupIntentName": { + "description": "Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.", + "type": "string" + }, + "priority": { + "description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", + "format": "int32", + "type": "integer" + }, + "resetContexts": { + "description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.", + "type": "boolean" + }, + "rootFollowupIntentName": { + "description": "Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.", + "readOnly": true, + "type": "string" + }, + "trainingPhrases": { + "description": "Optional. The collection of examples that the agent is trained on.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase" + }, + "type": "array" + }, + "webhookState": { + "description": "Optional. Indicates whether webhooks are enabled for the intent.", + "enum": [ + "WEBHOOK_STATE_UNSPECIFIED", + "WEBHOOK_STATE_ENABLED", + "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" + ], + "enumDescriptions": [ + "Webhook is disabled in the agent and in the intent.", + "Webhook is enabled in the agent and in the intent.", + "Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo": { + "description": "Represents a single followup intent in the chain.", + "id": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo", + "properties": { + "followupIntentName": { + "description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.", + "type": "string" + }, + "parentFollowupIntentName": { + "description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessage": { + "description": "Corresponds to the `Response` field in the Dialogflow console.", + "id": "GoogleCloudDialogflowV2beta1IntentMessage", + "properties": { + "basicCard": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard", + "description": "Displays a basic card for Actions on Google." + }, + "browseCarouselCard": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard", + "description": "Browse carousel card for Actions on Google." + }, + "card": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCard", + "description": "Displays a card." + }, + "carouselSelect": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect", + "description": "Displays a carousel card for Actions on Google." + }, + "image": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Displays an image." + }, + "linkOutSuggestion": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion", + "description": "Displays a link out suggestion chip for Actions on Google." + }, + "listSelect": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelect", + "description": "Displays a list card for Actions on Google." + }, + "mediaContent": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent", + "description": "The media content card for Actions on Google." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "A custom platform-specific response.", + "type": "object" + }, + "platform": { + "description": "Optional. The platform that this message is intended for.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "FACEBOOK", + "SLACK", + "TELEGRAM", + "KIK", + "SKYPE", + "LINE", + "VIBER", + "ACTIONS_ON_GOOGLE", + "TELEPHONY", + "GOOGLE_HANGOUTS" + ], + "enumDescriptions": [ + "Not specified.", + "Facebook.", + "Slack.", + "Telegram.", + "Kik.", + "Skype.", + "Line.", + "Viber.", + "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "Telephony Gateway.", + "Google Hangouts." + ], + "type": "string" + }, + "quickReplies": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies", + "description": "Displays quick replies." + }, + "rbmCarouselRichCard": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard", + "description": "Rich Business Messaging (RBM) carousel rich card response." + }, + "rbmStandaloneRichCard": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard", + "description": "Standalone Rich Business Messaging (RBM) rich card response." + }, + "rbmText": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmText", + "description": "Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging." + }, + "simpleResponses": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses", + "description": "Returns a voice or text-only response for Actions on Google." + }, + "suggestions": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions", + "description": "Displays suggestion chips for Actions on Google." + }, + "tableCard": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCard", + "description": "Table card for Actions on Google." + }, + "telephonyPlayAudio": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio", + "description": "Plays audio from a file in Telephony Gateway." + }, + "telephonySynthesizeSpeech": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech", + "description": "Synthesizes speech in Telephony Gateway." + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall", + "description": "Transfers the call in Telephony Gateway." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageBasicCard": { + "description": "The basic card message. Useful for displaying information.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard", + "properties": { + "buttons": { + "description": "Optional. The collection of card buttons.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton" + }, + "type": "array" + }, + "formattedText": { + "description": "Required, unless image is present. The body text of the card.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Optional. The image for the card." + }, + "subtitle": { + "description": "Optional. The subtitle of the card.", + "type": "string" + }, + "title": { + "description": "Optional. The title of the card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton": { + "description": "The button object that appears at the bottom of a card.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton", + "properties": { + "openUriAction": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction", + "description": "Required. Action to take when a user taps on the button." + }, + "title": { + "description": "Required. The title of the button.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": { + "description": "Opens the given URI.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction", + "properties": { + "uri": { + "description": "Required. The HTTP or HTTPS scheme URI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard": { + "description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel", + "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard", + "properties": { + "imageDisplayOptions": { + "description": "Optional. Settings for displaying the image. Applies to every image in items.", + "enum": [ + "IMAGE_DISPLAY_OPTIONS_UNSPECIFIED", + "GRAY", + "WHITE", + "CROPPED", + "BLURRED_BACKGROUND" + ], + "enumDescriptions": [ + "Fill the gaps between the image and the image container with gray bars.", + "Fill the gaps between the image and the image container with gray bars.", + "Fill the gaps between the image and the image container with white bars.", + "Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.", + "Pad the gaps between image and image frame with a blurred copy of the same image." + ], + "type": "string" + }, + "items": { + "description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem": { + "description": "Browsing carousel tile", + "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem", + "properties": { + "description": { + "description": "Optional. Description of the carousel item. Maximum of four lines of text.", + "type": "string" + }, + "footer": { + "description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Optional. Hero image for the carousel item." + }, + "openUriAction": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", + "description": "Required. Action to present to the user." + }, + "title": { + "description": "Required. Title of the carousel item. Maximum of two lines of text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": { + "description": "Actions on Google action to open a given url.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", + "properties": { + "url": { + "description": "Required. URL", + "type": "string" + }, + "urlTypeHint": { + "description": "Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.", + "enum": [ + "URL_TYPE_HINT_UNSPECIFIED", + "AMP_ACTION", + "AMP_CONTENT" + ], + "enumDescriptions": [ + "Unspecified", + "Url would be an amp action", + "URL that points directly to AMP content, or to a canonical URL which refers to AMP content via ." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageCard": { + "description": "The card response message.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageCard", + "properties": { + "buttons": { + "description": "Optional. The collection of card buttons.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCardButton" + }, + "type": "array" + }, + "imageUri": { + "description": "Optional. The public URI to an image file for the card.", + "type": "string" + }, + "subtitle": { + "description": "Optional. The subtitle of the card.", + "type": "string" + }, + "title": { + "description": "Optional. The title of the card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageCardButton": { + "description": "Optional. Contains information about a button.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageCardButton", + "properties": { + "postback": { + "description": "Optional. The text to send back to the Dialogflow API or a URI to open.", + "type": "string" + }, + "text": { + "description": "Optional. The text to show on the button.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect": { + "description": "The card for presenting a carousel of options to select from.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect", + "properties": { + "items": { + "description": "Required. Carousel items.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": { + "description": "An item in the carousel.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem", + "properties": { + "description": { + "description": "Optional. The body text of the card.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Optional. The image to display." + }, + "info": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo", + "description": "Required. Additional info about the option item." + }, + "title": { + "description": "Required. Title of the carousel item.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties": { + "description": "Column properties for TableCard.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties", + "properties": { + "header": { + "description": "Required. Column heading.", + "type": "string" + }, + "horizontalAlignment": { + "description": "Optional. Defines text alignment for all cells in this column.", + "enum": [ + "HORIZONTAL_ALIGNMENT_UNSPECIFIED", + "LEADING", + "CENTER", + "TRAILING" + ], + "enumDescriptions": [ + "Text is aligned to the leading edge of the column.", + "Text is aligned to the leading edge of the column.", + "Text is centered in the column.", + "Text is aligned to the trailing edge of the column." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageImage": { + "description": "The image response message.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "properties": { + "accessibilityText": { + "description": "A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.", + "type": "string" + }, + "imageUri": { + "description": "Optional. The public URI to an image file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion": { + "description": "The suggestion chip message that allows the user to jump out to the app or website associated with this agent.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion", + "properties": { + "destinationName": { + "description": "Required. The name of the app or site this chip is linking to.", + "type": "string" + }, + "uri": { + "description": "Required. The URI of the app or site to open when the user taps the suggestion chip.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageListSelect": { + "description": "The card for presenting a list of options to select from.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageListSelect", + "properties": { + "items": { + "description": "Required. List items.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem" + }, + "type": "array" + }, + "subtitle": { + "description": "Optional. Subtitle of the list.", + "type": "string" + }, + "title": { + "description": "Optional. The overall title of the list.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": { + "description": "An item in the list.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem", + "properties": { + "description": { + "description": "Optional. The main text describing the item.", + "type": "string" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Optional. The image to display." + }, + "info": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo", + "description": "Required. Additional information about this option." + }, + "title": { + "description": "Required. The title of the list item.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageMediaContent": { + "description": "The media content card for Actions on Google.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent", + "properties": { + "mediaObjects": { + "description": "Required. List of media objects.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject" + }, + "type": "array" + }, + "mediaType": { + "description": "Optional. What type of media is the content (ie \"audio\").", + "enum": [ + "RESPONSE_MEDIA_TYPE_UNSPECIFIED", + "AUDIO" + ], + "enumDescriptions": [ + "Unspecified.", + "Response media type is audio." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject": { + "description": "Response media object for media content card.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject", + "properties": { + "contentUrl": { + "description": "Required. Url where the media is stored.", + "type": "string" + }, + "description": { + "description": "Optional. Description of media card.", + "type": "string" + }, + "icon": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Optional. Icon to display above media content." + }, + "largeImage": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Optional. Image to display above media content." + }, + "name": { + "description": "Required. Name of media card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies": { + "description": "The quick replies response message.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies", + "properties": { + "quickReplies": { + "description": "Optional. The collection of quick replies.", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Optional. The title of the collection of quick replies.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent": { + "description": "Rich Business Messaging (RBM) Card content", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent", + "properties": { + "description": { + "description": "Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.", + "type": "string" + }, + "media": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia", + "description": "Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card." + }, + "suggestions": { + "description": "Optional. List of suggestions to include in the card.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion" + }, + "type": "array" + }, + "title": { + "description": "Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia": { + "description": "Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia", + "properties": { + "fileUri": { + "description": "Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.", + "type": "string" + }, + "height": { + "description": "Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.", + "enum": [ + "HEIGHT_UNSPECIFIED", + "SHORT", + "MEDIUM", + "TALL" + ], + "enumDescriptions": [ + "Not specified.", + "112 DP.", + "168 DP.", + "264 DP. Not available for rich card carousels when the card width is set to small." + ], + "type": "string" + }, + "thumbnailUri": { + "description": "Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard": { + "description": "Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard", + "properties": { + "cardContents": { + "description": "Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent" + }, + "type": "array" + }, + "cardWidth": { + "description": "Required. The width of the cards in the carousel.", + "enum": [ + "CARD_WIDTH_UNSPECIFIED", + "SMALL", + "MEDIUM" + ], + "enumDescriptions": [ + "Not specified.", + "120 DP. Note that tall media cannot be used.", + "232 DP." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard": { + "description": "Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard", + "properties": { + "cardContent": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent", + "description": "Required. Card content." + }, + "cardOrientation": { + "description": "Required. Orientation of the card.", + "enum": [ + "CARD_ORIENTATION_UNSPECIFIED", + "HORIZONTAL", + "VERTICAL" + ], + "enumDescriptions": [ + "Not specified.", + "Horizontal layout.", + "Vertical layout." + ], + "type": "string" + }, + "thumbnailImageAlignment": { + "description": "Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.", + "enum": [ + "THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED", + "LEFT", + "RIGHT" + ], + "enumDescriptions": [ + "Not specified.", + "Thumbnail preview is left-aligned.", + "Thumbnail preview is right-aligned." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction": { + "description": "Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction", + "properties": { + "dial": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial", + "description": "Suggested client side action: Dial a phone number" + }, + "openUrl": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri", + "description": "Suggested client side action: Open a URI on device" + }, + "postbackData": { + "description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.", + "type": "string" + }, + "shareLocation": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation", + "description": "Suggested client side action: Share user location" + }, + "text": { + "description": "Text to display alongside the action.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial": { + "description": "Opens the user's default dialer app with the specified phone number but does not dial automatically.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial", + "properties": { + "phoneNumber": { + "description": "Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri": { + "description": "Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri", + "properties": { + "uri": { + "description": "Required. The uri to open on the user device", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation": { + "description": "Opens the device's location chooser so the user can pick a location to send back to the agent.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply": { + "description": "Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply", + "properties": { + "postbackData": { + "description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.", + "type": "string" + }, + "text": { + "description": "Suggested reply text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion": { + "description": "Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion", + "properties": { + "action": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction", + "description": "Predefined client side actions that user can choose" + }, + "reply": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply", + "description": "Predefined replies for user to select instead of typing" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageRbmText": { + "description": "Rich Business Messaging (RBM) text response with suggestions.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmText", + "properties": { + "rbmSuggestion": { + "description": "Optional. One or more suggestions to show to the user.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion" + }, + "type": "array" + }, + "text": { + "description": "Required. Text sent and displayed to the user.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": { + "description": "Additional info about the select item for when it is triggered in a dialog.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo", + "properties": { + "key": { + "description": "Required. A unique key that will be sent back to the agent if this response is given.", + "type": "string" + }, + "synonyms": { + "description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": { + "description": "The simple response message containing speech or text.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse", + "properties": { + "displayText": { + "description": "Optional. The text to display.", + "type": "string" + }, + "ssml": { + "description": "One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.", + "type": "string" + }, + "textToSpeech": { + "description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses": { + "description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses", + "properties": { + "simpleResponses": { + "description": "Required. The list of simple responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageSuggestion": { + "description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion", + "properties": { + "title": { + "description": "Required. The text shown the in the suggestion chip.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageSuggestions": { + "description": "The collection of suggestions.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions", + "properties": { + "suggestions": { + "description": "Required. The list of suggested replies.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageTableCard": { + "description": "Table card for Actions on Google.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCard", + "properties": { + "buttons": { + "description": "Optional. List of buttons for the card.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton" + }, + "type": "array" + }, + "columnProperties": { + "description": "Optional. Display properties for the columns in this table.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties" + }, + "type": "array" + }, + "image": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", + "description": "Optional. Image which should be displayed on the card." + }, + "rows": { + "description": "Optional. Rows in this table of data.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow" + }, + "type": "array" + }, + "subtitle": { + "description": "Optional. Subtitle to the title.", + "type": "string" + }, + "title": { + "description": "Required. Title of the card.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell": { + "description": "Cell of TableCardRow.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell", + "properties": { + "text": { + "description": "Required. Text in this cell.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow": { + "description": "Row of TableCard.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow", + "properties": { + "cells": { + "description": "Optional. List of cells that make up this row.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell" + }, + "type": "array" + }, + "dividerAfter": { + "description": "Optional. Whether to add a visual divider after this row.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio": { + "description": "Plays audio from a file in Telephony Gateway.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio", + "properties": { + "audioUri": { + "description": "Required. URI to a Google Cloud Storage object containing the audio to play, e.g., \"gs://bucket/object\". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech": { + "description": "Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech", + "properties": { + "ssml": { + "description": "The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).", + "type": "string" + }, + "text": { + "description": "The raw text to be synthesized.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall": { + "description": "Transfers the call in Telephony Gateway.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall", + "properties": { + "phoneNumber": { + "description": "Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1IntentMessageText", + "properties": { + "text": { + "description": "Optional. The collection of the agent's responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentParameter": { + "description": "Represents intent parameters.", + "id": "GoogleCloudDialogflowV2beta1IntentParameter", + "properties": { + "defaultValue": { + "description": "Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.", + "type": "string" + }, + "displayName": { + "description": "Required. The name of the parameter.", + "type": "string" + }, + "entityTypeDisplayName": { + "description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.", + "type": "string" + }, + "isList": { + "description": "Optional. Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "mandatory": { + "description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.", + "type": "boolean" + }, + "name": { + "description": "The unique identifier of this parameter.", + "type": "string" + }, + "prompts": { + "description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.", + "items": { + "type": "string" + }, + "type": "array" + }, + "value": { + "description": "Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": { + "description": "Represents an example that the agent is trained on.", + "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase", + "properties": { + "name": { + "description": "Output only. The unique identifier of this training phrase.", + "type": "string" + }, + "parts": { + "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart" + }, + "type": "array" + }, + "timesAddedCount": { + "description": "Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Required. The type of the training phrase.", + "enum": [ + "TYPE_UNSPECIFIED", + "EXAMPLE", + "TEMPLATE" + ], + "enumDescriptions": [ + "Not specified. This value should never be used.", + "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", + "Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart": { + "description": "Represents a part of a training phrase.", + "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart", + "properties": { + "alias": { + "description": "Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "entityType": { + "description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.", + "type": "string" + }, + "text": { + "description": "Required. The text for this part.", + "type": "string" + }, + "userDefined": { + "description": "Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAnswers": { + "description": "Represents the result of querying a Knowledge base.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAnswers", + "properties": { + "answers": { + "description": "A list of answers from Knowledge Connector.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer": { + "description": "An answer from Knowledge Connector.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer", + "properties": { + "answer": { + "description": "The piece of text from the `source` knowledge base document that answers this conversational query.", + "type": "string" + }, + "faqQuestion": { + "description": "The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.", + "type": "string" + }, + "matchConfidence": { + "description": "The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using `match_confidence_level` which should be generally more stable.", + "format": "float", + "type": "number" + }, + "matchConfidenceLevel": { + "description": "The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.", + "enum": [ + "MATCH_CONFIDENCE_LEVEL_UNSPECIFIED", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Not specified.", + "Indicates that the confidence is low.", + "Indicates our confidence is medium.", + "Indicates our confidence is high." + ], + "type": "string" + }, + "source": { + "description": "Indicates which Knowledge Document this answer was extracted from. Format: `projects//knowledgeBases//documents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { + "description": "Metadata in google::longrunning::Operation for Knowledge operations.", + "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", + "properties": { + "state": { + "description": "Required. Output only. The current state of this operation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": { + "description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.", + "id": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest", + "properties": { + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.", + "type": "object" + }, + "source": { + "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.", + "type": "string" + }, + "version": { + "description": "Optional. The version of the protocol used for this request. This field is AoG-specific.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1QueryResult": { + "description": "Represents the result of conversational query or event processing.", + "id": "GoogleCloudDialogflowV2beta1QueryResult", + "properties": { + "action": { + "description": "The action name from the matched intent.", + "type": "string" + }, + "allRequiredParamsPresent": { + "description": "This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.", + "type": "boolean" + }, + "diagnosticInfo": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors", + "type": "object" + }, + "fulfillmentMessages": { + "description": "The collection of rich messages to present to the user.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" + }, + "type": "array" + }, + "fulfillmentText": { + "description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.", + "type": "string" + }, + "intent": { + "$ref": "GoogleCloudDialogflowV2beta1Intent", + "description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`." + }, + "intentDetectionConfidence": { + "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.", + "format": "float", + "type": "number" + }, + "knowledgeAnswers": { + "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswers", + "description": "The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`." + }, + "languageCode": { + "description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "type": "string" + }, + "outputContexts": { + "description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1Context" + }, + "type": "array" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", + "type": "object" + }, + "queryText": { + "description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.", + "type": "string" + }, + "sentimentAnalysisResult": { + "$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult", + "description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request." + }, + "speechRecognitionConfidence": { + "description": "The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.", + "format": "float", + "type": "number" + }, + "webhookPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.", + "type": "object" + }, + "webhookSource": { + "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1Sentiment": { + "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.", + "id": "GoogleCloudDialogflowV2beta1Sentiment", + "properties": { + "magnitude": { + "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", + "format": "float", + "type": "number" + }, + "score": { + "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SentimentAnalysisResult": { + "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config", + "id": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult", + "properties": { + "queryTextSentiment": { + "$ref": "GoogleCloudDialogflowV2beta1Sentiment", + "description": "The sentiment analysis result for `query_text`." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1SessionEntityType": { + "description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).", + "id": "GoogleCloudDialogflowV2beta1SessionEntityType", + "properties": { + "entities": { + "description": "Required. The collection of entities associated with this session entity type.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" + }, + "type": "array" + }, + "entityOverrideMode": { + "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", + "enum": [ + "ENTITY_OVERRIDE_MODE_UNSPECIFIED", + "ENTITY_OVERRIDE_MODE_OVERRIDE", + "ENTITY_OVERRIDE_MODE_SUPPLEMENT" + ], + "enumDescriptions": [ + "Not specified. This value should be never used.", + "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", + "The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge." + ], + "type": "string" + }, + "name": { + "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1WebhookRequest": { + "description": "The request message for a webhook call.", + "id": "GoogleCloudDialogflowV2beta1WebhookRequest", + "properties": { + "alternativeQueryResults": { + "description": "Alternative query results from KnowledgeService.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1QueryResult" + }, + "type": "array" + }, + "originalDetectIntentRequest": { + "$ref": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest", + "description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call." + }, + "queryResult": { + "$ref": "GoogleCloudDialogflowV2beta1QueryResult", + "description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`." + }, + "responseId": { + "description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.", + "type": "string" + }, + "session": { + "description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`,", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1WebhookResponse": { + "description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).", + "id": "GoogleCloudDialogflowV2beta1WebhookResponse", + "properties": { + "endInteraction": { + "description": "Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.", + "type": "boolean" + }, + "followupEventInput": { + "$ref": "GoogleCloudDialogflowV2beta1EventInput", + "description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields." + }, + "fulfillmentMessages": { + "description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" + }, + "type": "array" + }, + "fulfillmentText": { + "description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.", + "type": "string" + }, + "outputContexts": { + "description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1Context" + }, + "type": "array" + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", + "type": "object" + }, + "sessionEntityTypes": { + "description": "Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" + }, + "type": "array" + }, + "source": { + "description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": { + "description": "Metadata for CreateDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": { + "description": "Metadata for DeleteDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": { + "description": "Metadata in google::longrunning::Operation for Knowledge operations.", + "id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "properties": { + "state": { + "description": "Required. Output only. The current state of this operation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "State unspecified.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": { + "description": "Metadata for ImportDocuments operation.", + "id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": { + "description": "Response message for Documents.ImportDocuments.", + "id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse", + "properties": { + "warnings": { + "description": "Includes details about skipped documents or any other warnings.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": { + "description": "Metadata for ReloadDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": { + "description": "Metadata for UpdateDocument operation.", + "id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", + "description": "The generic information of the operation." + } + }, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleTypeLatLng": { + "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", + "id": "GoogleTypeLatLng", + "properties": { + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "format": "double", + "type": "number" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Dialogflow API", + "version": "v3", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/digitalassetlinks__v1.json b/discovery/googleapis/digitalassetlinks__v1.json index d493203..25502c6 100644 --- a/discovery/googleapis/digitalassetlinks__v1.json +++ b/discovery/googleapis/digitalassetlinks__v1.json
@@ -181,7 +181,7 @@ } } }, - "revision": "20200929", + "revision": "20210125", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": {
diff --git a/discovery/googleapis/displayvideo__v1.json b/discovery/googleapis/displayvideo__v1.json index dfcb46c..6a0be42 100644 --- a/discovery/googleapis/displayvideo__v1.json +++ b/discovery/googleapis/displayvideo__v1.json
@@ -293,12 +293,12 @@ "parameterOrder": [], "parameters": { "filter": { - "description": "Allows filtering by advertiser properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `advertiserId` - `displayName` - `entityStatus` Examples: * All active advertisers under a partner: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` The length of this field should be no more than 500 characters.", + "description": "Allows filtering by advertiser properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. * Supported fields: - `advertiserId` - `displayName` - `entityStatus` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All active advertisers under a partner: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` * All advertisers with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<=\"2020-11-04T18:54:47Z\"` * All advertisers with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", "location": "query", "type": "string" }, @@ -526,12 +526,12 @@ "type": "string" }, "filter": { - "description": "Allows filtering by campaign properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `entityStatus` Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` The length of this field should be no more than 500 characters.", + "description": "Allows filtering by campaign properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `entityStatus` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All campaigns with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<=\"2020-11-04T18:54:47Z\"` * All campaigns with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", "location": "query", "type": "string" }, @@ -1276,12 +1276,12 @@ "type": "string" }, "filter": { - "description": "Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `budget.budget_segments.date_range.end_date` must be LESS THAN (<). * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `entityStatus` - `budget.budget_segments.date_range.end_date` (input as YYYY-MM-DD) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders whose budget segments' dates end before March 28, 2019: `budget.budget_segments.date_range.end_date<\"2019-03-28\"` The length of this field should be no more than 500 characters.", + "description": "Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `budget.budget_segments.date_range.end_date` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `entityStatus` - `budget.budget_segments.date_range.end_date` (input as YYYY-MM-DD) - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders whose budget segments' dates end before March 28, 2019: `budget.budget_segments.date_range.end_date<\"2019-03-28\"` * All insertion orders with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", "location": "query", "type": "string" }, @@ -1557,12 +1557,12 @@ "type": "string" }, "filter": { - "description": "Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items whose flight dates end before March 28, 2019: `flight.dateRange.endDate<\"2019-03-28\"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:\"NO_VALID_CREATIVE\"` The length of this field should be no more than 500 characters.", + "description": "Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator used on `flight.dateRange.endDate` must be LESS THAN (<). * The operator used on `updateTime` must be `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)`. * The operator used on `warningMessages` must be `HAS (:)`. * The operators used on all other fields must be `EQUALS (=)`. * Supported fields: - `campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - `lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as YYYY-MM-DD) - `warningMessages` - `flight.triggerId` - `updateTime` (input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) * The operator can be `NO LESS THAN (>=)` or `NO GREATER THAN (<=)`. - `updateTime` (format of ISO 8601) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items whose flight dates end before March 28, 2019: `flight.dateRange.endDate<\"2019-03-28\"` * All line items that have `NO_VALID_CREATIVE` in `warningMessages`: `warningMessages:\"NO_VALID_CREATIVE\"` * All line items with an update time less than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime<=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to `2020-11-04T18:54:47Z (format of ISO 8601)`: `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * “flight.dateRange.endDate” The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * “flight.dateRange.endDate” * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", "location": "query", "type": "string" }, @@ -2494,6 +2494,235 @@ } } }, + "manualTriggers": { + "methods": { + "activate": { + "description": "Activates a manual trigger. Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned.", + "httpMethod": "POST", + "id": "displayvideo.advertisers.manualTriggers.activate", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the manual trigger belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Required. The ID of the manual trigger to activate.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate", + "request": { + "$ref": "ActivateManualTriggerRequest" + }, + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a new manual trigger. Returns the newly created manual trigger if successful.", + "httpMethod": "POST", + "id": "displayvideo.advertisers.manualTriggers.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/manualTriggers", + "request": { + "$ref": "ManualTrigger" + }, + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "deactivate": { + "description": "Deactivates a manual trigger.", + "httpMethod": "POST", + "id": "displayvideo.advertisers.manualTriggers.deactivate", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the manual trigger belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Required. The ID of the manual trigger to deactivate.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate", + "request": { + "$ref": "DeactivateManualTriggerRequest" + }, + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a manual trigger.", + "httpMethod": "GET", + "id": "displayvideo.advertisers.manualTriggers.get", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this manual trigger belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Required. The ID of the manual trigger to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}", + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists manual triggers that are accessible to the current user for a given advertiser ID. The order is defined by the order_by parameter. A single advertiser_id is required.", + "httpMethod": "GET", + "id": "displayvideo.advertisers.manualTriggers.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the fetched manual triggers belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by manual trigger properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `displayName` - `state` Examples: * All active manual triggers under an advertiser: `state=\"ACTIVE\"` The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `state` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListManualTriggers` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/manualTriggers", + "response": { + "$ref": "ListManualTriggersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a manual trigger. Returns the updated manual trigger if successful.", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.manualTriggers.patch", + "parameterOrder": [ + "advertiserId", + "triggerId" + ], + "parameters": { + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Output only. The unique ID of the manual trigger.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}", + "request": { + "$ref": "ManualTrigger" + }, + "response": { + "$ref": "ManualTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, "negativeKeywordLists": { "methods": { "create": { @@ -2868,7 +3097,7 @@ "type": "string" }, "targetingType": { - "description": "Required. Identifies the type of this assigned targeting option.", + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -2992,7 +3221,7 @@ "type": "string" }, "targetingType": { - "description": "Required. Identifies the type of this assigned targeting option.", + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -3113,7 +3342,7 @@ "type": "string" }, "targetingType": { - "description": "Required. Identifies the type of this assigned targeting option.", + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -3247,7 +3476,7 @@ "type": "string" }, "targetingType": { - "description": "Required. Identifies the type of assigned targeting options to list.", + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -5501,7 +5730,7 @@ "type": "string" }, "filter": { - "description": "Allows filtering by targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The operator must be \"=\" (equal sign). * Supported fields: - `carrier_and_isp_details.type` - `geo_region_details.geo_region_type` - `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geo_region_details.geo_region_type=\"GEO_REGION_TYPE_COUNTRY\" OR geo_region_details.geo_region_type=\"GEO_REGION_TYPE_STATE\"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrier_and_isp_details.type=\"CARRIER_AND_ISP_TYPE_CARRIER\"`. The length of this field should be no more than 500 characters.", + "description": "Allows filtering by targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The operator must be \"=\" (equal sign). * Supported fields: - `carrierAndIspDetails.type` - `geoRegionDetails.geoRegionType` - `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_COUNTRY\" OR geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_STATE\"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type=\"CARRIER_AND_ISP_TYPE_CARRIER\"`. The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -5616,6 +5845,113 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] + }, + "search": { + "description": "Searches for targeting options of a given type based on the given search terms.", + "httpMethod": "POST", + "id": "displayvideo.targetingTypes.targetingOptions.search", + "parameterOrder": [ + "targetingType" + ], + "parameters": { + "targetingType": { + "description": "Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/targetingTypes/{+targetingType}/targetingOptions:search", + "request": { + "$ref": "SearchTargetingOptionsRequest" + }, + "response": { + "$ref": "SearchTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] } } } @@ -5791,9 +6127,15 @@ } } }, - "revision": "20201008", + "revision": "20210202", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { + "ActivateManualTriggerRequest": { + "description": "Request message for ManualTriggerService.ActivateManualTrigger.", + "id": "ActivateManualTriggerRequest", + "properties": {}, + "type": "object" + }, "ActiveViewVideoViewabilityMetricConfig": { "description": "Configuration for custom Active View video viewability metrics.", "id": "ActiveViewVideoViewabilityMetricConfig", @@ -6028,7 +6370,7 @@ "properties": { "cmHybridConfig": { "$ref": "CmHybridConfig", - "description": "The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers." + "description": "The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers." }, "thirdPartyOnlyConfig": { "$ref": "ThirdPartyOnlyConfig", @@ -6055,7 +6397,7 @@ "type": "boolean" }, "videoCreativeDataSharingAuthorized": { - "description": "By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration.", + "description": "By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM360 hybrid ad server configuration.", "type": "boolean" } }, @@ -6085,7 +6427,7 @@ "type": "string" }, "timeZone": { - "description": "Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.", + "description": "Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.", "readOnly": true, "type": "string" } @@ -6874,14 +7216,14 @@ "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", "properties": { "createRequests": { - "description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`.", + "description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`", "items": { "$ref": "CreateAssignedTargetingOptionsRequest" }, "type": "array" }, "deleteRequests": { - "description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`.", + "description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`", "items": { "$ref": "DeleteAssignedTargetingOptionsRequest" }, @@ -7440,16 +7782,16 @@ "type": "object" }, "CmHybridConfig": { - "description": "Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers.", + "description": "Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers.", "id": "CmHybridConfig", "properties": { "cmAccountId": { - "description": "Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.", + "description": "Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.", "format": "int64", "type": "string" }, "cmFloodlightConfigId": { - "description": "Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.", + "description": "Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.", "format": "int64", "type": "string" }, @@ -7458,7 +7800,7 @@ "type": "boolean" }, "cmSyncableSiteIds": { - "description": "A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.", + "description": "A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.", "items": { "format": "int64", "type": "string" @@ -7466,32 +7808,32 @@ "type": "array" }, "dv360ToCmCostReportingEnabled": { - "description": "Whether or not to report DV360 cost to CM.", + "description": "Whether or not to report DV360 cost to CM360.", "type": "boolean" }, "dv360ToCmDataSharingEnabled": { - "description": "Whether or not to include DV360 data in CM data transfer reports.", + "description": "Whether or not to include DV360 data in CM360 data transfer reports.", "type": "boolean" } }, "type": "object" }, "CmTrackingAd": { - "description": "A Campaign Manager tracking ad.", + "description": "A Campaign Manager 360 tracking ad.", "id": "CmTrackingAd", "properties": { "cmAdId": { - "description": "The ad ID of the campaign manager tracking Ad.", + "description": "The ad ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmCreativeId": { - "description": "The creative ID of the campaign manager tracking Ad.", + "description": "The creative ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" }, "cmPlacementId": { - "description": "The placement ID of the campaign manager tracking Ad.", + "description": "The placement ID of the campaign manager 360 tracking Ad.", "format": "int64", "type": "string" } @@ -7849,7 +8191,8 @@ "SDF_VERSION_4_2", "SDF_VERSION_5", "SDF_VERSION_5_1", - "SDF_VERSION_5_2" + "SDF_VERSION_5_2", + "SDF_VERSION_5_3" ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", @@ -7859,7 +8202,8 @@ "SDF version 4.2", "SDF version 5.", "SDF version 5.1", - "SDF version 5.2;" + "SDF version 5.2", + "SDF version 5.3" ], "type": "string" } @@ -7895,14 +8239,14 @@ "type": "array" }, "cmPlacementId": { - "description": "Output only. The unique ID of the Campaign Manager placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.", + "description": "Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.", "format": "int64", "readOnly": true, "type": "string" }, "cmTrackingAd": { "$ref": "CmTrackingAd", - "description": "The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases." + "description": "The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases." }, "companionCreativeIds": { "description": "The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", @@ -8078,10 +8422,10 @@ ], "enumDescriptions": [ "Hosting source is not specified or is unknown in this version.", - "A creative synced from Campaign Manager. Create and update methods are **not** supported for this hosting type.", - "A creative hosted by a third-party ad server (3PAS). Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", - "A creative created in DV360 and hosted by Campaign Manager. Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", - "A rich media creative created in Studio and hosted by Campaign Manager. Create and update methods are **not** supported for this hosting type." + "A creative synced from Campaign Manager 360. Create and update methods are **not** supported for this hosting type.", + "A creative hosted by a third-party ad server (3PAS). Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", + "A creative created in DV360 and hosted by Campaign Manager 360. Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", + "A rich media creative created in Studio and hosted by Campaign Manager 360. Create and update methods are **not** supported for this hosting type." ], "type": "string" }, @@ -8143,7 +8487,7 @@ "type": "boolean" }, "requirePingForAttribution": { - "description": "Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`", + "description": "Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", "type": "boolean" }, "reviewStatus": { @@ -8203,7 +8547,7 @@ "type": "string" }, "vastTagUrl": { - "description": "Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`", + "description": "Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", "type": "string" }, "vpaid": { @@ -8383,21 +8727,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -8474,6 +8818,12 @@ }, "type": "object" }, + "DeactivateManualTriggerRequest": { + "description": "Request message for ManualTriggerService.DeactivateManualTrigger.", + "id": "DeactivateManualTriggerRequest", + "properties": {}, + "type": "object" + }, "DeleteAssignedTargetingOptionsRequest": { "description": "A request listing which assigned targeting options of a given targeting type should be deleted.", "id": "DeleteAssignedTargetingOptionsRequest", @@ -8774,6 +9124,11 @@ "$ref": "DoubleVerifyBrandSafetyCategories", "description": "DV Brand Safety Controls." }, + "customSegmentId": { + "description": "The custom segment ID provided by DoubleVerify. The ID must start with \"51\" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic", + "format": "int64", + "type": "string" + }, "displayViewability": { "$ref": "DoubleVerifyDisplayViewability", "description": "Display viewability settings (applicable to display line items only)." @@ -9226,8 +9581,11 @@ "EXCHANGE_INMOBI", "EXCHANGE_SMAATO", "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", "EXCHANGE_NEXSTAR_DIGITAL", - "EXCHANGE_WAZE" + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -9280,16 +9638,19 @@ "United.", "Yieldlab.", "Yieldmo.", - "UnrulyX", - "Open8", + "UnrulyX.", + "Open8.", "Triton.", - "TripleLift", - "Taboola", + "TripleLift.", + "Taboola.", "InMobi.", - "Smaato", + "Smaato.", "Aja.", + "Supership.", "Nexstar Digital.", - "Waze." + "Waze.", + "SoundCast.", + "Sharethrough." ], "type": "string" }, @@ -9376,8 +9737,11 @@ "EXCHANGE_INMOBI", "EXCHANGE_SMAATO", "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", "EXCHANGE_NEXSTAR_DIGITAL", - "EXCHANGE_WAZE" + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -9430,16 +9794,19 @@ "United.", "Yieldlab.", "Yieldmo.", - "UnrulyX", - "Open8", + "UnrulyX.", + "Open8.", "Triton.", - "TripleLift", - "Taboola", + "TripleLift.", + "Taboola.", "InMobi.", - "Smaato", + "Smaato.", "Aja.", + "Supership.", "Nexstar Digital.", - "Waze." + "Waze.", + "SoundCast.", + "Sharethrough." ], "type": "string" }, @@ -9527,8 +9894,11 @@ "EXCHANGE_INMOBI", "EXCHANGE_SMAATO", "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", "EXCHANGE_NEXSTAR_DIGITAL", - "EXCHANGE_WAZE" + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -9581,16 +9951,19 @@ "United.", "Yieldlab.", "Yieldmo.", - "UnrulyX", - "Open8", + "UnrulyX.", + "Open8.", "Triton.", - "TripleLift", - "Taboola", + "TripleLift.", + "Taboola.", "InMobi.", - "Smaato", + "Smaato.", "Aja.", + "Supership.", "Nexstar Digital.", - "Waze." + "Waze.", + "SoundCast.", + "Sharethrough." ], "readOnly": true, "type": "string" @@ -9655,7 +10028,7 @@ "enumDescriptions": [ "Default value when audience source is not specified or is unknown.", "Originated from Display & Video 360.", - "Originated from Campaign Manager.", + "Originated from Campaign Manager 360.", "Originated from Google Ad Manager.", "Originated from Search Ads 360.", "Originated from Youtube.", @@ -10109,6 +10482,17 @@ }, "type": "object" }, + "GeoRegionSearchTerms": { + "description": "Search terms for geo region targeting options.", + "id": "GeoRegionSearchTerms", + "properties": { + "geoRegionQuery": { + "description": "The search query for the desired geo region. The query can be a prefix, e.g. \"New Yor\", \"Seattle\", \"USA\", etc.", + "type": "string" + } + }, + "type": "object" + }, "GeoRegionTargetingOptionDetails": { "description": "Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`.", "id": "GeoRegionTargetingOptionDetails", @@ -10210,14 +10594,18 @@ "GOOGLE_AUDIENCE_TYPE_AFFINITY", "GOOGLE_AUDIENCE_TYPE_IN_MARKET", "GOOGLE_AUDIENCE_TYPE_INSTALLED_APPS", - "GOOGLE_AUDIENCE_TYPE_NEW_MOBILE_DEVICES" + "GOOGLE_AUDIENCE_TYPE_NEW_MOBILE_DEVICES", + "GOOGLE_AUDIENCE_TYPE_LIFE_EVENT", + "GOOGLE_AUDIENCE_TYPE_EXTENDED_DEMOGRAPHIC" ], "enumDescriptions": [ "Default value when type is not specified or is unknown.", "Affinity type Google audience.", "In-Market type Google audience.", - "Installed-apps type Google audience.", - "New-mobile-devices type Google audience." + "Installed-Apps type Google audience.", + "New-Mobile-Devices type Google audience.", + "Life-Event type Google audience.", + "Extended-Demographic type Google audience." ], "readOnly": true, "type": "string" @@ -10402,7 +10790,7 @@ }, "bidStrategy": { "$ref": "BiddingStrategy", - "description": "Optional. The bidding strategy of the insertion order. By default, fixed_bid is set." + "description": "The bidding strategy of the insertion order. By default, fixed_bid is set." }, "budget": { "$ref": "InsertionOrderBudget", @@ -10447,6 +10835,20 @@ "readOnly": true, "type": "string" }, + "insertionOrderType": { + "description": "The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`.", + "enum": [ + "INSERTION_ORDER_TYPE_UNSPECIFIED", + "RTB", + "OVER_THE_TOP" + ], + "enumDescriptions": [ + "Insertion order type is not specified or is unknown.", + "Real-time bidding.", + "Over-the-top." + ], + "type": "string" + }, "integrationDetails": { "$ref": "IntegrationDetails", "description": "Additional integration details of the insertion order." @@ -10553,6 +10955,14 @@ "description": "Details of Integral Ad Science settings.", "id": "IntegralAdScience", "properties": { + "customSegmentId": { + "description": "The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, "displayViewability": { "description": "Display Viewability section (applicable to display line items only).", "enum": [ @@ -10869,8 +11279,11 @@ "EXCHANGE_INMOBI", "EXCHANGE_SMAATO", "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", "EXCHANGE_NEXSTAR_DIGITAL", - "EXCHANGE_WAZE" + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -10923,16 +11336,19 @@ "United.", "Yieldlab.", "Yieldmo.", - "UnrulyX", - "Open8", + "UnrulyX.", + "Open8.", "Triton.", - "TripleLift", - "Taboola", + "TripleLift.", + "Taboola.", "InMobi.", - "Smaato", + "Smaato.", "Aja.", + "Supership.", "Nexstar Digital.", - "Waze." + "Waze.", + "SoundCast.", + "Sharethrough." ], "type": "string" }, @@ -11290,7 +11706,8 @@ "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL", "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY", "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY", - "LINE_ITEM_TYPE_AUDIO_DEFAULT" + "LINE_ITEM_TYPE_AUDIO_DEFAULT", + "LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP" ], "enumDescriptions": [ "Type value is not specified or is unknown in this version.", @@ -11300,10 +11717,15 @@ "Video ads that drive installs of an app.", "Display ads served on mobile app inventory.", "Video ads served on mobile app inventory.", - "Rtb Audio ads sold for a variety of environments." + "RTB Audio ads sold for a variety of environments.", + "Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`." ], "type": "string" }, + "mobileApp": { + "$ref": "MobileApp", + "description": "The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`." + }, "name": { "description": "Output only. The resource name of the line item.", "readOnly": true, @@ -11324,6 +11746,10 @@ "$ref": "PartnerRevenueModel", "description": "Required. The partner revenue model setting of the line item." }, + "targetingExpansion": { + "$ref": "TargetingExpansionConfig", + "description": "The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the line item. This config is only applicable when eligible audience list targeting is assigned to the line item." + }, "updateTime": { "description": "Output only. The timestamp when the line item was last updated. Assigned by the system.", "format": "google-datetime", @@ -11350,7 +11776,8 @@ "TARGETING_REVOKED_OR_CLOSED_USER_LIST", "APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY", "CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS", - "NO_CREATIVE_FOR_TARGETED_DEALS" + "NO_CREATIVE_FOR_TARGETED_DEALS", + "TARGETING_DEPRECATED_GEO_TARGET" ], "enumDescriptions": [ "Not specified or is unknown.", @@ -11369,7 +11796,8 @@ "This line item targets one or more user lists that are no longer available. In the future, this will prevent the line item from serving, so consider removing these lists from your targeting.", "This app install line item does not have an optimal bidding strategy.", "Deals targeted by this line item accept creative sizes which are not in use. This may limit the line item's delivery or performance.", - "This line item does not contain any creative for the targeted deals." + "This line item does not contain any creative for the targeted deals.", + "This line item targets a geo target that is deprecated." ], "type": "string" }, @@ -11435,14 +11863,21 @@ "enum": [ "LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED", "LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED", - "LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM" + "LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM", + "LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER" ], "enumDescriptions": [ "Type value is not specified or is unknown in this version.", "The line item's flight dates are inherited from its parent insertion order.", - "The line item uses its own custom flight dates." + "The line item uses its own custom flight dates.", + "The line item uses a trigger." ], "type": "string" + }, + "triggerId": { + "description": "The ID of the manual trigger associated with the line item. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER`. Must not be set otherwise. * When set, the line item's flight dates are inherited from its parent insertion order. * Active line items will spend when the selected trigger is activated within the parent insertion order's flight dates.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -11758,6 +12193,23 @@ }, "type": "object" }, + "ListManualTriggersResponse": { + "id": "ListManualTriggersResponse", + "properties": { + "manualTriggers": { + "description": "The list of manual triggers. This list will be absent if empty.", + "items": { + "$ref": "ManualTrigger" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListManualTriggers` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, "ListNegativeKeywordListsResponse": { "description": "Response message for NegativeKeywordListService.ListNegativeKeywordLists.", "id": "ListNegativeKeywordListsResponse", @@ -11939,6 +12391,59 @@ }, "type": "object" }, + "ManualTrigger": { + "description": "A single manual trigger in Display & Video 360.", + "id": "ManualTrigger", + "properties": { + "activationDurationMinutes": { + "description": "Required. The maximum duration of each activation in minutes. Must be between 1 and 360 inclusive. After this duration, the trigger will be automatically deactivated.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser that the manual trigger belongs to.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the manual trigger. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "latestActivationTime": { + "description": "Output only. The timestamp of the trigger's latest activation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the manual trigger.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the manual trigger. Will be set to the `INACTIVE` state upon creation.", + "enum": [ + "STATE_UNSPECIFIED", + "INACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "Default value when state is not specified or is unknown in this version.", + "The trigger is currently inactive and ready to be activated.", + "The trigger is currently active (activated)." + ], + "readOnly": true, + "type": "string" + }, + "triggerId": { + "description": "Output only. The unique ID of the manual trigger.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "MaximizeSpendBidStrategy": { "description": "A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget.", "id": "MaximizeSpendBidStrategy", @@ -11985,22 +12490,58 @@ "id": "MeasurementConfig", "properties": { "dv360ToCmCostReportingEnabled": { - "description": "Whether or not to report DV360 cost to CM.", + "description": "Whether or not to report DV360 cost to CM360.", "type": "boolean" }, "dv360ToCmDataSharingEnabled": { - "description": "Whether or not to include DV360 data in CM data transfer reports.", + "description": "Whether or not to include DV360 data in CM360 data transfer reports.", "type": "boolean" } }, "type": "object" }, + "MobileApp": { + "description": "A mobile app promoted by a mobile app install line item.", + "id": "MobileApp", + "properties": { + "appId": { + "description": "Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.", + "type": "string" + }, + "displayName": { + "description": "Output only. The app name.", + "readOnly": true, + "type": "string" + }, + "platform": { + "description": "Output only. The app platform.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "IOS", + "ANDROID" + ], + "enumDescriptions": [ + "Platform is not specified.", + "iOS platform.", + "Android platform." + ], + "readOnly": true, + "type": "string" + }, + "publisher": { + "description": "Output only. The app publisher.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Money": { "description": "Represents an amount of money with its currency type.", "id": "Money", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { @@ -12940,7 +13481,8 @@ "SDF_VERSION_4_2", "SDF_VERSION_5", "SDF_VERSION_5_1", - "SDF_VERSION_5_2" + "SDF_VERSION_5_2", + "SDF_VERSION_5_3" ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", @@ -12950,7 +13492,8 @@ "SDF version 4.2", "SDF version 5.", "SDF version 5.1", - "SDF version 5.2;" + "SDF version 5.2", + "SDF version 5.3" ], "type": "string" } @@ -12992,7 +13535,8 @@ "SDF_VERSION_4_2", "SDF_VERSION_5", "SDF_VERSION_5_1", - "SDF_VERSION_5_2" + "SDF_VERSION_5_2", + "SDF_VERSION_5_3" ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", @@ -13002,13 +13546,57 @@ "SDF version 4.2", "SDF version 5.", "SDF version 5.1", - "SDF version 5.2;" + "SDF version 5.2", + "SDF version 5.3" ], "type": "string" } }, "type": "object" }, + "SearchTargetingOptionsRequest": { + "description": "Request message for SearchTargetingOptions.", + "id": "SearchTargetingOptionsRequest", + "properties": { + "advertiserId": { + "description": "Required. The Advertiser this request is being made in the context of.", + "format": "int64", + "type": "string" + }, + "geoRegionSearchTerms": { + "$ref": "GeoRegionSearchTerms", + "description": "Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`." + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.", + "type": "string" + } + }, + "type": "object" + }, + "SearchTargetingOptionsResponse": { + "description": "Response message for SearchTargetingOptionsResponse.", + "id": "SearchTargetingOptionsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results.", + "type": "string" + }, + "targetingOptions": { + "description": "The list of targeting options that match the search criteria. This list will be absent if empty.", + "items": { + "$ref": "TargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, "SensitiveCategoryAssignedTargetingOptionDetails": { "description": "Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", "id": "SensitiveCategoryAssignedTargetingOptionDetails", @@ -13183,6 +13771,39 @@ }, "type": "object" }, + "TargetingExpansionConfig": { + "description": "Settings that control the targeting expansion of the line item. Targeting expansion allows the line item to reach a larger audience based on the original audience list and the targeting expansion level.", + "id": "TargetingExpansionConfig", + "properties": { + "excludeFirstPartyAudience": { + "description": "Required. Whether to exclude first party audiences from targeting. Similar audiences of the excluded first party lists will not be excluded. Only applicable when a first-party audience is positively targeted (directly or included in a combined audience), otherwise this selection will be ignored.", + "type": "boolean" + }, + "targetingExpansionLevel": { + "description": "Required. Magnitude of expansion for applicable targeting under this line item.", + "enum": [ + "TARGETING_EXPANSION_LEVEL_UNSPECIFIED", + "NO_EXPANSION", + "LEAST_EXPANSION", + "SOME_EXPANSION", + "BALANCED_EXPANSION", + "MORE_EXPANSION", + "MOST_EXPANSION" + ], + "enumDescriptions": [ + "Targeting expansion level is not specified or is unknown in this version.", + "Targeting expansion off.", + "Conservative targeting expansion, lowest reach.", + "Moderately conservative targeting expansion, lower reach.", + "Moderate targeting expansion, medium reach.", + "Moderately aggressive targeting expansion, higher reach.", + "Aggressive targeting expansion, highest reach." + ], + "type": "string" + } + }, + "type": "object" + }, "TargetingOption": { "description": "Represents a single targeting option, which is a targetable concept in DV360.", "id": "TargetingOption", @@ -13592,7 +14213,7 @@ "Use Ad-ID to provide the Universal Ad ID.", "Use clearcast.co.uk to provide the Universal Ad ID.", "Use Display & Video 360 to provide the Universal Ad ID.", - "Use Campaign Manager to provide the Universal Ad ID." + "Use Campaign Manager 360 to provide the Universal Ad ID." ], "type": "string" }
diff --git a/discovery/googleapis/dlp__v2.json b/discovery/googleapis/dlp__v2.json index 9f27b0c..3b870c7 100644 --- a/discovery/googleapis/dlp__v2.json +++ b/discovery/googleapis/dlp__v2.json
@@ -646,6 +646,75 @@ } } }, + "dlpJobs": { + "methods": { + "list": { + "description": "Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.", + "httpMethod": "GET", + "id": "dlp.organizations.locations.dlpJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The resource name of the trigger that created job. - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to time the job finished. - 'start_time` - Corresponds to time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "locationId": { + "description": "Deprecated. This field has no effect.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to time the job was created. - `end_time`: corresponds to time the job ended. - `name`: corresponds to job's name. - `state`: corresponds to `state`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "type": { + "description": "The type of job. Defaults to `DlpJobType.INSPECT`", + "enum": [ + "DLP_JOB_TYPE_UNSPECIFIED", + "INSPECT_JOB", + "RISK_ANALYSIS_JOB" + ], + "enumDescriptions": [ + "Unused", + "The job inspected Google Cloud for sensitive data.", + "The job executed a Risk Analysis computation." + ], + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/dlpJobs", + "response": { + "$ref": "GooglePrivacyDlpV2ListDlpJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "inspectTemplates": { "methods": { "create": { @@ -797,6 +866,162 @@ } } }, + "jobTriggers": { + "methods": { + "create": { + "description": "Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "httpMethod": "POST", + "id": "dlp.organizations.locations.jobTriggers.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/jobTriggers", + "request": { + "$ref": "GooglePrivacyDlpV2CreateJobTriggerRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2JobTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "httpMethod": "DELETE", + "id": "dlp.organizations.locations.jobTriggers.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "httpMethod": "GET", + "id": "dlp.organizations.locations.jobTriggers.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GooglePrivacyDlpV2JobTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "httpMethod": "GET", + "id": "dlp.organizations.locations.jobTriggers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", + "location": "query", + "type": "string" + }, + "locationId": { + "description": "Deprecated. This field has no effect.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Size of the page, can be limited by a server.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/dlp/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/jobTriggers", + "response": { + "$ref": "GooglePrivacyDlpV2ListJobTriggersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.", + "httpMethod": "PATCH", + "id": "dlp.organizations.locations.jobTriggers.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the project and the triggeredJob, for example `projects/dlp-test-project/jobTriggers/53234423`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/jobTriggers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GooglePrivacyDlpV2UpdateJobTriggerRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2JobTrigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "storedInfoTypes": { "methods": { "create": { @@ -1807,7 +2032,7 @@ ], "parameters": { "filter": { - "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -2196,7 +2421,7 @@ ] }, "finish": { - "description": "Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.", + "description": "Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.finish", "parameterOrder": [ @@ -2247,7 +2472,7 @@ ] }, "hybridInspect": { - "description": "Inspect hybrid content and store findings to a job. To review the findings inspect the job. Inspection will occur asynchronously. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.", + "description": "Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.", "httpMethod": "POST", "id": "dlp.projects.locations.dlpJobs.hybridInspect", "parameterOrder": [ @@ -2627,7 +2852,7 @@ ] }, "hybridInspect": { - "description": "Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages.", + "description": "Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.", "httpMethod": "POST", "id": "dlp.projects.locations.jobTriggers.hybridInspect", "parameterOrder": [ @@ -2662,7 +2887,7 @@ ], "parameters": { "filter": { - "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", + "description": "Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \\\"2017-12-12T00:00:00+00:00\\\" The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -3039,7 +3264,7 @@ } } }, - "revision": "20200927", + "revision": "20210109", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -3515,7 +3740,7 @@ "enumDescriptions": [ "Includes all files.", "Includes all file extensions not covered by another entry. Binary scanning attempts to convert the content of the file to utf_8 to scan the file. If you wish to avoid this fall back, specify one or more of the other FileType's in your storage scan.", - "Included file extensions: asc, brf, c, cc, cpp, csv, cxx, c++, cs, css, dart, eml, go, h, hh, hpp, hxx, h++, hs, html, htm, shtml, shtm, xhtml, lhs, ini, java, js, json, ocaml, md, mkd, markdown, m, ml, mli, pl, pm, php, phtml, pht, py, pyw, rb, rbw, rs, rc, scala, sh, sql, tex, txt, text, tsv, vcard, vcs, wml, xml, xsl, xsd, yml, yaml.", + "Included file extensions: asc,asp, aspx, brf, c, cc,cfm, cgi, cpp, csv, cxx, c++, cs, css, dart, dat, dot, eml,, epbub, ged, go, h, hh, hpp, hxx, h++, hs, html, htm, mkd, markdown, m, ml, mli, perl, pl, plist, pm, php, phtml, pht, properties, py, pyw, rb, rbw, rs, rss, rc, scala, sh, sql, swift, tex, shtml, shtm, xhtml, lhs, ics, ini, java, js, json, kix, kml, ocaml, md, txt, text, tsv, vb, vcard, vcs, wml, xcodeproj, xml, xsl, xsd, yml, yaml.", "Included file extensions: bmp, gif, jpg, jpeg, jpe, png. bytes_limit_per_file has no effect on image files. Image inspection is restricted to 'global', 'us', 'asia', and 'europe'.", "Word files >30 MB will be scanned as binary files. Included file extensions: docx, dotx, docm, dotm", "PDF files >30 MB will be scanned as binary files. Included file extensions: pdf", @@ -3775,7 +4000,7 @@ "properties": { "inspectJob": { "$ref": "GooglePrivacyDlpV2InspectJobConfig", - "description": "Set to control what and how to inspect." + "description": "An inspection job scans a storage repository for InfoTypes." }, "jobId": { "description": "The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `[a-zA-Z\\d-_]+`. The maximum length is 100 characters. Can be empty to allow the system to generate one.", @@ -3787,7 +4012,7 @@ }, "riskJob": { "$ref": "GooglePrivacyDlpV2RiskAnalysisJobConfig", - "description": "Set to choose what metric to calculate." + "description": "A risk analysis job calculates re-identification risk metrics for a BigQuery table." } }, "type": "object" @@ -4579,6 +4804,10 @@ "format": "google-datetime", "type": "string" }, + "findingId": { + "description": "The unique finding id.", + "type": "string" + }, "infoType": { "$ref": "GooglePrivacyDlpV2InfoType", "description": "The type of content that might have been found. Provided if `excluded_types` is false." @@ -5106,7 +5335,7 @@ }, "result": { "$ref": "GooglePrivacyDlpV2Result", - "description": "A summary of the outcome of this inspect job." + "description": "A summary of the outcome of this inspection job." } }, "type": "object" @@ -6412,7 +6641,7 @@ "properties": { "hybridStats": { "$ref": "GooglePrivacyDlpV2HybridInspectStatistics", - "description": "Statistics related to the processing of hybrid inspect. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages." + "description": "Statistics related to the processing of hybrid inspect." }, "infoTypeStats": { "description": "Statistics of how many instances of each info type were found during inspect job.", @@ -6533,7 +6762,7 @@ }, "hybridOptions": { "$ref": "GooglePrivacyDlpV2HybridOptions", - "description": "Hybrid inspection options. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages." + "description": "Hybrid inspection options." }, "timespanConfig": { "$ref": "GooglePrivacyDlpV2TimespanConfig" @@ -6834,18 +7063,18 @@ "type": "boolean" }, "endTime": { - "description": "Exclude files or rows newer than this value. If set to zero, no upper time limit is applied.", + "description": "Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied.", "format": "google-datetime", "type": "string" }, "startTime": { - "description": "Exclude files or rows older than this value.", + "description": "Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied.", "format": "google-datetime", "type": "string" }, "timestampField": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: Required to filter out rows based on the given start and end times. If not specified and the table was modified between the given start and end times, the entire table will be scanned. The valid data types of the timestamp field are: `INTEGER`, `DATE`, `TIMESTAMP`, or `DATETIME` BigQuery column. For Datastore. Valid data types of the timestamp field are: `TIMESTAMP`. Datastore entity will be scanned if the timestamp property does not exist or its value is empty or invalid." + "description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. For BigQuery: If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. For Datastore: If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`." } }, "type": "object" @@ -6943,7 +7172,7 @@ "properties": { "manual": { "$ref": "GooglePrivacyDlpV2Manual", - "description": "For use with hybrid jobs. Jobs must be manually created and finished. Early access feature is in a pre-release state and might change or have limited support. For more information, see https://cloud.google.com/products#product-launch-stages." + "description": "For use with hybrid jobs. Jobs must be manually created and finished." }, "schedule": { "$ref": "GooglePrivacyDlpV2Schedule", @@ -7154,21 +7383,21 @@ "type": "object" }, "GoogleTypeDate": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "GoogleTypeDate", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" }
diff --git a/discovery/googleapis/dns__v1.json b/discovery/googleapis/dns__v1.json index 884442d..8b66fe2 100644 --- a/discovery/googleapis/dns__v1.json +++ b/discovery/googleapis/dns__v1.json
@@ -23,7 +23,7 @@ "canonicalName": "Dns", "description": "", "discoveryVersion": "v1", - "documentationLink": "http://developers.google.com/cloud-dns", + "documentationLink": "https://cloud.google.com/dns/docs", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -1014,7 +1014,7 @@ } } }, - "revision": "20200927", + "revision": "20210126", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -1333,6 +1333,10 @@ "$ref": "ManagedZoneReverseLookupConfig", "description": "The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS will resolve reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config." }, + "serviceDirectoryConfig": { + "$ref": "ManagedZoneServiceDirectoryConfig", + "description": "This field links to the associated service directory namespace. This field should not be set for public zones or forwarding zones." + }, "visibility": { "description": "The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.", "enum": [ @@ -1531,6 +1535,39 @@ }, "type": "object" }, + "ManagedZoneServiceDirectoryConfig": { + "description": "Contains information about Service Directory-backed zones.", + "id": "ManagedZoneServiceDirectoryConfig", + "properties": { + "kind": { + "default": "dns#managedZoneServiceDirectoryConfig", + "type": "string" + }, + "namespace": { + "$ref": "ManagedZoneServiceDirectoryConfigNamespace", + "description": "Contains information about the namespace associated with the zone." + } + }, + "type": "object" + }, + "ManagedZoneServiceDirectoryConfigNamespace": { + "id": "ManagedZoneServiceDirectoryConfigNamespace", + "properties": { + "deletionTime": { + "description": "The time that the namespace backing this zone was deleted, empty string if it still exists. This is in RFC3339 text format. Output only.", + "type": "string" + }, + "kind": { + "default": "dns#managedZoneServiceDirectoryConfigNamespace", + "type": "string" + }, + "namespaceUrl": { + "description": "The fully qualified URL of the namespace associated with the zone. This should be formatted like https://servicedirectory.googleapis.com/v1/projects/{project}/locations/{location}/namespaces/{namespace}", + "type": "string" + } + }, + "type": "object" + }, "ManagedZonesListResponse": { "id": "ManagedZonesListResponse", "properties": { @@ -1813,6 +1850,11 @@ "format": "int32", "type": "integer" }, + "gkeClustersPerPolicy": { + "description": "Maximum allowed number of GKE clusters per policy.", + "format": "int32", + "type": "integer" + }, "kind": { "default": "dns#quota", "type": "string" @@ -1887,6 +1929,118 @@ }, "type": "object" }, + "RRSetRoutingPolicy": { + "description": "A RRSetRoutingPolicy represents ResourceRecordSet data that will be returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection.", + "id": "RRSetRoutingPolicy", + "properties": { + "geoPolicy": { + "$ref": "RRSetRoutingPolicyGeoPolicy" + }, + "kind": { + "default": "dns#rRSetRoutingPolicy", + "type": "string" + }, + "wrrPolicy": { + "$ref": "RRSetRoutingPolicyWrrPolicy" + } + }, + "type": "object" + }, + "RRSetRoutingPolicyGeoPolicy": { + "id": "RRSetRoutingPolicyGeoPolicy", + "properties": { + "failovers": { + "description": "If the health check for the primary target for a geo location returns an unhealthy status, the failover target is returned instead. This failover configuration is not mandatory. If a failover is not provided, the primary target won't be healthchecked - we'll return the primarily configured rrdata irrespective of whether it is healthy or not.", + "items": { + "$ref": "RRSetRoutingPolicyGeoPolicyGeoPolicyItem" + }, + "type": "array" + }, + "items": { + "description": "The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead.", + "items": { + "$ref": "RRSetRoutingPolicyGeoPolicyGeoPolicyItem" + }, + "type": "array" + }, + "kind": { + "default": "dns#rRSetRoutingPolicyGeoPolicy", + "type": "string" + } + }, + "type": "object" + }, + "RRSetRoutingPolicyGeoPolicyGeoPolicyItem": { + "id": "RRSetRoutingPolicyGeoPolicyGeoPolicyItem", + "properties": { + "kind": { + "default": "dns#rRSetRoutingPolicyGeoPolicyGeoPolicyItem", + "type": "string" + }, + "location": { + "description": "The geo-location granularity is a GCP region. This location string should correspond to a GCP region. e.g \"us-east1\", \"southamerica-east1\", \"asia-east1\", etc.", + "type": "string" + }, + "rrdatas": { + "items": { + "type": "string" + }, + "type": "array" + }, + "signatureRrdatas": { + "description": "DNSSEC generated signatures for the above geo_rrdata.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RRSetRoutingPolicyWrrPolicy": { + "id": "RRSetRoutingPolicyWrrPolicy", + "properties": { + "items": { + "items": { + "$ref": "RRSetRoutingPolicyWrrPolicyWrrPolicyItem" + }, + "type": "array" + }, + "kind": { + "default": "dns#rRSetRoutingPolicyWrrPolicy", + "type": "string" + } + }, + "type": "object" + }, + "RRSetRoutingPolicyWrrPolicyWrrPolicyItem": { + "id": "RRSetRoutingPolicyWrrPolicyWrrPolicyItem", + "properties": { + "kind": { + "default": "dns#rRSetRoutingPolicyWrrPolicyWrrPolicyItem", + "type": "string" + }, + "rrdatas": { + "items": { + "type": "string" + }, + "type": "array" + }, + "signatureRrdatas": { + "description": "DNSSEC generated signatures for the above wrr_rrdata.", + "items": { + "type": "string" + }, + "type": "array" + }, + "weight": { + "description": "The weight corresponding to this subset of rrdata. When multiple WeightedRoundRobinPolicyItems are configured, the probability of returning an rrset is proportional to its weight relative to the sum of weights configured for all items. This weight should be a decimal in the range [0,1].", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "ResourceRecordSet": { "description": "A unit of data that will be returned by the DNS servers.", "id": "ResourceRecordSet", @@ -1899,6 +2053,10 @@ "description": "For example, www.example.com.", "type": "string" }, + "routingPolicy": { + "$ref": "RRSetRoutingPolicy", + "description": "Configures dynamic query responses based on geo location of querying user or a weighted round robin based routing policy. A ResourceRecordSet should only have either rrdata (static) or routing_policy(dynamic). An error is returned otherwise." + }, "rrdatas": { "description": "As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples.", "items": {
diff --git a/discovery/googleapis/docs__v1.json b/discovery/googleapis/docs__v1.json index e525e5a..e42e051 100644 --- a/discovery/googleapis/docs__v1.json +++ b/discovery/googleapis/docs__v1.json
@@ -211,7 +211,7 @@ } } }, - "revision": "20200929", + "revision": "20210201", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": {
diff --git a/discovery/googleapis/domainsrdap__v1.json b/discovery/googleapis/domainsrdap__v1.json index daa4776..d491c50 100644 --- a/discovery/googleapis/domainsrdap__v1.json +++ b/discovery/googleapis/domainsrdap__v1.json
@@ -277,7 +277,7 @@ } } }, - "revision": "20201008", + "revision": "20210203", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": {
diff --git a/discovery/googleapis/doubleclickbidmanager__v1.1.json b/discovery/googleapis/doubleclickbidmanager__v1.1.json index 1c75ec8..1d0559b 100644 --- a/discovery/googleapis/doubleclickbidmanager__v1.1.json +++ b/discovery/googleapis/doubleclickbidmanager__v1.1.json
@@ -331,7 +331,7 @@ } } }, - "revision": "20200930", + "revision": "20210125", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { @@ -800,7 +800,9 @@ "FILTER_PATH_PATTERN_ID", "FILTER_PATH_EVENT_INDEX", "FILTER_EVENT_TYPE", - "FILTER_CHANNEL_GROUPING" + "FILTER_CHANNEL_GROUPING", + "FILTER_OM_SDK_AVAILABLE", + "FILTER_DATA_SOURCE" ], "enumDescriptions": [ "", @@ -1063,6 +1065,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -1408,7 +1412,9 @@ "FILTER_PATH_PATTERN_ID", "FILTER_PATH_EVENT_INDEX", "FILTER_EVENT_TYPE", - "FILTER_CHANNEL_GROUPING" + "FILTER_CHANNEL_GROUPING", + "FILTER_OM_SDK_AVAILABLE", + "FILTER_DATA_SOURCE" ], "enumDescriptions": [ "", @@ -1671,6 +1677,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -2116,7 +2124,18 @@ "METRIC_CONVERTING_PATHS", "METRIC_ACTIVITY_REVENUE", "METRIC_PERCENT_INVALID_IMPRESSIONS_PREBID", - "METRIC_PROVISIONAL_IMPRESSIONS" + "METRIC_GRP_CORRECTED_IMPRESSIONS", + "METRIC_DEMO_CORRECTED_CLICKS", + "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_BY_DEMO", + "METRIC_VIRTUAL_PEOPLE_CLICK_REACH_BY_DEMO", + "METRIC_VIRTUAL_PEOPLE_AVERAGE_IMPRESSION_FREQUENCY_BY_DEMO", + "METRIC_DEMO_COMPOSITION_IMPRESSION", + "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_SHARE_PERCENT", + "METRIC_DEMO_POPULATION", + "METRIC_VIRTUAL_PEOPLE_IMPRESSION_REACH_PERCENT", + "METRIC_TARGET_RATING_POINTS", + "METRIC_PROVISIONAL_IMPRESSIONS", + "METRIC_VENDOR_BLOCKED_ADS" ], "enumDescriptions": [ "", @@ -2550,6 +2569,17 @@ "", "", "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", "" ], "type": "string" @@ -2952,7 +2982,9 @@ "FILTER_PATH_PATTERN_ID", "FILTER_PATH_EVENT_INDEX", "FILTER_EVENT_TYPE", - "FILTER_CHANNEL_GROUPING" + "FILTER_CHANNEL_GROUPING", + "FILTER_OM_SDK_AVAILABLE", + "FILTER_DATA_SOURCE" ], "enumDescriptions": [ "", @@ -3215,6 +3247,8 @@ "", "", "", + "", + "", "" ], "type": "string" @@ -3429,7 +3463,7 @@ "type": "string" }, "nextRunMinuteOfDay": { - "description": "Deprecated. This field has no effect.", + "description": "Time of day at which a new report will be generated, represented as minutes past midnight. Range is 0 to 1439. Only applies to scheduled reports.", "format": "int32", "type": "integer" },
diff --git a/discovery/googleapis/doubleclicksearch__v2.json b/discovery/googleapis/doubleclicksearch__v2.json index 3d1cc91..8707417 100644 --- a/discovery/googleapis/doubleclicksearch__v2.json +++ b/discovery/googleapis/doubleclicksearch__v2.json
@@ -389,7 +389,7 @@ } } }, - "revision": "20201006", + "revision": "20210128", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": {
diff --git a/discovery/googleapis/drive__v2.json b/discovery/googleapis/drive__v2.json index 0b4a46b..1e201fa 100644 --- a/discovery/googleapis/drive__v2.json +++ b/discovery/googleapis/drive__v2.json
@@ -6,7 +6,7 @@ "description": "See, edit, create, and delete all of your Google Drive files" }, "https://www.googleapis.com/auth/drive.appdata": { - "description": "View and manage its own configuration data in your Google Drive" + "description": "See, create, and delete its own configuration data in your Google Drive" }, "https://www.googleapis.com/auth/drive.apps.readonly": { "description": "View your Google Drive apps" @@ -38,7 +38,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/BPQ1TUMi81GIHDlDKeQ64ulvLKQ\"", + "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/XahuJgJfShZlCUumXlXY76htHpM\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -554,7 +554,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's last parent is removed, the item is placed under its owner's root.", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -617,7 +617,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child's owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.", + "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1132,13 +1132,13 @@ "parameters": { "convert": { "default": "false", - "description": "Whether to convert this file to the corresponding Google Docs format.", + "description": "Whether to convert this file to the corresponding Docs Editors format.", "location": "query", "type": "boolean" }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.", + "description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1232,7 +1232,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If an item's last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -1269,7 +1269,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If an item's last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" } @@ -1442,13 +1442,13 @@ "parameters": { "convert": { "default": "false", - "description": "Whether to convert this file to the corresponding Google Docs format.", + "description": "Whether to convert this file to the corresponding Docs Editors format.", "location": "query", "type": "boolean" }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.", + "description": "Deprecated. Creating files in multiple folders is no longer supported.", "location": "query", "type": "boolean" }, @@ -1673,7 +1673,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.", + "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1961,7 +1961,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.", + "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -2181,7 +2181,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's last parent is removed, the item is placed under its owner's root.", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -2250,7 +2250,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child's owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.", + "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -2463,7 +2463,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details.", + "description": "Deprecated. See moveToNewOwnersRoot for details.", "location": "query", "type": "boolean" }, @@ -2475,7 +2475,7 @@ }, "moveToNewOwnersRoot": { "default": "false", - "description": "This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive.", + "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.", "location": "query", "type": "boolean" }, @@ -3521,7 +3521,7 @@ } } }, - "revision": "20200924", + "revision": "20210201", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3906,7 +3906,7 @@ "type": "boolean" }, "supportsImport": { - "description": "Whether this app supports importing Google Docs.", + "description": "Whether this app supports importing from Docs Editors.", "type": "boolean" }, "supportsMultiOpen": { @@ -4798,7 +4798,7 @@ "type": "string" }, "downloadUrl": { - "description": "Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.", + "description": "Short lived download URL for the file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "driveId": { @@ -4826,15 +4826,15 @@ "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Google Docs to specific formats.", + "description": "Links for exporting Docs Editors files to specific formats.", "type": "object" }, "fileExtension": { - "description": "The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.", + "description": "The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "fileSize": { - "description": "The size of the file in bytes. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.", + "description": "The size of the file in bytes. This field is populated for files with content stored in Google Drive and for files in Docs Editors; it is not populated for shortcut files.", "format": "int64", "type": "string" }, @@ -4843,7 +4843,7 @@ "type": "string" }, "fullFileExtension": { - "description": "The full file extension; extracted from the title. May contain multiple concatenated extensions, such as \"tar.gz\". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.", + "description": "The full file extension; extracted from the title. May contain multiple concatenated extensions, such as \"tar.gz\". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "hasAugmentedPermissions": { @@ -4855,7 +4855,7 @@ "type": "boolean" }, "headRevisionId": { - "description": "The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.", + "description": "The ID of the file's head revision. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "iconLink": { @@ -5051,7 +5051,7 @@ "type": "string" }, "md5Checksum": { - "description": "An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Google Docs or shortcut files.", + "description": "An MD5 checksum for the content of this file. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.", "type": "string" }, "mimeType": { @@ -5192,7 +5192,7 @@ "type": "object" }, "thumbnailLink": { - "description": "A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.", + "description": "A short-lived link to the file's thumbnail. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.", "type": "string" }, "thumbnailVersion": { @@ -5612,7 +5612,7 @@ "type": "string" }, "visibility": { - "description": "The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)", + "description": "The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.", "type": "string" } }, @@ -5661,7 +5661,7 @@ "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Google Docs to specific formats.", + "description": "Links for exporting Docs Editors files to specific formats.", "type": "object" }, "fileSize": { @@ -5704,23 +5704,23 @@ "type": "string" }, "pinned": { - "description": "Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive which are not Google Docs. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.", + "description": "Whether this revision is pinned to prevent automatic purging. This will only be populated and can only be modified on files with content stored in Drive, excluding Docs Editors files. Revisions can also be pinned when they are created through the drive.files.insert/update/copy by using the pinned query parameter. Pinned revisions are stored indefinitely using additional storage quota, up to a maximum of 200 revisions.", "type": "boolean" }, "publishAuto": { - "description": "Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Google Docs.", + "description": "Whether subsequent revisions will be automatically republished. This is only populated and can only be modified for Docs Editors files.", "type": "boolean" }, "published": { - "description": "Whether this revision is published. This is only populated and can only be modified for Google Docs.", + "description": "Whether this revision is published. This is only populated and can only be modified for Docs Editors files.", "type": "boolean" }, "publishedLink": { - "description": "A link to the published revision.", + "description": "A link to the published revision. This is only populated for Google Sites files.", "type": "string" }, "publishedOutsideDomain": { - "description": "Whether this revision is published outside the domain. This is only populated and can only be modified for Google Docs.", + "description": "Whether this revision is published outside the domain. This is only populated and can only be modified for Docs Editors files.", "type": "boolean" }, "selfLink": {
diff --git a/discovery/googleapis/drive__v3.json b/discovery/googleapis/drive__v3.json index 7c81a66..b254e2a 100644 --- a/discovery/googleapis/drive__v3.json +++ b/discovery/googleapis/drive__v3.json
@@ -6,7 +6,7 @@ "description": "See, edit, create, and delete all of your Google Drive files" }, "https://www.googleapis.com/auth/drive.appdata": { - "description": "View and manage its own configuration data in your Google Drive" + "description": "See, create, and delete its own configuration data in your Google Drive" }, "https://www.googleapis.com/auth/drive.file": { "description": "View and manage Google Drive files and folders that you have opened or created with this app" @@ -35,7 +35,7 @@ "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/drive/", - "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/4wawualwqe_3DkQcgo3WDdTMeHw\"", + "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/1WBBtBNiBuUC1Ya8OOGZtDPCxSU\"", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" @@ -782,7 +782,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.", + "description": "Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -864,7 +864,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.", + "description": "Deprecated. Creating files in multiple folders is no longer supported.", "location": "query", "type": "boolean" }, @@ -934,7 +934,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If an item's last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" }, @@ -971,7 +971,7 @@ "parameters": { "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If an item's last parent is deleted but the item itself is not, the item will be placed under its owner's root.", + "description": "Deprecated. If an item is not in a shared drive and its last parent is deleted but the item itself is not, the item will be placed under its owner's root.", "location": "query", "type": "boolean" } @@ -1235,7 +1235,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.", + "description": "Deprecated. Adding files to multiple folders is no longer supported. Use shortcuts instead.", "location": "query", "type": "boolean" }, @@ -1379,7 +1379,7 @@ }, "enforceSingleParent": { "default": "false", - "description": "Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details.", + "description": "Deprecated. See moveToNewOwnersRoot for details.", "location": "query", "type": "boolean" }, @@ -1391,7 +1391,7 @@ }, "moveToNewOwnersRoot": { "default": "false", - "description": "This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive.", + "description": "This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.", "location": "query", "type": "boolean" }, @@ -2185,7 +2185,7 @@ } } }, - "revision": "20200924", + "revision": "20210201", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -2782,7 +2782,7 @@ "additionalProperties": { "type": "string" }, - "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests.", + "description": "A collection of arbitrary key-value pairs which are private to the requesting app.\nEntries with null values are cleared in update and copy requests. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.", "type": "object" }, "capabilities": { @@ -2985,7 +2985,7 @@ "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Google Docs to specific formats.", + "description": "Links for exporting Docs Editors files to specific formats.", "type": "object" }, "fileExtension": { @@ -3252,7 +3252,7 @@ "type": "object" }, "size": { - "description": "The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.", + "description": "The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files.", "format": "int64", "type": "string" }, @@ -3272,7 +3272,7 @@ "type": "string" }, "thumbnailLink": { - "description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.", + "description": "A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request.", "type": "string" }, "thumbnailVersion": { @@ -3620,7 +3620,7 @@ "description": "A mapping from export format to URL", "type": "string" }, - "description": "Links for exporting Google Docs to specific formats.", + "description": "Links for exporting Docs Editors files to specific formats.", "type": "object" }, "id": { @@ -3658,19 +3658,19 @@ "type": "string" }, "publishAuto": { - "description": "Whether subsequent revisions will be automatically republished. This is only applicable to Google Docs.", + "description": "Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.", "type": "boolean" }, "published": { - "description": "Whether this revision is published. This is only applicable to Google Docs.", + "description": "Whether this revision is published. This is only applicable to Docs Editors files.", "type": "boolean" }, "publishedLink": { - "description": "A link to the published revision.", + "description": "A link to the published revision. This is only populated for Google Sites files.", "type": "string" }, "publishedOutsideDomain": { - "description": "Whether this revision is published outside the domain. This is only applicable to Google Docs.", + "description": "Whether this revision is published outside the domain. This is only applicable to Docs Editors files.", "type": "boolean" }, "size": {
diff --git a/discovery/googleapis/driveactivity__v2.json b/discovery/googleapis/driveactivity__v2.json index 506576e..9ce1cee 100644 --- a/discovery/googleapis/driveactivity__v2.json +++ b/discovery/googleapis/driveactivity__v2.json
@@ -129,7 +129,7 @@ } } }, - "revision": "20201006", + "revision": "20210131", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": {
diff --git a/discovery/googleapis_beta/datafusion__v1beta1.json b/discovery/googleapis/eventarc__v1.json similarity index 67% copy from discovery/googleapis_beta/datafusion__v1beta1.json copy to discovery/googleapis/eventarc__v1.json index 9573836..6390840 100644 --- a/discovery/googleapis_beta/datafusion__v1beta1.json +++ b/discovery/googleapis/eventarc__v1.json
@@ -9,19 +9,19 @@ } }, "basePath": "", - "baseUrl": "https://datafusion.googleapis.com/", + "baseUrl": "https://eventarc.googleapis.com/", "batchPath": "batch", - "canonicalName": "Data Fusion", - "description": "Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure.", + "canonicalName": "Eventarc", + "description": "", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/data-fusion/docs", + "documentationLink": "https://cloud.google.com/eventarc", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "id": "datafusion:v1beta1", + "id": "eventarc:v1", "kind": "discovery#restDescription", - "name": "datafusion", + "name": "eventarc", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { @@ -110,7 +110,7 @@ "get": { "description": "Gets information about a location.", "httpMethod": "GET", - "id": "datafusion.projects.locations.get", + "id": "eventarc.projects.locations.get", "parameterOrder": [ "name" ], @@ -123,7 +123,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Location" }, @@ -134,7 +134,7 @@ "list": { "description": "Lists information about the supported locations for this service.", "httpMethod": "GET", - "id": "datafusion.projects.locations.list", + "id": "eventarc.projects.locations.list", "parameterOrder": [ "name" ], @@ -144,11 +144,6 @@ "location": "query", "type": "string" }, - "includeUnrevealedLocations": { - "description": "If true, the returned list will include locations which are not yet revealed.", - "location": "query", - "type": "boolean" - }, "name": { "description": "The resource that owns the locations collection, if applicable.", "location": "path", @@ -168,7 +163,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}/locations", + "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, @@ -178,312 +173,12 @@ } }, "resources": { - "instances": { - "methods": { - "create": { - "description": "Creates a new Data Fusion instance in the specified project and location.", - "httpMethod": "POST", - "id": "datafusion.projects.locations.instances.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "instanceId": { - "description": "The name of the instance to create.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The instance's project and location in the format projects/{project}/locations/{location}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/instances", - "request": { - "$ref": "Instance" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single Date Fusion instance.", - "httpMethod": "DELETE", - "id": "datafusion.projects.locations.instances.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single Data Fusion instance.", - "httpMethod": "GET", - "id": "datafusion.projects.locations.instances.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Instance" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "httpMethod": "GET", - "id": "datafusion.projects.locations.instances.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Data Fusion instances in the specified project and location.", - "httpMethod": "GET", - "id": "datafusion.projects.locations.instances.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "List filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Sort results. Supported values are \"name\", \"name desc\", or \"\" (unsorted).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as '-' (wildcard), then all regions available to the project are queried, and the results are aggregated.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/instances", - "response": { - "$ref": "ListInstancesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a single Data Fusion instance.", - "httpMethod": "PATCH", - "id": "datafusion.projects.locations.instances.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels and options currently) will be overwritten.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Instance" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "restart": { - "description": "Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.", - "httpMethod": "POST", - "id": "datafusion.projects.locations.instances.restart", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:restart", - "request": { - "$ref": "RestartInstanceRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "httpMethod": "POST", - "id": "datafusion.projects.locations.instances.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "httpMethod": "POST", - "id": "datafusion.projects.locations.instances.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "upgrade": { - "description": "Upgrade a single Data Fusion instance. At the end of an operation instance is fully upgraded.", - "httpMethod": "POST", - "id": "datafusion.projects.locations.instances.upgrade", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Name of the Data Fusion instance which need to be upgraded in the form of projects/{project}/locations/{location}/instances/{instance} Instance will be upgraded with the latest stable version of the Data Fusion.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:upgrade", - "request": { - "$ref": "UpgradeInstanceRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", - "id": "datafusion.projects.locations.operations.cancel", + "id": "eventarc.projects.locations.operations.cancel", "parameterOrder": [ "name" ], @@ -496,9 +191,9 @@ "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1/{+name}:cancel", "request": { - "$ref": "CancelOperationRequest" + "$ref": "GoogleLongrunningCancelOperationRequest" }, "response": { "$ref": "Empty" @@ -510,7 +205,7 @@ "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", - "id": "datafusion.projects.locations.operations.delete", + "id": "eventarc.projects.locations.operations.delete", "parameterOrder": [ "name" ], @@ -523,7 +218,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Empty" }, @@ -534,7 +229,7 @@ "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", - "id": "datafusion.projects.locations.operations.get", + "id": "eventarc.projects.locations.operations.get", "parameterOrder": [ "name" ], @@ -547,9 +242,9 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -558,7 +253,7 @@ "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "httpMethod": "GET", - "id": "datafusion.projects.locations.operations.list", + "id": "eventarc.projects.locations.operations.list", "parameterOrder": [ "name" ], @@ -587,9 +282,9 @@ "type": "string" } }, - "path": "v1beta1/{+name}/operations", + "path": "v1/{+name}/operations", "response": { - "$ref": "ListOperationsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -597,43 +292,270 @@ } } }, - "versions": { + "triggers": { "methods": { - "list": { - "description": "Lists possible versions for Data Fusion instances in the specified project and location.", - "httpMethod": "GET", - "id": "datafusion.projects.locations.versions.list", + "create": { + "description": "Create a new trigger in a particular project and location.", + "httpMethod": "POST", + "id": "eventarc.projects.locations.triggers.create", "parameterOrder": [ "parent" ], "parameters": { - "latestPatchOnly": { - "description": "Whether or not to return the latest patch of every available minor version. If true, only the latest patch will be returned. Ex. if allowed versions is [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]", + "parent": { + "description": "Required. The parent collection in which to add this trigger.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "triggerId": { + "description": "Required. The user-provided ID to be assigned to the trigger.", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Required. If set, validate the request and preview the review, but do not actually post it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/triggers", + "request": { + "$ref": "Trigger" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a single trigger.", + "httpMethod": "DELETE", + "id": "eventarc.projects.locations.triggers.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server.", "location": "query", "type": "boolean" }, + "etag": { + "description": "If provided, the trigger will only be deleted if the etag matches the current etag on the resource.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the trigger to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "Required. If set, validate the request and preview the review, but do not actually post it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a single trigger.", + "httpMethod": "GET", + "id": "eventarc.projects.locations.triggers.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the trigger to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Trigger" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "eventarc.projects.locations.triggers.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List triggers.", + "httpMethod": "GET", + "id": "eventarc.projects.locations.triggers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderBy": { + "description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. To specify descending order for a field, append a ` desc` suffix; for example: `name desc, trigger_id`.", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "The maximum number of items to return.", + "description": "The maximum number of triggers to return on each page. Note: The service may send fewer.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", + "description": "The page token; provide the value from the `next_page_token` field in a previous `ListTriggers` call to retrieve the subsequent page. When paginating, all other parameters provided to `ListTriggers` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.", + "description": "Required. The parent collection to list triggers on.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/versions", + "path": "v1/{+parent}/triggers", "response": { - "$ref": "ListAvailableVersionsResponse" + "$ref": "ListTriggersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a single trigger.", + "httpMethod": "PATCH", + "id": "eventarc.projects.locations.triggers.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the trigger is not found, a new trigger will be created. In this situation, `update_mask` is ignored.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name of the trigger. Must be unique within the location on the project and must be in `projects/{project}/locations/{location}/triggers/{trigger}` format.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The fields to be updated; only fields explicitly provided will be updated. If no field mask is provided, all provided fields in the request will be updated. To update all fields, provide a field mask of \"*\".", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Required. If set, validate the request and preview the review, but do not actually post it.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Trigger" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "eventarc.projects.locations.triggers.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "eventarc.projects.locations.triggers.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/triggers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -646,30 +568,9 @@ } } }, - "revision": "20201001", - "rootUrl": "https://datafusion.googleapis.com/", + "revision": "20210126", + "rootUrl": "https://eventarc.googleapis.com/", "schemas": { - "Accelerator": { - "description": "Identifies Data Fusion accelerators for an instance.", - "id": "Accelerator", - "properties": { - "acceleratorType": { - "description": "The type of an accelator for a CDF instance.", - "enum": [ - "ACCELERATOR_TYPE_UNSPECIFIED", - "CDC", - "HEALTHCARE" - ], - "enumDescriptions": [ - "Default value, if unspecified.", - "Change Data Capture accelerator for CDF.", - "Cloud Healthcare accelerator for CDF. This accelerator is to enable Cloud Healthcare specific CDF plugins developed by Healthcare team." - ], - "type": "string" - } - }, - "type": "object" - }, "AuditConfig": { "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.", "id": "AuditConfig", @@ -722,10 +623,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -744,10 +641,34 @@ }, "type": "object" }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, + "CloudRun": { + "description": "Represents a Cloud Run destination.", + "id": "CloudRun", + "properties": { + "path": { + "description": "Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: \"/route\", \"route\", \"route/subroute\".", + "type": "string" + }, + "region": { + "description": "Required. The region the Cloud Run service is deployed in.", + "type": "string" + }, + "service": { + "description": "Required. The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.", + "type": "string" + } + }, + "type": "object" + }, + "Destination": { + "description": "Represents a target of an invocation over HTTP.", + "id": "Destination", + "properties": { + "cloudRun": { + "$ref": "CloudRun", + "description": "Cloud Run fully-managed service that receives the events. The service should be running in the same project of the trigger." + } + }, "type": "object" }, "Empty": { @@ -756,6 +677,21 @@ "properties": {}, "type": "object" }, + "EventFilter": { + "description": "Filters events based on exact matches on the CloudEvents attributes.", + "id": "EventFilter", + "properties": { + "attribute": { + "description": "Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. All triggers MUST provide a filter for the 'type' attribute.", + "type": "string" + }, + "value": { + "description": "Required. The value for the attribute.", + "type": "string" + } + }, + "type": "object" + }, "Expr": { "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() < 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", @@ -779,217 +715,92 @@ }, "type": "object" }, - "Instance": { - "description": "Represents a Data Fusion instance.", - "id": "Instance", + "GoogleLongrunningCancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "GoogleLongrunningCancelOperationRequest", + "properties": {}, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", "properties": { - "accelerators": { - "description": "List of accelerators enabled for this CDF instance.", + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", "items": { - "$ref": "Accelerator" + "$ref": "GoogleLongrunningOperation" }, "type": "array" - }, - "apiEndpoint": { - "description": "Output only. Endpoint on which the REST APIs is accessible.", - "readOnly": true, - "type": "string" - }, - "availableVersion": { - "description": "Available versions that the instance can be upgraded to using UpdateInstanceRequest.", - "items": { - "$ref": "Version" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. The time the instance was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "dataprocServiceAccount": { - "description": "User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.", - "type": "string" - }, - "description": { - "description": "A description of this instance.", - "type": "string" - }, - "displayName": { - "description": "Display name for an instance.", - "type": "string" - }, - "enableStackdriverLogging": { - "description": "Option to enable Stackdriver Logging.", + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, - "enableStackdriverMonitoring": { - "description": "Option to enable Stackdriver Monitoring.", - "type": "boolean" + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." }, - "gcsBucket": { - "description": "Output only. Cloud Storage bucket generated by Data Fusion in the customer project.", - "readOnly": true, - "type": "string" - }, - "labels": { + "metadata": { "additionalProperties": { - "type": "string" + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" }, - "description": "The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels.", + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" }, "name": { - "description": "Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.", - "readOnly": true, + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, - "networkConfig": { - "$ref": "NetworkConfig", - "description": "Network configuration options. These are required when a private Data Fusion instance is to be created." - }, - "options": { + "response": { "additionalProperties": { - "type": "string" + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" }, - "description": "Map of additional options used to configure the behavior of Data Fusion instance.", + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" - }, - "p4ServiceAccount": { - "description": "Output only. P4 service account for the customer project.", - "readOnly": true, - "type": "string" - }, - "privateInstance": { - "description": "Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.", - "type": "boolean" - }, - "serviceAccount": { - "description": "Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.", - "readOnly": true, - "type": "string" - }, - "serviceEndpoint": { - "description": "Output only. Endpoint on which the Data Fusion UI is accessible.", - "readOnly": true, - "type": "string" - }, - "state": { - "description": "Output only. The current state of this Data Fusion instance.", - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "RUNNING", - "FAILED", - "DELETING", - "UPGRADING", - "RESTARTING", - "UPDATING", - "AUTO_UPDATING", - "AUTO_UPGRADING" - ], - "enumDescriptions": [ - "Instance does not have a state yet", - "Instance is being created", - "Instance is running and ready for requests", - "Instance creation failed", - "Instance is being deleted", - "Instance is being upgraded", - "Instance is being restarted", - "Instance is being updated on customer request", - "Instance is being auto-updated", - "Instance is being auto-upgraded" - ], - "readOnly": true, - "type": "string" - }, - "stateMessage": { - "description": "Output only. Additional information about the current state of this Data Fusion instance if available.", - "readOnly": true, - "type": "string" - }, - "tenantProjectId": { - "description": "Output only. The name of the tenant project.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "Required. Instance type.", - "enum": [ - "TYPE_UNSPECIFIED", - "BASIC", - "ENTERPRISE", - "DEVELOPER" - ], - "enumDescriptions": [ - "No type specified. The instance creation will fail.", - "Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines using point and click UI. However, there are certain limitations, such as fewer number of concurrent pipelines, no support for streaming pipelines, etc.", - "Enterprise Data Fusion instance. In Enterprise type, the user will have all features available, such as support for streaming pipelines, higher number of concurrent pipelines, etc.", - "Developer Data Fusion instance. In Developer type, the user will have all features available but with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration pipelines at low cost." - ], - "type": "string" - }, - "updateTime": { - "description": "Output only. The time the instance was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "version": { - "description": "Current version of Data Fusion.", - "type": "string" - }, - "zone": { - "description": "Name of the zone in which the Data Fusion instance will be created.", - "type": "string" } }, "type": "object" }, - "ListAvailableVersionsResponse": { - "description": "Response message for the list available versions request.", - "id": "ListAvailableVersionsResponse", + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", "properties": { - "availableVersions": { - "description": "Represents a list of versions that are supported.", + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { - "$ref": "Version" + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" }, "type": "array" }, - "nextPageToken": { - "description": "Token to retrieve the next page of results or empty if there are no more results in the list.", + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" } }, "type": "object" }, - "ListInstancesResponse": { - "description": "Response message for the list instance request.", - "id": "ListInstancesResponse", - "properties": { - "instances": { - "description": "Represents a list of Data Fusion instances.", - "items": { - "$ref": "Instance" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results or empty if there are no more results in the list.", - "type": "string" - }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -1008,18 +819,25 @@ }, "type": "object" }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", + "ListTriggersResponse": { + "description": "The response message for the ListTriggers method.", + "id": "ListTriggersResponse", "properties": { "nextPageToken": { - "description": "The standard List next-page token.", + "description": "A page token that can be sent to ListTriggers to request the next page. If this is empty, then there are no more pages.", "type": "string" }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", + "triggers": { + "description": "The requested triggers, up to the number specified in `page_size`.", "items": { - "$ref": "Operation" + "$ref": "Trigger" + }, + "type": "array" + }, + "unreachable": { + "description": "Unreachable resources, if any.", + "items": { + "type": "string" }, "type": "array" } @@ -1060,88 +878,45 @@ }, "type": "object" }, - "NetworkConfig": { - "description": "Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources.", - "id": "NetworkConfig", - "properties": { - "ipAllocation": { - "description": "The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network.", - "type": "string" - }, - "network": { - "description": "Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}", - "type": "string" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, "OperationMetadata": { - "description": "Represents the metadata of a long-running operation.", + "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", "properties": { "apiVersion": { - "description": "API version used to start the operation.", + "description": "Output only. API version used to start the operation.", + "readOnly": true, "type": "string" }, "createTime": { - "description": "The time the operation was created.", + "description": "Output only. The time the operation was created.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "endTime": { - "description": "The time the operation finished running.", + "description": "Output only. The time the operation finished running.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "requestedCancellation": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, "type": "boolean" }, - "statusDetail": { - "description": "Human-readable status of the operation if any.", + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, "type": "string" }, "target": { - "description": "Server-defined resource path for the target of the operation.", + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, "type": "string" }, "verb": { - "description": "Name of the verb executed by the operation.", + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, "type": "string" } }, @@ -1178,10 +953,20 @@ }, "type": "object" }, - "RestartInstanceRequest": { - "description": "Request message for restarting a Data Fusion instance.", - "id": "RestartInstanceRequest", - "properties": {}, + "Pubsub": { + "description": "Represents a Pub/Sub transport.", + "id": "Pubsub", + "properties": { + "subscription": { + "description": "Output only. The name of the Pub/Sub subscription created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}`.", + "readOnly": true, + "type": "string" + }, + "topic": { + "description": "Optional. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{PROJECT_ID}/topics/{TOPIC_NAME}`. You may set an existing topic for triggers of the type `google.cloud.pubsub.topic.v1.messagePublished` only. The topic you provide here will not be deleted by Eventarc at trigger deletion.", + "type": "string" + } + }, "type": "object" }, "SetIamPolicyRequest": { @@ -1200,33 +985,6 @@ }, "type": "object" }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -1255,29 +1013,64 @@ }, "type": "object" }, - "UpgradeInstanceRequest": { - "description": "Request message for upgrading a Data Fusion instance. To change the instance properties, instance update should be used.", - "id": "UpgradeInstanceRequest", - "properties": {}, + "Transport": { + "description": "Represents the transport intermediaries created for the trigger in order to deliver events.", + "id": "Transport", + "properties": { + "pubsub": { + "$ref": "Pubsub", + "description": "The Pub/Sub topic and subscription used by Eventarc as delivery intermediary." + } + }, "type": "object" }, - "Version": { - "description": "The Data Fusion version.", - "id": "Version", + "Trigger": { + "description": "A representation of the trigger resource.", + "id": "Trigger", "properties": { - "availableFeatures": { - "description": "Represents a list of available feature names for a given version.", + "createTime": { + "description": "Output only. The creation time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "destination": { + "$ref": "Destination", + "description": "Required. Destination specifies where the events should be sent to." + }, + "etag": { + "description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent only on create requests to ensure the client has an up-to-date value before proceeding.", + "readOnly": true, + "type": "string" + }, + "eventFilters": { + "description": "Required. The list of filters that applies to event attributes. Only events that match all the provided filters will be sent to the destination.", "items": { - "type": "string" + "$ref": "EventFilter" }, "type": "array" }, - "defaultVersion": { - "description": "Whether this is currently the default version for Cloud Data Fusion", - "type": "boolean" + "name": { + "description": "Required. The resource name of the trigger. Must be unique within the location on the project and must be in `projects/{project}/locations/{location}/triggers/{trigger}` format.", + "type": "string" }, - "versionNumber": { - "description": "The version number of the Data Fusion instance, such as '6.0.1.0'.", + "serviceAccount": { + "description": "Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The principal who calls this API must have `iam.serviceAccounts.actAs` permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. In order to create Audit Log triggers, the service account should also have 'eventarc.events.receiveAuditLogV1Written' permission.", + "type": "string" + }, + "transport": { + "$ref": "Transport", + "description": "Optional. In order to deliver messages, Eventarc may use other GCP products as transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes." + }, + "uid": { + "description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The last-modified time.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -1285,7 +1078,7 @@ } }, "servicePath": "", - "title": "Cloud Data Fusion API", - "version": "v1beta1", + "title": "Eventarc API", + "version": "v1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis/fcm__v1.json b/discovery/googleapis/fcm__v1.json index bd32c54..716ff5f 100644 --- a/discovery/googleapis/fcm__v1.json +++ b/discovery/googleapis/fcm__v1.json
@@ -139,7 +139,7 @@ } } }, - "revision": "20201005", + "revision": "20210201", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": {
diff --git a/discovery/googleapis/file__v1.json b/discovery/googleapis/file__v1.json index 64c498b..8b9b766 100644 --- a/discovery/googleapis/file__v1.json +++ b/discovery/googleapis/file__v1.json
@@ -178,10 +178,172 @@ } }, "resources": { + "backups": { + "methods": { + "create": { + "description": "Creates a backup.", + "httpMethod": "POST", + "id": "file.projects.locations.backups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backupId": { + "description": "Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Cloud Filestore, backup locations map to GCP regions, for example **us-west1**.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a backup.", + "httpMethod": "DELETE", + "id": "file.projects.locations.backups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a specific backup.", + "httpMethod": "GET", + "id": "file.projects.locations.backups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The backup resource name, in the format projects/{project_number}/locations/{location}/backups/{backup_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Backup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all backups in a project for either a specified location or for all locations.", + "httpMethod": "GET", + "id": "file.projects.locations.backups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "List filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value to use if there are additional results to retrieve for this list request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve backup information, in the format projects/{project_number}/locations/{location}. In Cloud Filestore, backup locations map to GCP regions, for example **us-west1**. To retrieve backup information for all locations, use \"-\" for the {location} value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "response": { + "$ref": "ListBackupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the settings of a specific backup.", + "httpMethod": "PATCH", + "id": "file.projects.locations.backups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update. At least one path must be supplied in this field.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "instances": { "methods": { "create": { - "description": "Creates an instance.", + "description": "Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).", "httpMethod": "POST", "id": "file.projects.locations.instances.create", "parameterOrder": [ @@ -337,6 +499,33 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "restore": { + "description": "Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).", + "httpMethod": "POST", + "id": "file.projects.locations.instances.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restore", + "request": { + "$ref": "RestoreInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -464,15 +653,167 @@ } } }, - "revision": "20201001", + "revision": "20210120", "rootUrl": "https://file.googleapis.com/", "schemas": { + "Backup": { + "description": "A Cloud Filestore backup.", + "id": "Backup", + "properties": { + "capacityGb": { + "description": "Output only. Capacity of the source file share when the backup was created.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the backup was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.", + "type": "string" + }, + "downloadBytes": { + "description": "Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource labels to represent user provided metadata.", + "type": "object" + }, + "name": { + "description": "Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.", + "readOnly": true, + "type": "string" + }, + "sourceFileShare": { + "description": "Name of the file share in the source Cloud Filestore instance that the backup is created from.", + "type": "string" + }, + "sourceInstance": { + "description": "The resource name of the source Cloud Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.", + "type": "string" + }, + "sourceInstanceTier": { + "description": "Output only. The service tier of the source Cloud Filestore instance that this backup is created from.", + "enum": [ + "TIER_UNSPECIFIED", + "STANDARD", + "PREMIUM", + "BASIC_HDD", + "BASIC_SSD", + "HIGH_SCALE_SSD" + ], + "enumDescriptions": [ + "Not set.", + "STANDARD tier.", + "PREMIUM tier.", + "BASIC instances offer a maximum capacity of 63.9 TB. BASIC_HDD is an alias for STANDARD Tier, offering economical performance backed by HDD.", + "BASIC instances offer a maximum capacity of 63.9 TB. BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance backed by SSD.", + "HIGH_SCALE instances offer expanded capacity and performance scaling capabilities." + ], + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The backup state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "FINALIZING", + "READY", + "DELETING" + ], + "enumDescriptions": [ + "State not set.", + "Backup is being created.", + "Backup has been taken and the operation is being finalized. At this point, changes to the file share will not be reflected in the backup.", + "Backup is available for use.", + "Backup is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "storageBytes": { + "description": "Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "DailyCycle": { + "description": "Time window specified for daily operations.", + "id": "DailyCycle", + "properties": { + "duration": { + "description": "Output only. Duration of the time window, set by service producer.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Time within the day to start the operations." + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "Date", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end." + }, + "startDate": { + "$ref": "Date", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start." + }, + "time": { + "$ref": "TimeOfDay", + "description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC" + } + }, + "type": "object" + }, "Empty": { "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); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", @@ -491,6 +832,17 @@ "name": { "description": "The name of the file share (must be 16 characters or less).", "type": "string" + }, + "nfsExportOptions": { + "description": "Nfs Export Options. There is a limit of 10 export options per file share.", + "items": { + "$ref": "NfsExportOptions" + }, + "type": "array" + }, + "sourceBackup": { + "description": "The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}, that this file share has been restored from.", + "type": "string" } }, "type": "object" @@ -519,7 +871,7 @@ "additionalProperties": { "type": "string" }, - "description": "The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", + "description": "Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", "type": "object" }, "maintenanceSchedules": { @@ -623,6 +975,11 @@ "description": "The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.", "type": "string" }, + "scheduleDeadlineTime": { + "description": "schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus a week. If the reschedule type is next window, simply take this value as start time. If reschedule type is IMMEDIATELY or BY_TIME, current or selected time cannot go beyond this deadline.", + "format": "google-datetime", + "type": "string" + }, "startTime": { "description": "The scheduled start time for the maintenance.", "format": "google-datetime", @@ -638,6 +995,13 @@ "exclude": { "description": "Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.", "type": "boolean" + }, + "maintenancePolicies": { + "additionalProperties": { + "$ref": "MaintenancePolicy" + }, + "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.", + "type": "object" } }, "type": "object" @@ -800,7 +1164,8 @@ "READY", "REPAIRING", "DELETING", - "ERROR" + "ERROR", + "RESTORING" ], "enumDescriptions": [ "State not set.", @@ -808,7 +1173,8 @@ "The instance is available for use.", "Work is being done on the instance. You can get further details from the `statusMessage` field of the `Instance` resource.", "The instance is shutting down.", - "The instance is experiencing an issue and might be unusable. You can get further details from the `statusMessage` field of the `Instance` resource." + "The instance is experiencing an issue and might be unusable. You can get further details from the `statusMessage` field of the `Instance` resource.", + "The instance is restoring a backup to an existing file share and may be unusable during this time." ], "readOnly": true, "type": "string" @@ -841,6 +1207,31 @@ }, "type": "object" }, + "ListBackupsResponse": { + "description": "ListBackupsResponse is the result of ListBackupsRequest.", + "id": "ListBackupsResponse", + "properties": { + "backups": { + "description": "A list of backups in the project for the specified location. If the {location} value in the request is \"-\", the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the \"unreachable\" field will be populated with a list of unreachable locations.", + "items": { + "$ref": "Backup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "ListInstancesResponse is the result of ListInstancesRequest.", "id": "ListInstancesResponse", @@ -936,6 +1327,71 @@ }, "type": "object" }, + "MaintenancePolicy": { + "description": "Defines policies to service maintenance events.", + "id": "MaintenancePolicy", + "properties": { + "createTime": { + "description": "Output only. The time when the resource was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.", + "type": "object" + }, + "name": { + "description": "Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`.", + "type": "string" + }, + "state": { + "description": "Optional. The state of the policy.", + "enum": [ + "STATE_UNSPECIFIED", + "READY", + "DELETING" + ], + "enumDescriptions": [ + "Unspecified state.", + "Resource is ready to be used.", + "Resource is being deleted. It can no longer be attached to instances." + ], + "type": "string" + }, + "updatePolicy": { + "$ref": "UpdatePolicy", + "description": "Maintenance policy applicable to instance update." + }, + "updateTime": { + "description": "Output only. The time when the resource was updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "MaintenanceWindow definition.", + "id": "MaintenanceWindow", + "properties": { + "dailyCycle": { + "$ref": "DailyCycle", + "description": "Daily cycle." + }, + "weeklyCycle": { + "$ref": "WeeklyCycle", + "description": "Weekly cycle." + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for the instance.", "id": "NetworkConfig", @@ -974,6 +1430,58 @@ }, "type": "object" }, + "NfsExportOptions": { + "description": "NFS export options specifications.", + "id": "NfsExportOptions", + "properties": { + "accessMode": { + "description": "Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.", + "enum": [ + "ACCESS_MODE_UNSPECIFIED", + "READ_ONLY", + "READ_WRITE" + ], + "enumDescriptions": [ + "AccessMode not set.", + "The client can only read the file share.", + "The client can read and write the file share (default)." + ], + "type": "string" + }, + "anonGid": { + "description": "An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.", + "format": "int64", + "type": "string" + }, + "anonUid": { + "description": "An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.", + "format": "int64", + "type": "string" + }, + "ipRanges": { + "description": "List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "squashMode": { + "description": "Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.", + "enum": [ + "SQUASH_MODE_UNSPECIFIED", + "NO_ROOT_SQUASH", + "ROOT_SQUASH" + ], + "enumDescriptions": [ + "SquashMode not set.", + "The Root user has root access to the file share (default).", + "The Root user has squashed access to the anonymous uid/gid." + ], + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -1046,6 +1554,61 @@ }, "type": "object" }, + "RestoreInstanceRequest": { + "description": "RestoreInstanceRequest restores an existing instances's file share from a backup.", + "id": "RestoreInstanceRequest", + "properties": { + "fileShare": { + "description": "Required. Name of the file share in the Cloud Filestore instance that the backup is being restored to.", + "type": "string" + }, + "sourceBackup": { + "description": "The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.", + "type": "string" + } + }, + "type": "object" + }, + "Schedule": { + "description": "Configure the schedule.", + "id": "Schedule", + "properties": { + "day": { + "description": "Allows to define schedule that runs specified day of the week.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "duration": { + "description": "Output only. Duration of the time window, set by service producer.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Time within the window to start the operations." + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1072,6 +1635,79 @@ } }, "type": "object" + }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "UpdatePolicy": { + "description": "Maintenance policy applicable to instance updates.", + "id": "UpdatePolicy", + "properties": { + "channel": { + "description": "Optional. Relative scheduling channel applied to resource.", + "enum": [ + "UPDATE_CHANNEL_UNSPECIFIED", + "EARLIER", + "LATER" + ], + "enumDescriptions": [ + "Unspecified channel.", + "Early channel within a customer project.", + "Later channel within a customer project." + ], + "type": "string" + }, + "denyMaintenancePeriods": { + "description": "Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. User can specify zero or more non-overlapping deny periods. For V1, Maximum number of deny_maintenance_periods is expected to be one.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, + "window": { + "$ref": "MaintenanceWindow", + "description": "Optional. Maintenance window that is applied to resources covered by this policy." + } + }, + "type": "object" + }, + "WeeklyCycle": { + "description": "Time window specified for weekly operations.", + "id": "WeeklyCycle", + "properties": { + "schedule": { + "description": "User can specify multiple windows in a week. Minimum of 1 window.", + "items": { + "$ref": "Schedule" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/firebasedynamiclinks__v1.json b/discovery/googleapis/firebasedynamiclinks__v1.json index 248821c..fea69f2 100644 --- a/discovery/googleapis/firebasedynamiclinks__v1.json +++ b/discovery/googleapis/firebasedynamiclinks__v1.json
@@ -218,7 +218,7 @@ } } }, - "revision": "20200929", + "revision": "20210125", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": {
diff --git a/discovery/googleapis/firebasehosting__v1.json b/discovery/googleapis/firebasehosting__v1.json new file mode 100644 index 0000000..29231fe --- /dev/null +++ b/discovery/googleapis/firebasehosting__v1.json
@@ -0,0 +1,284 @@ +{ + "basePath": "", + "baseUrl": "https://firebasehosting.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Firebase Hosting", + "description": "The Firebase Hosting REST API enables programmatic and customizable deployments to your Firebase-hosted sites. Use this REST API to deploy new or updated hosting configurations and content files.", + "discoveryVersion": "v1", + "documentationLink": "https://firebase.google.com/docs/hosting/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "firebasehosting:v1", + "kind": "discovery#restDescription", + "name": "firebasehosting", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "firebasehosting.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + } + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "firebasehosting.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + } + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "firebasehosting.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^operations$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ListOperationsResponse" + } + } + } + } + }, + "revision": "20210129", + "rootUrl": "https://firebasehosting.googleapis.com/", + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Firebase Hosting API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/firebaseml__v1.json b/discovery/googleapis/firebaseml__v1.json new file mode 100644 index 0000000..6b4bcf2 --- /dev/null +++ b/discovery/googleapis/firebaseml__v1.json
@@ -0,0 +1,326 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://firebaseml.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Firebase ML", + "description": "Access custom machine learning models hosted via Firebase ML.", + "discoveryVersion": "v1", + "documentationLink": "https://firebase.google.com", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "firebaseml:v1", + "kind": "discovery#restDescription", + "name": "firebaseml", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "firebaseml.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "firebaseml.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "firebaseml.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^operations$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + }, + "revision": "20210203", + "rootUrl": "https://firebaseml.googleapis.com/", + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ModelOperationMetadata": { + "description": "This is returned in the longrunning operations for create/update.", + "id": "ModelOperationMetadata", + "properties": { + "basicOperationStatus": { + "enum": [ + "BASIC_OPERATION_STATUS_UNSPECIFIED", + "BASIC_OPERATION_STATUS_UPLOADING", + "BASIC_OPERATION_STATUS_VERIFYING" + ], + "enumDescriptions": [ + "The status is unspecified", + "The model file is being uploaded", + "The model file is being verified" + ], + "type": "string" + }, + "name": { + "description": "The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Firebase ML API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/firebaserules__v1.json b/discovery/googleapis/firebaserules__v1.json index a078362..eb7e4d7 100644 --- a/discovery/googleapis/firebaserules__v1.json +++ b/discovery/googleapis/firebaserules__v1.json
@@ -464,7 +464,7 @@ } } }, - "revision": "20200917", + "revision": "20210126", "rootUrl": "https://firebaserules.googleapis.com/", "schemas": { "Arg": {
diff --git a/discovery/googleapis/firestore__v1.json b/discovery/googleapis/firestore__v1.json index 4f11217..0f37b2f 100644 --- a/discovery/googleapis/firestore__v1.json +++ b/discovery/googleapis/firestore__v1.json
@@ -1128,7 +1128,7 @@ } } }, - "revision": "20200912", + "revision": "20201003", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "ArrayValue": {
diff --git a/discovery/googleapis/fitness__v1.json b/discovery/googleapis/fitness__v1.json index ac50fe2..a15c4fe 100644 --- a/discovery/googleapis/fitness__v1.json +++ b/discovery/googleapis/fitness__v1.json
@@ -32,6 +32,12 @@ "https://www.googleapis.com/auth/fitness.body_temperature.write": { "description": "See and add to info about your body temperature in Google Fit. I consent to Google sharing my body temperature information with this app." }, + "https://www.googleapis.com/auth/fitness.heart_rate.read": { + "description": "See your heart rate data in Google Fit. I consent to Google sharing my heart rate information with this app." + }, + "https://www.googleapis.com/auth/fitness.heart_rate.write": { + "description": "See and add to your heart rate data in Google Fit. I consent to Google sharing my heart rate information with this app." + }, "https://www.googleapis.com/auth/fitness.location.read": { "description": "See your Google Fit speed and distance data" }, @@ -55,6 +61,12 @@ }, "https://www.googleapis.com/auth/fitness.reproductive_health.write": { "description": "See and add info about your reproductive health in Google Fit. I consent to Google sharing my reproductive health information with this app." + }, + "https://www.googleapis.com/auth/fitness.sleep.read": { + "description": "See your sleep data in Google Fit. I consent to Google sharing my sleep information with this app." + }, + "https://www.googleapis.com/auth/fitness.sleep.write": { + "description": "See and add to your sleep data in Google Fit. I consent to Google sharing my sleep information with this app." } } } @@ -185,10 +197,12 @@ "https://www.googleapis.com/auth/fitness.blood_pressure.write", "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.write", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "delete": { @@ -223,10 +237,12 @@ "https://www.googleapis.com/auth/fitness.blood_pressure.write", "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.write", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "get": { @@ -266,6 +282,8 @@ "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.read", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.read", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.read", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.read", @@ -273,7 +291,9 @@ "https://www.googleapis.com/auth/fitness.oxygen_saturation.read", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", "https://www.googleapis.com/auth/fitness.reproductive_health.read", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.read", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "list": { @@ -312,6 +332,8 @@ "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.read", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.read", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.read", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.read", @@ -319,7 +341,9 @@ "https://www.googleapis.com/auth/fitness.oxygen_saturation.read", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", "https://www.googleapis.com/auth/fitness.reproductive_health.read", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.read", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "update": { @@ -357,10 +381,12 @@ "https://www.googleapis.com/auth/fitness.blood_pressure.write", "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.write", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.write" ] } }, @@ -415,6 +441,8 @@ "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.read", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.read", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.read", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.read", @@ -422,7 +450,9 @@ "https://www.googleapis.com/auth/fitness.oxygen_saturation.read", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", "https://www.googleapis.com/auth/fitness.reproductive_health.read", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.read", + "https://www.googleapis.com/auth/fitness.sleep.write" ] } } @@ -477,10 +507,12 @@ "https://www.googleapis.com/auth/fitness.blood_pressure.write", "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.write", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "get": { @@ -506,7 +538,7 @@ "type": "string" }, "limit": { - "description": "If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response.", + "description": "If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response. The limit is applied from the end of the time range. That is, if pageToken is absent, the limit most recent data points will be returned.", "format": "int32", "location": "query", "type": "integer" @@ -538,6 +570,8 @@ "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.read", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.read", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.read", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.read", @@ -545,11 +579,13 @@ "https://www.googleapis.com/auth/fitness.oxygen_saturation.read", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", "https://www.googleapis.com/auth/fitness.reproductive_health.read", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.read", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "patch": { - "description": "Adds data points to a dataset. The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics.", + "description": "Adds data points to a dataset. The dataset need not be previously created. All points within the given dataset will be returned with subsquent calls to retrieve this dataset. Data points can belong to more than one dataset. This method does not use patch semantics: the data points provided are merely inserted, with no existing data replaced.", "httpMethod": "PATCH", "id": "fitness.users.dataSources.datasets.patch", "parameterOrder": [ @@ -571,7 +607,7 @@ "type": "string" }, "datasetId": { - "description": "Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: \"startTime-endTime\" where startTime and endTime are 64 bit integers.", + "description": "This field is not used, and can be safely omitted.", "location": "path", "required": true, "type": "string" @@ -596,10 +632,12 @@ "https://www.googleapis.com/auth/fitness.blood_pressure.write", "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.write", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.write" ] } } @@ -641,6 +679,8 @@ "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.read", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.read", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.read", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.read", @@ -648,7 +688,9 @@ "https://www.googleapis.com/auth/fitness.oxygen_saturation.read", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", "https://www.googleapis.com/auth/fitness.reproductive_health.read", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.read", + "https://www.googleapis.com/auth/fitness.sleep.write" ] } } @@ -685,7 +727,8 @@ }, "path": "{userId}/sessions/{sessionId}", "scopes": [ - "https://www.googleapis.com/auth/fitness.activity.write" + "https://www.googleapis.com/auth/fitness.activity.write", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "list": { @@ -745,6 +788,8 @@ "https://www.googleapis.com/auth/fitness.body.write", "https://www.googleapis.com/auth/fitness.body_temperature.read", "https://www.googleapis.com/auth/fitness.body_temperature.write", + "https://www.googleapis.com/auth/fitness.heart_rate.read", + "https://www.googleapis.com/auth/fitness.heart_rate.write", "https://www.googleapis.com/auth/fitness.location.read", "https://www.googleapis.com/auth/fitness.location.write", "https://www.googleapis.com/auth/fitness.nutrition.read", @@ -752,7 +797,9 @@ "https://www.googleapis.com/auth/fitness.oxygen_saturation.read", "https://www.googleapis.com/auth/fitness.oxygen_saturation.write", "https://www.googleapis.com/auth/fitness.reproductive_health.read", - "https://www.googleapis.com/auth/fitness.reproductive_health.write" + "https://www.googleapis.com/auth/fitness.reproductive_health.write", + "https://www.googleapis.com/auth/fitness.sleep.read", + "https://www.googleapis.com/auth/fitness.sleep.write" ] }, "update": { @@ -791,7 +838,8 @@ "$ref": "Session" }, "scopes": [ - "https://www.googleapis.com/auth/fitness.activity.write" + "https://www.googleapis.com/auth/fitness.activity.write", + "https://www.googleapis.com/auth/fitness.sleep.write" ] } } @@ -799,7 +847,7 @@ } } }, - "revision": "20201005", + "revision": "20210202", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": {
diff --git a/discovery/googleapis/gamesConfiguration__v1configuration.json b/discovery/googleapis/gamesConfiguration__v1configuration.json index 8a938ff..0a6baf5 100644 --- a/discovery/googleapis/gamesConfiguration__v1configuration.json +++ b/discovery/googleapis/gamesConfiguration__v1configuration.json
@@ -427,7 +427,7 @@ } } }, - "revision": "20201001", + "revision": "20210128", "rootUrl": "https://gamesconfiguration.googleapis.com/", "schemas": { "AchievementConfiguration": {
diff --git a/discovery/googleapis/gamesManagement__v1management.json b/discovery/googleapis/gamesManagement__v1management.json index 0f774fe..3924327 100644 --- a/discovery/googleapis/gamesManagement__v1management.json +++ b/discovery/googleapis/gamesManagement__v1management.json
@@ -452,7 +452,7 @@ } } }, - "revision": "20201001", + "revision": "20210128", "rootUrl": "https://gamesmanagement.googleapis.com/", "schemas": { "AchievementResetAllResponse": {
diff --git a/discovery/googleapis/games__v1.json b/discovery/googleapis/games__v1.json index 0a91527..b9e421a 100644 --- a/discovery/googleapis/games__v1.json +++ b/discovery/googleapis/games__v1.json
@@ -379,6 +379,41 @@ "https://www.googleapis.com/auth/games" ] }, + "getEndPoint": { + "description": "Returns a URL for the requested end point type.", + "httpMethod": "POST", + "id": "games.applications.getEndPoint", + "parameterOrder": [], + "parameters": { + "applicationId": { + "description": "The application ID from the Google Play developer console.", + "location": "query", + "type": "string" + }, + "endPointType": { + "description": "Type of endpoint being requested.", + "enum": [ + "END_POINT_TYPE_UNSPECIFIED", + "PROFILE_CREATION", + "PROFILE_SETTINGS" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Request a URL to create a new profile.", + "Request a URL for the Settings view." + ], + "location": "query", + "type": "string" + } + }, + "path": "games/v1/applications/getEndPoint", + "response": { + "$ref": "EndPoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/games" + ] + }, "played": { "description": "Indicate that the currently authenticated user is playing your application.", "httpMethod": "POST", @@ -1140,6 +1175,37 @@ } } }, + "snapshotsExtended": { + "methods": { + "resolveSnapshotHead": { + "description": "Resolves any potential conflicts according to the resolution policy specified in the request and returns the snapshot head after the resolution.", + "httpMethod": "POST", + "id": "games.snapshotsExtended.resolveSnapshotHead", + "parameterOrder": [ + "snapshotName" + ], + "parameters": { + "snapshotName": { + "description": "Required. Name of the snapshot.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "games/v1/snapshotsExtended/{snapshotName}:resolveHead", + "request": { + "$ref": "ResolveSnapshotHeadRequest" + }, + "response": { + "$ref": "ResolveSnapshotHeadResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive.appdata", + "https://www.googleapis.com/auth/games" + ] + } + } + }, "stats": { "methods": { "get": { @@ -1159,7 +1225,7 @@ } } }, - "revision": "20201001", + "revision": "20210128", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { @@ -1627,6 +1693,17 @@ }, "type": "object" }, + "EndPoint": { + "description": "Container for a URL end point of the requested type.", + "id": "EndPoint", + "properties": { + "url": { + "description": "A URL suitable for loading in a web browser for the requested endpoint.", + "type": "string" + } + }, + "type": "object" + }, "EventBatchRecordFailure": { "description": "A batch update failure resource.", "id": "EventBatchRecordFailure", @@ -2827,6 +2904,49 @@ }, "type": "object" }, + "ResolveSnapshotHeadRequest": { + "description": "Request for ResolveSnapshotHead RPC.", + "id": "ResolveSnapshotHeadRequest", + "properties": { + "maxConflictsPerSnapshot": { + "description": "The maximum number of SnapshotRevision resources for `conflictingRevisions` to return per SnapshotExtended resource in the response. For any response, the actual number of resources returned may be less than specified by `maxConflictsPerSnapshot`. The value provided should be greater or equal to 0. If no value is provided, the server will use a sensible default.", + "format": "int32", + "type": "integer" + }, + "resolutionPolicy": { + "description": "Required. The automatic resolution policy. All conflicts are resolved in chronological order, starting from the/ least recent. If the comparison metric is equal for the tentative head and the conflict, the head wins.", + "enum": [ + "RESOLUTION_POLICY_UNSPECIFIED", + "USE_HEAD", + "LONGEST_PLAYTIME", + "MOST_RECENTLY_MODIFIED", + "HIGHEST_PROGRESS", + "NO_AUTOMATIC_RESOLUTION" + ], + "enumDescriptions": [ + "Safe default, don't use explicitly.", + "Drops all conflicts and keeps the current head only.", + "Use the snapshot with the longest played time.", + "Use the snapshot that was most recently modified.", + "Use the snapshot with the highest progress value.", + "Don't resolve conflicts at all. Effectively only returns the current head revision of the snapshot. Corresponds to a game opening the snapshot with manual resolution policy." + ], + "type": "string" + } + }, + "type": "object" + }, + "ResolveSnapshotHeadResponse": { + "description": "Response for ResolveSnapshotHead RPC.", + "id": "ResolveSnapshotHeadResponse", + "properties": { + "snapshot": { + "$ref": "SnapshotExtended", + "description": "The state of the snapshot." + } + }, + "type": "object" + }, "RevisionCheckResponse": { "description": "A third party checking a revision response.", "id": "RevisionCheckResponse", @@ -2948,6 +3068,95 @@ }, "type": "object" }, + "SnapshotCoverImageResource": { + "description": "Identifies a snapshot cover image resource. The image is provided by the game.", + "id": "SnapshotCoverImageResource", + "properties": { + "contentHash": { + "description": "Output only. Hash-like weak identifier of the uploaded image bytes, consistent per player per application. The content hash for a given resource will not change if the binary data hasn't changed. Except in very rare circumstances, the content_hash for matching binary data will be the same within a given player and application.", + "readOnly": true, + "type": "string" + }, + "downloadUrl": { + "description": "Output only. A URL the client can use to download the image. May vary across requests, and only guaranteed to be valid for a short time after it is returned.", + "readOnly": true, + "type": "string" + }, + "height": { + "description": "The height of the image in pixels.", + "format": "int32", + "type": "integer" + }, + "mimeType": { + "description": "Output only. The MIME type of the image.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the image resource. It's guaranteed that if two IDs are equal then the contents are equal as well. It's not guaranteed that two identical blobs coming from separate uploads have the same ID. The resource ID can only be used within the application, user and resource type it was originally returned for. For example, it's not possible to use SnapshotDataResource's resource ID as the resource_id of a SnapshotCoverImageResource, even if the blob is a valid image file.", + "type": "string" + }, + "width": { + "description": "The width of the image in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SnapshotDataResource": { + "description": "Identifies a snapshot data resource. The data is provided by the game.", + "id": "SnapshotDataResource", + "properties": { + "contentHash": { + "description": "Output only. Hash-like weak identifier of the uploaded blob bytes, consistent per player per application. The content hash for a given resource will not change if the binary data hasn't changed. Except in very rare circumstances, the content_hash for matching binary data will be the same within a given player and application.", + "readOnly": true, + "type": "string" + }, + "downloadUrl": { + "description": "Output only. A URL that the client can use to download the blob. May vary across requests, and only guaranteed to be valid for a short time after it is returned.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the blob resource. It's guaranteed that if two IDs are equal then the contents are equal as well. It's not guaranteed that two identical blobs coming from separate uploads have the same resource ID. The resource ID can only be used within the application, user and resource type it was originally returned for. For example, it's not possible to use SnapshotDataResource's resource ID as the resource_id of a SnapshotCoverImageResource, even if the blob is a valid image file.", + "type": "string" + }, + "size": { + "description": "Output only. Size of the saved game blob in bytes.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SnapshotExtended": { + "description": "A snapshot represents a saved game state referred to using the developer-provided snapshot_name. The set of attributes and binary data for a specific state is called a revision. Each revision is itself immutable, and referred to by a snapshot revision id. At any time, a snapshot has a \"head\" revision, and updates are made against that revision. If a snapshot update is received that isn't against the current head revision, then instead of changing the head revision it will result in a conflicting revision that must be specifically resolved.", + "id": "SnapshotExtended", + "properties": { + "conflictingRevisions": { + "description": "A list of conflicting revisions. Only set if explicitly requested (e.g. using a field mask or a request flag), or if the RPC guarantees that this field is set. The conflicting revisions are sorted chronologically by their server creation time (oldest first). If there are too many conflicting revisions to return all of them in a single request this will only contain the first batch. In such case, the presented conflicting revisions must be resolved first in order to fetch the next batch.", + "items": { + "$ref": "SnapshotRevision" + }, + "type": "array" + }, + "hasConflictingRevisions": { + "description": "An indicator whether the snapshot has any conflicting revisions or not. Always set.", + "type": "boolean" + }, + "headRevision": { + "$ref": "SnapshotRevision", + "description": "The current head revision (the canonical revision as understood by the server)." + }, + "snapshotName": { + "description": "An identifier of the snapshot, developer-specified. It must match the pattern [0-9a-zA-Z-._~]{1,100}.", + "type": "string" + } + }, + "type": "object" + }, "SnapshotImage": { "description": "An image of a snapshot.", "id": "SnapshotImage", @@ -2999,6 +3208,60 @@ }, "type": "object" }, + "SnapshotMetadata": { + "description": "Metadata about a snapshot revision. Snapshot metadata is immutable - a metadata change corresponds to a new snapshot revision.", + "id": "SnapshotMetadata", + "properties": { + "description": { + "description": "The description of this snapshot.", + "type": "string" + }, + "deviceName": { + "description": "The device that created the current revision.", + "type": "string" + }, + "gameplayDuration": { + "description": "The duration associated with this snapshot. Values with sub-millisecond precision can be rounded or trimmed to the closest millisecond.", + "format": "google-duration", + "type": "string" + }, + "lastModifyTime": { + "description": "The timestamp of the last modification to this snapshot as provided by the client. Values with sub-millisecond precision can be rounded or trimmed to the closest millisecond.", + "format": "google-datetime", + "type": "string" + }, + "progressValue": { + "description": "The progress value (64-bit integer set by developer) associated with this snapshot.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "SnapshotRevision": { + "description": "A Snapshot revision resource. Snapshot revisions are immutable.", + "id": "SnapshotRevision", + "properties": { + "blob": { + "$ref": "SnapshotDataResource", + "description": "Reference to the game provided blob for this revision." + }, + "coverImage": { + "$ref": "SnapshotCoverImageResource", + "description": "Reference to the cover image for this revision." + }, + "id": { + "description": "Output only. A server generated identifier of the snapshot revision.", + "readOnly": true, + "type": "string" + }, + "metadata": { + "$ref": "SnapshotMetadata", + "description": "Metadata for this snapshot revision." + } + }, + "type": "object" + }, "StatsResponse": { "description": "A third party stats resource.", "id": "StatsResponse",
diff --git a/discovery/googleapis_beta/gameservices__v1beta.json b/discovery/googleapis/gameservices__v1.json similarity index 93% rename from discovery/googleapis_beta/gameservices__v1beta.json rename to discovery/googleapis/gameservices__v1.json index 57d3fa0..a5351c8 100644 --- a/discovery/googleapis_beta/gameservices__v1beta.json +++ b/discovery/googleapis/gameservices__v1.json
@@ -19,7 +19,7 @@ "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "id": "gameservices:v1beta", + "id": "gameservices:v1", "kind": "discovery#restDescription", "name": "gameservices", "ownerDomain": "google.com", @@ -123,7 +123,7 @@ "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Location" }, @@ -168,7 +168,7 @@ "type": "string" } }, - "path": "v1beta/{+name}/locations", + "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, @@ -194,14 +194,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/gameServerDeployments", + "path": "v1/{+parent}/gameServerDeployments", "request": { "$ref": "GameServerDeployment" }, @@ -221,14 +221,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server delpoyment to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", + "description": "Required. The name of the game server delpoyment to delete, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -245,14 +245,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server delpoyment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", + "description": "Required. The name of the game server delpoyment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}:fetchDeploymentState", + "path": "v1/{+name}:fetchDeploymentState", "request": { "$ref": "FetchDeploymentStateRequest" }, @@ -272,14 +272,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server delpoyment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", + "description": "Required. The name of the game server delpoyment to retrieve, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "GameServerDeployment" }, @@ -309,7 +309,7 @@ "type": "string" } }, - "path": "v1beta/{+resource}:getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", "response": { "$ref": "Policy" }, @@ -326,14 +326,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server delpoyment to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.", + "description": "Required. The name of the game server delpoyment to retrieve, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}/rollout", + "path": "v1/{+name}/rollout", "response": { "$ref": "GameServerDeploymentRollout" }, @@ -371,14 +371,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/gameServerDeployments", + "path": "v1/{+parent}/gameServerDeployments", "response": { "$ref": "ListGameServerDeploymentsResponse" }, @@ -395,20 +395,20 @@ ], "parameters": { "name": { - "description": "The resource name of the game server deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.", + "description": "The resource name of the game server deployment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask", + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "request": { "$ref": "GameServerDeployment" }, @@ -428,7 +428,7 @@ ], "parameters": { "name": { - "description": "The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.", + "description": "The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, @@ -441,13 +441,13 @@ "type": "string" }, "updateMask": { - "description": "Optional. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask", + "description": "Optional. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta/{+name}/rollout:preview", + "path": "v1/{+name}/rollout:preview", "request": { "$ref": "GameServerDeploymentRollout" }, @@ -474,7 +474,7 @@ "type": "string" } }, - "path": "v1beta/{+resource}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, @@ -501,7 +501,7 @@ "type": "string" } }, - "path": "v1beta/{+resource}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, @@ -521,20 +521,20 @@ ], "parameters": { "name": { - "description": "The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.", + "description": "The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask", + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta/{+name}/rollout", + "path": "v1/{+name}/rollout", "request": { "$ref": "GameServerDeploymentRollout" }, @@ -563,14 +563,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/configs", + "path": "v1/{+parent}/configs", "request": { "$ref": "GameServerConfig" }, @@ -590,14 +590,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server config to delete. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", + "description": "Required. The name of the game server config to delete, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -614,14 +614,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server config to retrieve. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", + "description": "Required. The name of the game server config to retrieve, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+/configs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "GameServerConfig" }, @@ -659,14 +659,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gameServerDeployments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/configs", + "path": "v1/{+parent}/configs", "response": { "$ref": "ListGameServerConfigsResponse" }, @@ -696,7 +696,7 @@ "type": "string" } }, - "path": "v1beta/{+name}:cancel", + "path": "v1/{+name}:cancel", "request": { "$ref": "CancelOperationRequest" }, @@ -723,7 +723,7 @@ "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Empty" }, @@ -747,7 +747,7 @@ "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -787,7 +787,7 @@ "type": "string" } }, - "path": "v1beta/{+name}/operations", + "path": "v1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, @@ -808,7 +808,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -820,7 +820,7 @@ "type": "string" } }, - "path": "v1beta/{+parent}/realms", + "path": "v1/{+parent}/realms", "request": { "$ref": "Realm" }, @@ -840,14 +840,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the realm to delete. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`.", + "description": "Required. The name of the realm to delete, in the following form: `projects/{project}/locations/{location}/realms/{realm}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -864,14 +864,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the realm to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`.", + "description": "Required. The name of the realm to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Realm" }, @@ -909,14 +909,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/realms", + "path": "v1/{+parent}/realms", "response": { "$ref": "ListRealmsResponse" }, @@ -933,20 +933,20 @@ ], "parameters": { "name": { - "description": "The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.", + "description": "The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask", + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "request": { "$ref": "Realm" }, @@ -966,7 +966,7 @@ ], "parameters": { "name": { - "description": "The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.", + "description": "The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, @@ -979,13 +979,13 @@ "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask", + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta/{+name}:previewUpdate", + "path": "v1/{+name}:previewUpdate", "request": { "$ref": "Realm" }, @@ -1014,14 +1014,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/gameServerClusters", + "path": "v1/{+parent}/gameServerClusters", "request": { "$ref": "GameServerCluster" }, @@ -1041,14 +1041,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", + "description": "Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -1065,14 +1065,14 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server cluster to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`.", + "description": "Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "response": { "$ref": "GameServerCluster" }, @@ -1110,14 +1110,14 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: \"projects/{project}/locations/{location}/realms/{realm}\".", + "description": "Required. The parent resource name, in the following form: \"projects/{project}/locations/{location}/realms/{realm}\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta/{+parent}/gameServerClusters", + "path": "v1/{+parent}/gameServerClusters", "response": { "$ref": "ListGameServerClustersResponse" }, @@ -1134,20 +1134,20 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", + "description": "Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask", + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta/{+name}", + "path": "v1/{+name}", "request": { "$ref": "GameServerCluster" }, @@ -1172,7 +1172,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`.", + "description": "Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/realms/{realm}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, @@ -1185,7 +1185,7 @@ "type": "string" } }, - "path": "v1beta/{+parent}/gameServerClusters:previewCreate", + "path": "v1/{+parent}/gameServerClusters:previewCreate", "request": { "$ref": "GameServerCluster" }, @@ -1205,7 +1205,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", + "description": "Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, @@ -1218,7 +1218,7 @@ "type": "string" } }, - "path": "v1beta/{+name}:previewDelete", + "path": "v1/{+name}:previewDelete", "response": { "$ref": "PreviewDeleteGameServerClusterResponse" }, @@ -1235,7 +1235,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", + "description": "Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+/gameServerClusters/[^/]+$", "required": true, @@ -1248,13 +1248,13 @@ "type": "string" }, "updateMask": { - "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask", + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta/{+name}:previewUpdate", + "path": "v1/{+name}:previewUpdate", "request": { "$ref": "GameServerCluster" }, @@ -1274,7 +1274,7 @@ } } }, - "revision": "20201001", + "revision": "20210126", "rootUrl": "https://gameservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -1364,7 +1364,6 @@ "id": "Binding", "properties": { "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", "type": "string" }, "condition": { @@ -1440,7 +1439,7 @@ "An approver (distinct from the requester) that has authorized this request. When used with IN, the condition indicates that one of the approvers associated with the request matches the specified principal, or is a member of the specified group. Approvers can only grant additional access, and are thus only used in a strictly positive context (e.g. ALLOW/IN or DENY/NOT_IN).", "What types of justifications have been supplied with this request. String values should match enum names from security.credentials.JustificationType, e.g. \"MANUAL_STRING\". It is not permitted to grant access based on the *absence* of a justification, so justification conditions can only be used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN). Multiple justifications, e.g., a Buganizer ID and a manually-entered reason, are normal and supported.", "What type of credentials have been supplied with this request. String values should match enum names from security_loas_l2.CredentialsType - currently, only CREDS_TYPE_EMERGENCY is supported. It is not permitted to grant access based on the *absence* of a credentials type, so the conditions can only be used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).", - "EXPERIMENTAL -- DO NOT USE. " + "EXPERIMENTAL -- DO NOT USE. The conditions can only be used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN)." ], "type": "string" }, @@ -1754,7 +1753,7 @@ "type": "object" }, "name": { - "description": "Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", + "description": "Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.", "type": "string" }, "updateTime": { @@ -1810,7 +1809,7 @@ "type": "object" }, "name": { - "description": "The resource name of the game server config. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.", + "description": "The resource name of the game server config, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.", "type": "string" }, "scalingConfigs": { @@ -1870,7 +1869,7 @@ "type": "object" }, "name": { - "description": "The resource name of the game server deployment. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.", + "description": "The resource name of the game server deployment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.", "type": "string" }, "updateTime": { @@ -1908,7 +1907,7 @@ "type": "array" }, "name": { - "description": "The resource name of the game server deployment rollout. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.", + "description": "The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.", "type": "string" }, "updateTime": { @@ -2409,7 +2408,7 @@ "type": "object" }, "name": { - "description": "The resource name of the realm. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.", + "description": "The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.", "type": "string" }, "timeZone": { @@ -2730,6 +2729,6 @@ }, "servicePath": "", "title": "Game Services API", - "version": "v1beta", + "version": "v1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis/genomics__v1.json b/discovery/googleapis/genomics__v1.json index e5cc9a6..c4fe0f0 100644 --- a/discovery/googleapis/genomics__v1.json +++ b/discovery/googleapis/genomics__v1.json
@@ -204,7 +204,7 @@ } } }, - "revision": "20201005", + "revision": "20210125", "rootUrl": "https://genomics.googleapis.com/", "schemas": { "CancelOperationRequest": {
diff --git a/discovery/googleapis/gmail__v1.json b/discovery/googleapis/gmail__v1.json index bfeaf39..c36b96b 100644 --- a/discovery/googleapis/gmail__v1.json +++ b/discovery/googleapis/gmail__v1.json
@@ -890,7 +890,7 @@ "type": "string" }, "id": { - "description": "The ID of the message to retrieve.", + "description": "The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`).", "location": "path", "required": true, "type": "string" @@ -2613,7 +2613,7 @@ } } }, - "revision": "20200919", + "revision": "20210118", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": {
diff --git a/discovery/googleapis/gmailpostmastertools__v1.json b/discovery/googleapis/gmailpostmastertools__v1.json new file mode 100644 index 0000000..c886536 --- /dev/null +++ b/discovery/googleapis/gmailpostmastertools__v1.json
@@ -0,0 +1,527 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/postmaster.readonly": { + "description": "See email traffic metrics for the domains you have registered in Gmail Postmaster Tools" + } + } + } + }, + "basePath": "", + "baseUrl": "https://gmailpostmastertools.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Postmaster Tools", + "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/gmail/postmaster", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "gmailpostmastertools:v1", + "kind": "discovery#restDescription", + "name": "gmailpostmastertools", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "domains": { + "methods": { + "get": { + "description": "Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.", + "httpMethod": "GET", + "id": "gmailpostmastertools.domains.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the domain. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.", + "location": "path", + "pattern": "^domains/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Domain" + }, + "scopes": [ + "https://www.googleapis.com/auth/postmaster.readonly" + ] + }, + "list": { + "description": "Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.", + "httpMethod": "GET", + "id": "gmailpostmastertools.domains.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to `ListDomains` method.", + "location": "query", + "type": "string" + } + }, + "path": "v1/domains", + "response": { + "$ref": "ListDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/postmaster.readonly" + ] + } + }, + "resources": { + "trafficStats": { + "methods": { + "get": { + "description": "Get traffic statistics for a domain on a specific date. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.", + "httpMethod": "GET", + "id": "gmailpostmastertools.domains.trafficStats.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the traffic statistics to get. E.g., domains/mymail.mydomain.com/trafficStats/20160807.", + "location": "path", + "pattern": "^domains/[^/]+/trafficStats/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "TrafficStats" + }, + "scopes": [ + "https://www.googleapis.com/auth/postmaster.readonly" + ] + }, + "list": { + "description": "List traffic statistics for all available days. Returns PERMISSION_DENIED if user does not have permission to access TrafficStats for the domain.", + "httpMethod": "GET", + "id": "gmailpostmastertools.domains.trafficStats.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "endDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageSize": { + "description": "Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous List request, if any. This is the value of ListTrafficStatsResponse.next_page_token returned from the previous call to `ListTrafficStats` method.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The resource name of the domain whose traffic statistics we'd like to list. It should have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name.", + "location": "path", + "pattern": "^domains/[^/]+$", + "required": true, + "type": "string" + }, + "startDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/{+parent}/trafficStats", + "response": { + "$ref": "ListTrafficStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/postmaster.readonly" + ] + } + } + } + } + } + }, + "revision": "20210202", + "rootUrl": "https://gmailpostmastertools.googleapis.com/", + "schemas": { + "DeliveryError": { + "description": "Metric on a particular delivery error type.", + "id": "DeliveryError", + "properties": { + "errorClass": { + "description": "The class of delivery error.", + "enum": [ + "DELIVERY_ERROR_CLASS_UNSPECIFIED", + "PERMANENT_ERROR", + "TEMPORARY_ERROR" + ], + "enumDescriptions": [ + "The default value which should never be used explicitly.", + "Delivery of message has been rejected.", + "Temporary failure of message delivery to the recipient." + ], + "type": "string" + }, + "errorRatio": { + "description": "The ratio of messages where the error occurred vs all authenticated traffic.", + "format": "double", + "type": "number" + }, + "errorType": { + "description": "The type of delivery error.", + "enum": [ + "DELIVERY_ERROR_TYPE_UNSPECIFIED", + "RATE_LIMIT_EXCEEDED", + "SUSPECTED_SPAM", + "CONTENT_SPAMMY", + "BAD_ATTACHMENT", + "BAD_DMARC_POLICY", + "LOW_IP_REPUTATION", + "LOW_DOMAIN_REPUTATION", + "IP_IN_RBL", + "DOMAIN_IN_RBL", + "BAD_PTR_RECORD" + ], + "enumDescriptions": [ + "The default value which should never be used explicitly.", + "The Domain or IP is sending traffic at a suspiciously high rate, due to which temporary rate limits have been imposed. The limit will be lifted when Gmail is confident enough of the nature of the traffic.", + "The traffic is suspected to be spam, by Gmail, for various reasons.", + "The traffic is suspected to be spammy, specific to the content.", + "Traffic contains attachments not supported by Gmail.", + "The sender domain has set up a DMARC rejection policy.", + "The IP reputation of the sending IP is very low.", + "The Domain reputation of the sending domain is very low.", + "The IP is listed in one or more public [Real-time Blackhole Lists](http://en.wikipedia.org/wiki/DNSBL). Work with the RBL to get your IP delisted.", + "The Domain is listed in one or more public [Real-time Blackhole Lists](http://en.wikipedia.org/wiki/DNSBL). Work with the RBL to get your domain delisted.", + "The sending IP is missing a [PTR record](https://support.google.com/domains/answer/3251147#ptr)." + ], + "type": "string" + } + }, + "type": "object" + }, + "Domain": { + "description": "A registered domain resource in the Postmaster API.", + "id": "Domain", + "properties": { + "createTime": { + "description": "Timestamp when the user registered this domain. Assigned by the server.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The resource name of the Domain. Domain names have the form `domains/{domain_name}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).", + "type": "string" + }, + "permission": { + "description": "User’s permission for this domain. Assigned by the server.", + "enum": [ + "PERMISSION_UNSPECIFIED", + "OWNER", + "READER", + "NONE" + ], + "enumDescriptions": [ + "The default value and should never be used explicitly.", + "User has read access to the domain and can share access with others.", + "User has read access to the domain.", + "User doesn't have permission to access information about the domain. User did not verify ownership of domain nor was access granted by other domain owners." + ], + "type": "string" + } + }, + "type": "object" + }, + "FeedbackLoop": { + "description": "[Feedback loop](https://support.google.com/mail/answer/6254652) identifier information.", + "id": "FeedbackLoop", + "properties": { + "id": { + "description": "Feedback loop identifier that uniquely identifies individual campaigns.", + "type": "string" + }, + "spamRatio": { + "description": "The ratio of user marked spam messages with the identifier vs the total number of inboxed messages with that identifier.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "IpReputation": { + "description": "IP Reputation information for a set of IPs in a specific reputation category.", + "id": "IpReputation", + "properties": { + "ipCount": { + "description": "Total number of unique IPs in this reputation category. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).", + "format": "int64", + "type": "string" + }, + "reputation": { + "description": "The reputation category this IP reputation represents.", + "enum": [ + "REPUTATION_CATEGORY_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "BAD" + ], + "enumDescriptions": [ + "The default value which should never be used explicitly. This represents the state where no reputation information is available.", + "Has a good track record of a very low spam rate, and complies with Gmail's sender guidelines. Mail will rarely be marked by the spam filter.", + "Known to send good mail, but is prone to sending a low volume of spam intermittently. Most of the email from this entity will have a fair deliverability rate, except when there is a notable increase in spam levels.", + "Known to send a considerable volume of spam regularly, and mail from this sender will likely be marked as spam.", + "History of sending an enormously high volume of spam. Mail coming from this entity will almost always be rejected at SMTP level or marked as spam." + ], + "type": "string" + }, + "sampleIps": { + "description": "A sample of IPs in this reputation category.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListDomainsResponse": { + "description": "Response message for ListDomains.", + "id": "ListDomainsResponse", + "properties": { + "domains": { + "description": "The list of domains.", + "items": { + "$ref": "Domain" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + } + }, + "type": "object" + }, + "ListTrafficStatsResponse": { + "description": "Response message for ListTrafficStats.", + "id": "ListTrafficStatsResponse", + "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "trafficStats": { + "description": "The list of TrafficStats.", + "items": { + "$ref": "TrafficStats" + }, + "type": "array" + } + }, + "type": "object" + }, + "TrafficStats": { + "description": "Email traffic statistics pertaining to a specific date.", + "id": "TrafficStats", + "properties": { + "deliveryErrors": { + "description": "Delivery errors for the domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).", + "items": { + "$ref": "DeliveryError" + }, + "type": "array" + }, + "dkimSuccessRatio": { + "description": "The ratio of mail that successfully authenticated with DKIM vs. all mail that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is excluded.", + "format": "double", + "type": "number" + }, + "dmarcSuccessRatio": { + "description": "The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs all mail received from the domain that successfully authenticated with either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).", + "format": "double", + "type": "number" + }, + "domainReputation": { + "description": "Reputation of the domain.", + "enum": [ + "REPUTATION_CATEGORY_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "BAD" + ], + "enumDescriptions": [ + "The default value which should never be used explicitly. This represents the state where no reputation information is available.", + "Has a good track record of a very low spam rate, and complies with Gmail's sender guidelines. Mail will rarely be marked by the spam filter.", + "Known to send good mail, but is prone to sending a low volume of spam intermittently. Most of the email from this entity will have a fair deliverability rate, except when there is a notable increase in spam levels.", + "Known to send a considerable volume of spam regularly, and mail from this sender will likely be marked as spam.", + "History of sending an enormously high volume of spam. Mail coming from this entity will almost always be rejected at SMTP level or marked as spam." + ], + "type": "string" + }, + "inboundEncryptionRatio": { + "description": "The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).", + "format": "double", + "type": "number" + }, + "ipReputations": { + "description": "Reputation information pertaining to the IP addresses of the email servers for the domain. There is exactly one entry for each reputation category except REPUTATION_CATEGORY_UNSPECIFIED.", + "items": { + "$ref": "IpReputation" + }, + "type": "array" + }, + "name": { + "description": "The resource name of the traffic statistics. Traffic statistic names have the form `domains/{domain}/trafficStats/{date}`, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic statistics pertains to and date is the date in yyyymmdd format that these statistics corresponds to. For example: domains/mymail.mydomain.com/trafficStats/20160807", + "type": "string" + }, + "outboundEncryptionRatio": { + "description": "The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).", + "format": "double", + "type": "number" + }, + "spammyFeedbackLoops": { + "description": "Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/6254652) with their individual spam rates. This metric only pertains to traffic that is authenticated by [DKIM](http://www.dkim.org/).", + "items": { + "$ref": "FeedbackLoop" + }, + "type": "array" + }, + "spfSuccessRatio": { + "description": "The ratio of mail that successfully authenticated with SPF vs. all mail that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is excluded.", + "format": "double", + "type": "number" + }, + "userReportedSpamRatio": { + "description": "The ratio of user-report spam vs. email that was sent to the inbox. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", + "format": "double", + "type": "number" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Gmail Postmaster Tools API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/groupsmigration__v1.json b/discovery/googleapis/groupsmigration__v1.json index 59bb825..d68bfe9 100644 --- a/discovery/googleapis/groupsmigration__v1.json +++ b/discovery/googleapis/groupsmigration__v1.json
@@ -144,7 +144,7 @@ } } }, - "revision": "20201001", + "revision": "20210126", "rootUrl": "https://groupsmigration.googleapis.com/", "schemas": { "Groups": {
diff --git a/discovery/googleapis/groupssettings__v1.json b/discovery/googleapis/groupssettings__v1.json index 4d4ee41..d027068 100644 --- a/discovery/googleapis/groupssettings__v1.json +++ b/discovery/googleapis/groupssettings__v1.json
@@ -152,7 +152,7 @@ } } }, - "revision": "20201001", + "revision": "20210128", "rootUrl": "https://www.googleapis.com/", "schemas": { "Groups": { @@ -294,7 +294,7 @@ "type": "string" }, "whoCanContactOwner": { - "description": "Permission to contact owner of the group via web UI. Possible values are: \n- ALL_IN_DOMAIN_CAN_CONTACT \n- ALL_MANAGERS_CAN_CONTACT \n- ALL_MEMBERS_CAN_CONTACT \n- ANYONE_CAN_CONTACT", + "description": "Permission to contact owner of the group via web UI. Possible values are: \n- ALL_IN_DOMAIN_CAN_CONTACT \n- ALL_MANAGERS_CAN_CONTACT \n- ALL_MEMBERS_CAN_CONTACT \n- ANYONE_CAN_CONTACT \n- ALL_OWNERS_CAN_CONTACT", "type": "string" }, "whoCanDeleteAnyPost": {
diff --git a/discovery/googleapis/healthcare__v1.json b/discovery/googleapis/healthcare__v1.json index a431724..6930216 100644 --- a/discovery/googleapis/healthcare__v1.json +++ b/discovery/googleapis/healthcare__v1.json
@@ -321,7 +321,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000.", + "description": "The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000.", "format": "int32", "location": "query", "type": "integer" @@ -436,6 +436,94 @@ } }, "resources": { + "consentStores": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.consentStores.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/consentStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.consentStores.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/consentStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.consentStores.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/consentStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "dicomStores": { "methods": { "create": { @@ -643,7 +731,7 @@ "type": "string" }, "pageSize": { - "description": "Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used.", + "description": "Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1594,7 +1682,7 @@ ] }, "import": { - "description": "Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.", + "description": "Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.import", "parameterOrder": [ @@ -1634,7 +1722,7 @@ "type": "string" }, "pageSize": { - "description": "Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used.", + "description": "Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1760,7 +1848,7 @@ ], "parameters": { "_count": { - "description": "Maximum number of resources in a page. Defaults to 100.", + "description": "Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1954,7 +2042,7 @@ "type": "string" }, "_count": { - "description": "The maximum number of search results on a page. Defaults to 1000.", + "description": "The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000.", "format": "int32", "location": "query", "type": "integer" @@ -2037,7 +2125,7 @@ ] }, "search": { - "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).", + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search", "parameterOrder": [ @@ -2063,8 +2151,42 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "search-type": { + "description": "Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see [Searching for FHIR resources](/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](/healthcare/docs/how-tos/fhir-advanced-search).", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.search-type", + "parameterOrder": [ + "parent", + "resourceType" + ], + "parameters": { + "parent": { + "description": "Name of the FHIR store to retrieve resources from.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", + "required": true, + "type": "string" + }, + "resourceType": { + "description": "The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)).", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/fhir/{resourceType}/_search", + "request": { + "$ref": "SearchResourcesRequest" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "update": { - "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", + "description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", "httpMethod": "PUT", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.update", "parameterOrder": [ @@ -2244,7 +2366,7 @@ "type": "string" }, "pageSize": { - "description": "Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used.", + "description": "Limit on the number of HL7v2 stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.", "format": "int32", "location": "query", "type": "integer" @@ -2501,7 +2623,7 @@ "type": "string" }, "pageSize": { - "description": "Limit on the number of messages to return in a single response. If zero the default page size of 100 is used.", + "description": "Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000.", "format": "int32", "location": "query", "type": "integer" @@ -2685,7 +2807,7 @@ } } }, - "revision": "20200924", + "revision": "20210115", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AuditConfig": { @@ -2989,11 +3111,11 @@ "properties": { "bigqueryDestination": { "$ref": "GoogleCloudHealthcareV1DicomBigQueryDestination", - "description": "The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`." + "description": "The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`." }, "gcsDestination": { "$ref": "GoogleCloudHealthcareV1DicomGcsDestination", - "description": "The Cloud Storage output destination. The Cloud Storage location requires the `roles/storage.objectAdmin` Cloud IAM role." + "description": "The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location." } }, "type": "object" @@ -3010,7 +3132,7 @@ "properties": { "bigqueryDestination": { "$ref": "GoogleCloudHealthcareV1FhirBigQueryDestination", - "description": "The BigQuery output destination. The BigQuery location requires two IAM roles: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output is one BigQuery table per resource type." + "description": "The BigQuery output destination. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output is one BigQuery table per resource type." }, "gcsDestination": { "$ref": "GoogleCloudHealthcareV1FhirGcsDestination", @@ -3078,15 +3200,15 @@ "id": "FhirStore", "properties": { "disableReferentialIntegrity": { - "description": "Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.", + "description": "Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.", "type": "boolean" }, "disableResourceVersioning": { - "description": "Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", + "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", "type": "boolean" }, "enableUpdateCreate": { - "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications.", + "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.", "type": "boolean" }, "labels": { @@ -3112,7 +3234,7 @@ "type": "array" }, "version": { - "description": "The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.", + "description": "Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.", "enum": [ "VERSION_UNSPECIFIED", "DSTU2", @@ -3222,12 +3344,28 @@ "type": "string" }, "force": { - "description": "If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error.", + "description": "If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, "schemaConfig": { "$ref": "SchemaConfig", "description": "The configuration for the exported BigQuery schema." + }, + "writeDisposition": { + "description": "Determines whether existing tables in the destination dataset are overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored.", + "enum": [ + "WRITE_DISPOSITION_UNSPECIFIED", + "WRITE_EMPTY", + "WRITE_TRUNCATE", + "WRITE_APPEND" + ], + "enumDescriptions": [ + "Default behavior is the same as WRITE_EMPTY.", + "Only export data if the destination tables are empty.", + "Erase all existing data in a tables before writing the instances.", + "Append data to the existing tables." + ], + "type": "string" } }, "type": "object" @@ -3358,7 +3496,7 @@ "properties": { "gcsSource": { "$ref": "GoogleCloudHealthcareV1DicomGcsSource", - "description": "Cloud Storage source data location and import configuration. The Cloud Storage location requires the `roles/storage.objectViewer` Cloud IAM role." + "description": "Cloud Storage source data location and import configuration. The Cloud Healthcare Service Agent requires the `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage location." } }, "type": "object" @@ -3384,7 +3522,7 @@ ], "enumDescriptions": [ "If the content structure is not specified, the default value `BUNDLE` is used.", - "The source file contains one or more lines of newline-delimited JSON (ndjson). Each line is a bundle that contains one or more resources. Set the bundle type to `history` to import resource versions.", + "The source file contains one or more lines of newline-delimited JSON (ndjson). Each line is a bundle that contains one or more resources.", "The source file contains one or more lines of newline-delimited JSON (ndjson). Each line is a single resource.", "The entire file is one JSON bundle. The JSON can span multiple lines.", "The entire file is one JSON resource. The JSON can span multiple lines."
diff --git a/discovery/googleapis/homegraph__v1.json b/discovery/googleapis/homegraph__v1.json index 55e51c8..7ed112f 100644 --- a/discovery/googleapis/homegraph__v1.json +++ b/discovery/googleapis/homegraph__v1.json
@@ -209,7 +209,7 @@ } } }, - "revision": "20201002", + "revision": "20210122", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { @@ -239,7 +239,7 @@ "type": "object" }, "Device": { - "description": "Third-party device definition.", + "description": "Third-party device definition. Next ID = 14", "id": "Device", "properties": { "attributes": { @@ -255,7 +255,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/query) and [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/execute) intent.", + "description": "Custom device attributes stored in Home Graph and provided to your smart home Action in each [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/query) and [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/execute) intent. Data in this object has a few constraints: No sensitive information, including but not limited to Personally Identifiable Information.", "type": "object" }, "deviceInfo": { @@ -270,6 +270,13 @@ "$ref": "DeviceNames", "description": "Names given to this device by your smart home Action." }, + "nonLocalTraits": { + "description": "See description for \"traits\". For Smart Home Entertainment Devices (SHED) devices, some traits can only be executed on 3P cloud, e.g. \"non_local_traits\": [ { \"trait\": \"action.devices.traits.MediaInitiation\" }, { \"trait\": \"action.devices.traits.Channel\" } ] go/shed-per-trait-routing.", + "items": { + "$ref": "NonLocalTrait" + }, + "type": "array" + }, "notificationSupportedByAgent": { "description": "Indicates whether your smart home Action will report notifications to Google for this device via ReportStateAndNotification. If your smart home Action enables users to control device notifications, you should update this field and call RequestSyncDevices.", "type": "boolean" @@ -361,6 +368,17 @@ "properties": {}, "type": "object" }, + "NonLocalTrait": { + "description": "LINT.IfChange go/shed-per-trait-routing. Making it object to allow for extendible design, where we can add attributes in future.", + "id": "NonLocalTrait", + "properties": { + "trait": { + "description": "Trait name, e.g., \"action.devices.traits.MediaInitiation\". See [device traits](https://developers.google.com/assistant/smarthome/traits).", + "type": "string" + } + }, + "type": "object" + }, "QueryRequest": { "description": "Request type for the [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call.", "id": "QueryRequest",
diff --git a/discovery/googleapis/iam__v1.json b/discovery/googleapis/iam__v1.json index ec44788..e882773 100644 --- a/discovery/googleapis/iam__v1.json +++ b/discovery/googleapis/iam__v1.json
@@ -11,8 +11,8 @@ "basePath": "", "baseUrl": "https://iam.googleapis.com/", "batchPath": "batch", - "canonicalName": "iam", - "description": " Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. *Note:* This API is tied to the IAM service account credentials API ( iamcredentials.googleapis.com). Enabling or disabling this API will also enable or disable the IAM service account credentials API. ", + "canonicalName": "Iam", + "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/", "icons": { @@ -366,6 +366,74 @@ }, "projects": { "resources": { + "locations": { + "resources": { + "workloadIdentityPools": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "providers": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.providers.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/providers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, "roles": { "methods": { "create": { @@ -1211,7 +1279,7 @@ } } }, - "revision": "20201001", + "revision": "20210106", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AdminAuditData": { @@ -1299,10 +1367,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -1595,6 +1659,41 @@ }, "type": "object" }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, "PatchServiceAccountRequest": { "description": "The request for PatchServiceAccount. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response.", "id": "PatchServiceAccountRequest", @@ -1952,7 +2051,7 @@ "type": "object" }, "ServiceAccountKey": { - "description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. We recommend caching the public key set for a service account for no more than 24 hours to ensure you have access to the latest keys. Public keys for all service accounts are also published at the OAuth2 Service Account API.", + "description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.", "id": "ServiceAccountKey", "properties": { "keyAlgorithm": { @@ -2108,6 +2207,33 @@ }, "type": "object" }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest",
diff --git a/discovery/googleapis/iamcredentials__v1.json b/discovery/googleapis/iamcredentials__v1.json index d434d3e..b68ea08 100644 --- a/discovery/googleapis/iamcredentials__v1.json +++ b/discovery/googleapis/iamcredentials__v1.json
@@ -12,7 +12,7 @@ "baseUrl": "https://iamcredentials.googleapis.com/", "batchPath": "batch", "canonicalName": "IAM Credentials", - "description": " Creates short-lived credentials for impersonating IAM service accounts. *Note:* This API is tied to the IAM API (iam.googleapis.com). Enabling or disabling this API will also enable or disable the IAM API. ", + "description": "Creates short-lived credentials for impersonating IAM service accounts. To enable this API, you must enable the IAM API (iam.googleapis.com). ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials", "icons": { @@ -220,7 +220,7 @@ } } }, - "revision": "20201002", + "revision": "20210122", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": {
diff --git a/discovery/googleapis/iap__v1.json b/discovery/googleapis/iap__v1.json index dd28b97..0ed41d8 100644 --- a/discovery/googleapis/iap__v1.json +++ b/discovery/googleapis/iap__v1.json
@@ -472,7 +472,7 @@ } } }, - "revision": "20200921", + "revision": "20210122", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { @@ -532,10 +532,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -747,10 +743,6 @@ "description": "Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.", "id": "OAuthSettings", "properties": { - "clientId": { - "description": "OAuth 2.0 client ID used in the OAuth flow to generate an access token. If this field is set, you can skip obtaining the OAuth credentials in this step: https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console. However, this could allow for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.", - "type": "string" - }, "loginHint": { "description": "Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.", "type": "string"
diff --git a/discovery/googleapis/indexing__v3.json b/discovery/googleapis/indexing__v3.json index b282e69..5a39a98 100644 --- a/discovery/googleapis/indexing__v3.json +++ b/discovery/googleapis/indexing__v3.json
@@ -145,7 +145,7 @@ } } }, - "revision": "20201006", + "revision": "20210126", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": {
diff --git a/discovery/googleapis/jobs__v2.json b/discovery/googleapis/jobs__v2.json deleted file mode 100644 index 50d5004..0000000 --- a/discovery/googleapis/jobs__v2.json +++ /dev/null
@@ -1,4154 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/jobs": { - "description": "Manage job postings" - } - } - } - }, - "basePath": "", - "baseUrl": "https://jobs.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud Talent Solution", - "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. ", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "jobs:v2", - "kind": "discovery#restDescription", - "name": "jobs", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "companies": { - "methods": { - "create": { - "description": "Creates a new company entity.", - "httpMethod": "POST", - "id": "jobs.companies.create", - "parameterOrder": [], - "parameters": {}, - "path": "v2/companies", - "request": { - "$ref": "Company" - }, - "response": { - "$ref": "Company" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "delete": { - "description": "Deletes the specified company.", - "httpMethod": "DELETE", - "id": "jobs.companies.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the company to be deleted, such as, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", - "location": "path", - "pattern": "^companies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "get": { - "description": "Retrieves the specified company.", - "httpMethod": "GET", - "id": "jobs.companies.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Resource name of the company to retrieve, such as \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", - "location": "path", - "pattern": "^companies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2/{+name}", - "response": { - "$ref": "Company" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "list": { - "description": "Lists all companies associated with a Cloud Talent Solution account.", - "httpMethod": "GET", - "id": "jobs.companies.list", - "parameterOrder": [], - "parameters": { - "mustHaveOpenJobs": { - "description": "Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.", - "location": "query", - "type": "boolean" - }, - "pageSize": { - "description": "Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The starting indicator from which to return results.", - "location": "query", - "type": "string" - } - }, - "path": "v2/companies", - "response": { - "$ref": "ListCompaniesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "patch": { - "description": "Updates the specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.", - "httpMethod": "PATCH", - "id": "jobs.companies.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", - "location": "path", - "pattern": "^companies/[^/]+$", - "required": true, - "type": "string" - }, - "updateCompanyFields": { - "description": "Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated)", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2/{+name}", - "request": { - "$ref": "Company" - }, - "response": { - "$ref": "Company" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - } - }, - "resources": { - "jobs": { - "methods": { - "list": { - "description": "Deprecated. Use ListJobs instead. Lists all jobs associated with a company.", - "httpMethod": "GET", - "id": "jobs.companies.jobs.list", - "parameterOrder": [ - "companyName" - ], - "parameters": { - "companyName": { - "description": "Required. The resource name of the company that owns the jobs to be listed, such as, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", - "location": "path", - "pattern": "^companies/[^/]+$", - "required": true, - "type": "string" - }, - "idsOnly": { - "description": "Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false.", - "location": "query", - "type": "boolean" - }, - "includeJobsCount": { - "description": "Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false.", - "location": "query", - "type": "boolean" - }, - "jobRequisitionId": { - "description": "Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The starting point of a query result.", - "location": "query", - "type": "string" - } - }, - "path": "v2/{+companyName}/jobs", - "response": { - "$ref": "ListCompanyJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - } - } - } - } - }, - "jobs": { - "methods": { - "batchDelete": { - "description": "Deletes a list of Job postings by filter.", - "httpMethod": "POST", - "id": "jobs.jobs.batchDelete", - "parameterOrder": [], - "parameters": {}, - "path": "v2/jobs:batchDelete", - "request": { - "$ref": "BatchDeleteJobsRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "create": { - "description": "Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.", - "httpMethod": "POST", - "id": "jobs.jobs.create", - "parameterOrder": [], - "parameters": {}, - "path": "v2/jobs", - "request": { - "$ref": "CreateJobRequest" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "delete": { - "description": "Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.", - "httpMethod": "DELETE", - "id": "jobs.jobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "disableFastProcess": { - "description": "Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The resource name of the job to be deleted, such as \"jobs/11111111\".", - "location": "path", - "pattern": "^jobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "deleteByFilter": { - "description": "Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned.", - "httpMethod": "POST", - "id": "jobs.jobs.deleteByFilter", - "parameterOrder": [], - "parameters": {}, - "path": "v2/jobs:deleteByFilter", - "request": { - "$ref": "DeleteJobsByFilterRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "get": { - "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.", - "httpMethod": "GET", - "id": "jobs.jobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the job to retrieve, such as \"jobs/11111111\".", - "location": "path", - "pattern": "^jobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2/{+name}", - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "histogram": { - "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state.", - "httpMethod": "POST", - "id": "jobs.jobs.histogram", - "parameterOrder": [], - "parameters": {}, - "path": "v2/jobs:histogram", - "request": { - "$ref": "GetHistogramRequest" - }, - "response": { - "$ref": "GetHistogramResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "list": { - "description": "Lists jobs by filter.", - "httpMethod": "GET", - "id": "jobs.jobs.list", - "parameterOrder": [], - "parameters": { - "filter": { - "description": "Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = \"companies/123\" * companyName = \"companies/123\" AND requisitionId = \"req-1\"", - "location": "query", - "type": "string" - }, - "idsOnly": { - "description": "Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false.", - "location": "query", - "type": "boolean" - }, - "pageSize": { - "description": "Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The starting point of a query result.", - "location": "query", - "type": "string" - } - }, - "path": "v2/jobs", - "response": { - "$ref": "ListJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "patch": { - "description": "Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.", - "httpMethod": "PATCH", - "id": "jobs.jobs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required during job update. Resource name assigned to a job by the API, for example, \"/jobs/foo\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", - "location": "path", - "pattern": "^jobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2/{+name}", - "request": { - "$ref": "UpdateJobRequest" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "search": { - "description": "Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.", - "httpMethod": "POST", - "id": "jobs.jobs.search", - "parameterOrder": [], - "parameters": {}, - "path": "v2/jobs:search", - "request": { - "$ref": "SearchJobsRequest" - }, - "response": { - "$ref": "SearchJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - }, - "searchForAlert": { - "description": "Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.", - "httpMethod": "POST", - "id": "jobs.jobs.searchForAlert", - "parameterOrder": [], - "parameters": {}, - "path": "v2/jobs:searchForAlert", - "request": { - "$ref": "SearchJobsRequest" - }, - "response": { - "$ref": "SearchJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - } - } - }, - "v2": { - "methods": { - "complete": { - "description": "Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.", - "httpMethod": "GET", - "id": "jobs.complete", - "parameterOrder": [], - "parameters": { - "companyName": { - "description": "Optional. If provided, restricts completion to the specified company.", - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Required. The language of the query. This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Required. Completion result count. The maximum allowed page size is 10.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "query": { - "description": "Required. The query used to generate suggestions.", - "location": "query", - "type": "string" - }, - "scope": { - "description": "Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.", - "enum": [ - "COMPLETION_SCOPE_UNSPECIFIED", - "TENANT", - "PUBLIC" - ], - "enumDescriptions": [ - "Default value.", - "Suggestions are based only on the data provided by the client.", - "Suggestions are based on all jobs data in the system that's visible to the client" - ], - "location": "query", - "type": "string" - }, - "type": { - "description": "Optional. The completion topic. The default is CompletionType.COMBINED.", - "enum": [ - "COMPLETION_TYPE_UNSPECIFIED", - "JOB_TITLE", - "COMPANY_NAME", - "COMBINED" - ], - "enumDescriptions": [ - "Default value.", - "Only suggest job titles.", - "Only suggest company names.", - "Suggest both job titles and company names." - ], - "location": "query", - "type": "string" - } - }, - "path": "v2:complete", - "response": { - "$ref": "CompleteQueryResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/jobs" - ] - } - } - } - }, - "revision": "20200929", - "rootUrl": "https://jobs.googleapis.com/", - "schemas": { - "BatchDeleteJobsRequest": { - "description": "Input only. Batch delete jobs request.", - "id": "BatchDeleteJobsRequest", - "properties": { - "filter": { - "description": "Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = \"companies/123\" AND requisitionId = \"req-1\"", - "type": "string" - } - }, - "type": "object" - }, - "BucketRange": { - "description": "Represents starting and ending value of a range in double.", - "id": "BucketRange", - "properties": { - "from": { - "description": "Starting value of the bucket range.", - "format": "double", - "type": "number" - }, - "to": { - "description": "Ending value of the bucket range.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "BucketizedCount": { - "description": "Represents count of jobs within one bucket.", - "id": "BucketizedCount", - "properties": { - "count": { - "description": "Number of jobs whose numeric field value fall into `range`.", - "format": "int32", - "type": "integer" - }, - "range": { - "$ref": "BucketRange", - "description": "Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range." - } - }, - "type": "object" - }, - "CommuteInfo": { - "description": "Output only. Commute details related to this job.", - "id": "CommuteInfo", - "properties": { - "jobLocation": { - "$ref": "JobLocation", - "description": "Location used as the destination in the commute calculation." - }, - "travelDuration": { - "description": "The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "CommutePreference": { - "description": "Input only. Parameters needed for commute search.", - "id": "CommutePreference", - "properties": { - "allowNonStreetLevelAddress": { - "description": "Optional. If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or is not specified, only jobs that include street level addresses will be returned by commute search.", - "type": "boolean" - }, - "departureHourLocal": { - "description": "Optional. The departure hour to use to calculate traffic impact. Accepts an integer between 0 and 23, representing the hour in the time zone of the start_location. Must not be present if road_traffic is specified.", - "format": "int32", - "type": "integer" - }, - "method": { - "description": "Required. The method of transportation for which to calculate the commute time.", - "enum": [ - "COMMUTE_METHOD_UNSPECIFIED", - "DRIVING", - "TRANSIT" - ], - "enumDescriptions": [ - "Commute method is not specified.", - "Commute time is calculated based on driving time.", - "Commute time is calculated based on public transit including bus, metro, subway, etc." - ], - "type": "string" - }, - "roadTraffic": { - "description": "Optional. Specifies the traffic density to use when calculating commute time. Must not be present if departure_hour_local is specified.", - "enum": [ - "ROAD_TRAFFIC_UNSPECIFIED", - "TRAFFIC_FREE", - "BUSY_HOUR" - ], - "enumDescriptions": [ - "Road traffic situation is not specified.", - "Optimal commute time without considering any traffic impact.", - "Commute time calculation takes in account the peak traffic impact." - ], - "type": "string" - }, - "startLocation": { - "$ref": "LatLng", - "description": "Required. The latitude and longitude of the location from which to calculate the commute time." - }, - "travelTime": { - "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "Company": { - "description": "A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position.", - "id": "Company", - "properties": { - "careerPageLink": { - "description": "Optional. The URL to employer's career site or careers page on the employer's web site.", - "type": "string" - }, - "companyInfoSources": { - "description": "Optional. Identifiers external to the application that help to further identify the employer.", - "items": { - "$ref": "CompanyInfoSource" - }, - "type": "array" - }, - "companySize": { - "description": "Optional. The employer's company size.", - "enum": [ - "COMPANY_SIZE_UNSPECIFIED", - "MINI", - "SMALL", - "SMEDIUM", - "MEDIUM", - "BIG", - "BIGGER", - "GIANT" - ], - "enumDescriptions": [ - "Default value if the size is not specified.", - "The company has less than 50 employees.", - "The company has between 50 and 99 employees.", - "The company has between 100 and 499 employees.", - "The company has between 500 and 999 employees.", - "The company has between 1,000 and 4,999 employees.", - "The company has between 5,000 and 9,999 employees.", - "The company has 10,000 or more employees." - ], - "type": "string" - }, - "disableLocationOptimization": { - "description": "Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored.", - "type": "boolean" - }, - "displayName": { - "description": "Required. The name of the employer to be displayed with the job, for example, \"Google, LLC.\".", - "type": "string" - }, - "distributorBillingCompanyId": { - "description": "Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided.", - "type": "string" - }, - "distributorCompanyId": { - "description": "Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as \"Alphabet\" and \"Google\", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255.", - "type": "string" - }, - "eeoText": { - "description": "Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.", - "type": "string" - }, - "hiringAgency": { - "description": "Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.", - "type": "boolean" - }, - "hqLocation": { - "description": "Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in structured_company_hq_location.", - "type": "string" - }, - "imageUrl": { - "description": "Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted.", - "type": "string" - }, - "keywordSearchableCustomAttributes": { - "description": "Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes.", - "items": { - "type": "string" - }, - "type": "array" - }, - "keywordSearchableCustomFields": { - "description": "Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "name": { - "description": "Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, \"companies/0000aaaa-1111-bbbb-2222-cccc3333dddd\".", - "type": "string" - }, - "structuredCompanyHqLocation": { - "$ref": "JobLocation", - "description": "Output only. A structured headquarters location of the company, resolved from hq_location if possible." - }, - "suspended": { - "description": "Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.", - "type": "boolean" - }, - "title": { - "description": "Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, \"Google, LLC.\".", - "type": "string" - }, - "website": { - "description": "Optional. The URL representing the company's primary web site or home page, such as, \"www.google.com\".", - "type": "string" - } - }, - "type": "object" - }, - "CompanyInfoSource": { - "description": "A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`.", - "id": "CompanyInfoSource", - "properties": { - "freebaseMid": { - "description": "Optional. The Google's Knowledge Graph value for the employer's company.", - "type": "string" - }, - "gplusId": { - "description": "Optional. The numeric identifier for the employer's Google+ business page.", - "type": "string" - }, - "mapsCid": { - "description": "Optional. The numeric identifier for the employer's headquarters on Google Maps, namely, the Google Maps CID (cell id).", - "type": "string" - }, - "unknownTypeId": { - "description": "Optional. A Google identifier that does not match any of the other types.", - "type": "string" - } - }, - "type": "object" - }, - "CompensationEntry": { - "description": "A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", - "id": "CompensationEntry", - "properties": { - "amount": { - "$ref": "Money", - "description": "Optional. Compensation amount." - }, - "description": { - "description": "Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", - "type": "string" - }, - "expectedUnitsPerYear": { - "description": "Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", - "format": "double", - "type": "number" - }, - "range": { - "$ref": "CompensationRange", - "description": "Optional. Compensation range." - }, - "type": { - "description": "Required. Compensation type.", - "enum": [ - "COMPENSATION_TYPE_UNSPECIFIED", - "BASE", - "BONUS", - "SIGNING_BONUS", - "EQUITY", - "PROFIT_SHARING", - "COMMISSIONS", - "TIPS", - "OTHER_COMPENSATION_TYPE" - ], - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_TYPE.", - "Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.", - "Bonus.", - "Signing bonus.", - "Equity.", - "Profit sharing.", - "Commission.", - "Tips.", - "Other compensation type." - ], - "type": "string" - }, - "unit": { - "description": "Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", - "enum": [ - "COMPENSATION_UNIT_UNSPECIFIED", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY", - "YEARLY", - "ONE_TIME", - "OTHER_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], - "type": "string" - } - }, - "type": "object" - }, - "CompensationFilter": { - "description": "Input only. Filter on job compensation type and amount.", - "id": "CompensationFilter", - "properties": { - "includeJobsWithUnspecifiedCompensationRange": { - "description": "Optional. Whether to include jobs whose compensation range is unspecified.", - "type": "boolean" - }, - "range": { - "$ref": "CompensationRange", - "description": "Optional. Compensation range." - }, - "type": { - "description": "Required. Type of filter.", - "enum": [ - "FILTER_TYPE_UNSPECIFIED", - "UNIT_ONLY", - "UNIT_AND_AMOUNT", - "ANNUALIZED_BASE_AMOUNT", - "ANNUALIZED_TOTAL_AMOUNT" - ], - "enumDescriptions": [ - "Filter type unspecified. Position holder, INVALID, should never be used.", - "Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided units. Populate one or more units. See CompensationInfo.CompensationEntry for definition of base compensation entry.", - "Filter by `base compensation entry's` unit and amount / range. A job is a match if and only if the job contains a base CompensationEntry, and the base entry's unit matches provided compensation_units and amount or range overlaps with provided compensation_range. See CompensationInfo.CompensationEntry for definition of base compensation entry. Set exactly one units and populate range.", - "Filter by annualized base compensation amount and `base compensation entry's` unit. Populate range and zero or more units.", - "Filter by annualized total compensation amount and `base compensation entry's` unit . Populate range and zero or more units." - ], - "type": "string" - }, - "units": { - "description": "Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.", - "items": { - "enum": [ - "COMPENSATION_UNIT_UNSPECIFIED", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY", - "YEARLY", - "ONE_TIME", - "OTHER_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CompensationHistogramRequest": { - "description": "Input only. Compensation based histogram request.", - "id": "CompensationHistogramRequest", - "properties": { - "bucketingOption": { - "$ref": "NumericBucketingOption", - "description": "Required. Numeric histogram options, like buckets, whether include min or max value." - }, - "type": { - "description": "Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`.", - "enum": [ - "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", - "BASE", - "ANNUALIZED_BASE", - "ANNUALIZED_TOTAL" - ], - "enumDescriptions": [ - "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." - ], - "type": "string" - } - }, - "type": "object" - }, - "CompensationHistogramResult": { - "description": "Output only. Compensation based histogram result.", - "id": "CompensationHistogramResult", - "properties": { - "result": { - "$ref": "NumericBucketingResult", - "description": "Histogram result." - }, - "type": { - "description": "Type of the request, corresponding to CompensationHistogramRequest.type.", - "enum": [ - "COMPENSATION_HISTOGRAM_REQUEST_TYPE_UNSPECIFIED", - "BASE", - "ANNUALIZED_BASE", - "ANNUALIZED_TOTAL" - ], - "enumDescriptions": [ - "Default value. Invalid.", - "Histogram by job's base compensation. See CompensationEntry for definition of base compensation.", - "Histogram by job's annualized base compensation. See CompensationEntry for definition of annualized base compensation.", - "Histogram by job's annualized total compensation. See CompensationEntry for definition of annualized total compensation." - ], - "type": "string" - } - }, - "type": "object" - }, - "CompensationInfo": { - "description": "Job compensation details.", - "id": "CompensationInfo", - "properties": { - "amount": { - "$ref": "Money", - "description": "Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation." - }, - "annualizedBaseCompensationRange": { - "$ref": "CompensationRange", - "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." - }, - "annualizedTotalCompensationRange": { - "$ref": "CompensationRange", - "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization." - }, - "entries": { - "description": "Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.", - "items": { - "$ref": "CompensationEntry" - }, - "type": "array" - }, - "max": { - "$ref": "Money", - "description": "Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount." - }, - "min": { - "$ref": "Money", - "description": "Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount." - }, - "type": { - "description": "Deprecated. Use entries instead. Optional. Type of job compensation.", - "enum": [ - "JOB_COMPENSATION_TYPE_UNSPECIFIED", - "HOURLY", - "SALARY", - "PER_PROJECT", - "COMMISSION", - "OTHER_TYPE" - ], - "enumDescriptions": [ - "The default value if the type is not specified.", - "The job compensation is quoted by the number of hours worked.", - "The job compensation is quoted on an annual basis.", - "The job compensation is quoted by project completion.", - "The job compensation is quoted based solely on commission.", - "The job compensation is not quoted according to the listed compensation options." - ], - "type": "string" - } - }, - "type": "object" - }, - "CompensationRange": { - "description": "Compensation range.", - "id": "CompensationRange", - "properties": { - "max": { - "$ref": "Money", - "description": "Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation." - }, - "min": { - "$ref": "Money", - "description": "Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation." - } - }, - "type": "object" - }, - "CompleteQueryResponse": { - "description": "Output only. Response of auto-complete query.", - "id": "CompleteQueryResponse", - "properties": { - "completionResults": { - "description": "Results of the matching job/company candidates.", - "items": { - "$ref": "CompletionResult" - }, - "type": "array" - }, - "metadata": { - "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request tracking id." - } - }, - "type": "object" - }, - "CompletionResult": { - "description": "Output only. Resource that represents completion results.", - "id": "CompletionResult", - "properties": { - "imageUrl": { - "description": "The URL for the company logo if `type=COMPANY_NAME`.", - "type": "string" - }, - "suggestion": { - "description": "The suggestion for the query.", - "type": "string" - }, - "type": { - "description": "The completion topic.", - "enum": [ - "COMPLETION_TYPE_UNSPECIFIED", - "JOB_TITLE", - "COMPANY_NAME", - "COMBINED" - ], - "enumDescriptions": [ - "Default value.", - "Only suggest job titles.", - "Only suggest company names.", - "Suggest both job titles and company names." - ], - "type": "string" - } - }, - "type": "object" - }, - "CreateJobRequest": { - "description": "Input only. Create job request.", - "id": "CreateJobRequest", - "properties": { - "disableStreetAddressResolution": { - "description": "Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.", - "type": "boolean" - }, - "job": { - "$ref": "Job", - "description": "Required. The Job to be created." - }, - "processingOptions": { - "$ref": "JobProcessingOptions", - "description": "Optional. Options for job processing." - } - }, - "type": "object" - }, - "CustomAttribute": { - "description": "Custom attribute values that are either filterable or non-filterable.", - "id": "CustomAttribute", - "properties": { - "filterable": { - "description": "Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false.", - "type": "boolean" - }, - "longValue": { - "description": "Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed.", - "format": "int64", - "type": "string" - }, - "stringValues": { - "$ref": "StringValues", - "description": "Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed." - } - }, - "type": "object" - }, - "CustomAttributeHistogramRequest": { - "description": "Custom attributes histogram request. An error will be thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.", - "id": "CustomAttributeHistogramRequest", - "properties": { - "key": { - "description": "Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values.", - "type": "string" - }, - "longValueHistogramBucketingOption": { - "$ref": "NumericBucketingOption", - "description": "Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements." - }, - "stringValueHistogram": { - "description": "Optional. If set to true, the response will include the histogram value for each key as a string.", - "type": "boolean" - } - }, - "type": "object" - }, - "CustomAttributeHistogramResult": { - "description": "Output only. Custom attribute histogram result.", - "id": "CustomAttributeHistogramResult", - "properties": { - "key": { - "description": "Stores the key of custom attribute the histogram is performed on.", - "type": "string" - }, - "longValueHistogramResult": { - "$ref": "NumericBucketingResult", - "description": "Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`." - }, - "stringValueHistogramResult": { - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "description": "Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result.", - "type": "object" - } - }, - "type": "object" - }, - "CustomField": { - "description": "Resource that represents the custom data not captured by the standard fields.", - "id": "CustomField", - "properties": { - "values": { - "description": "Optional. The values of the custom data.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CustomFieldFilter": { - "description": "Input only. Custom field filter of the search.", - "id": "CustomFieldFilter", - "properties": { - "queries": { - "description": "Required. The query strings for the filter.", - "items": { - "type": "string" - }, - "type": "array" - }, - "type": { - "description": "Optional. The type of filter. Defaults to FilterType.OR.", - "enum": [ - "FILTER_TYPE_UNSPECIFIED", - "OR", - "AND", - "NOT" - ], - "enumDescriptions": [ - "Default value.", - "Search for a match with any query.", - "Search for a match with all queries.", - "Negate the set of filter values for the search." - ], - "type": "string" - } - }, - "type": "object" - }, - "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", - "id": "Date", - "properties": { - "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", - "format": "int32", - "type": "integer" - }, - "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", - "format": "int32", - "type": "integer" - }, - "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DeleteJobsByFilterRequest": { - "description": "Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes.", - "id": "DeleteJobsByFilterRequest", - "properties": { - "disableFastProcess": { - "description": "Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.", - "type": "boolean" - }, - "filter": { - "$ref": "Filter", - "description": "Required. Restrictions on the scope of the delete request." - } - }, - "type": "object" - }, - "DeviceInfo": { - "description": "Input only. Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.", - "id": "DeviceInfo", - "properties": { - "deviceType": { - "description": "Optional. Type of the device.", - "enum": [ - "DEVICE_TYPE_UNSPECIFIED", - "WEB", - "MOBILE_WEB", - "ANDROID", - "IOS", - "BOT", - "OTHER" - ], - "enumDescriptions": [ - "The device type isn't specified.", - "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)", - "A mobile device web browser, such as a phone or tablet with a Chrome browser.", - "An Android device native application.", - "An iOS device native application.", - "A bot, as opposed to a device operated by human beings, such as a web crawler.", - "Other devices types." - ], - "type": "string" - }, - "id": { - "description": "Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.", - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "ExtendedCompensationFilter": { - "description": "Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount.", - "id": "ExtendedCompensationFilter", - "properties": { - "compensationRange": { - "$ref": "ExtendedCompensationInfoCompensationRange", - "description": "Optional. Compensation range." - }, - "compensationUnits": { - "description": "Required. Specify desired `base compensation entry's` ExtendedCompensationInfo.CompensationUnit.", - "items": { - "enum": [ - "EXTENDED_COMPENSATION_UNIT_UNSPECIFIED", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY", - "YEARLY", - "ONE_TIME", - "OTHER_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], - "type": "string" - }, - "type": "array" - }, - "currency": { - "description": "Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If unspecified, jobs are returned regardless of currency.", - "type": "string" - }, - "includeJobWithUnspecifiedCompensationRange": { - "description": "Optional. Whether to include jobs whose compensation range is unspecified.", - "type": "boolean" - }, - "type": { - "description": "Required. Type of filter.", - "enum": [ - "FILTER_TYPE_UNSPECIFIED", - "UNIT_ONLY", - "UNIT_AND_AMOUNT", - "ANNUALIZED_BASE_AMOUNT", - "ANNUALIZED_TOTAL_AMOUNT" - ], - "enumDescriptions": [ - "Filter type unspecified. Position holder, INVALID, should never be used.", - "Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided compensation_units. Populate one or more compensation_units. See ExtendedCompensationInfo.CompensationEntry for definition of base compensation entry.", - "Filter by `base compensation entry's` unit and amount / range. A job is a match if and only if the job contains a base CompensationEntry, and the base entry's unit matches provided compensation_units and amount or range overlaps with provided compensation_range. See ExtendedCompensationInfo.CompensationEntry for definition of base compensation entry. Set exactly one compensation_units and populate compensation_range.", - "Filter by annualized base compensation amount and `base compensation entry's` unit. Populate compensation_range and zero or more compensation_units.", - "Filter by annualized total compensation amount and `base compensation entry's` unit . Populate compensation_range and zero or more compensation_units." - ], - "type": "string" - } - }, - "type": "object" - }, - "ExtendedCompensationInfo": { - "description": "Deprecated. Use CompensationInfo. Describes job compensation.", - "id": "ExtendedCompensationInfo", - "properties": { - "annualizedBaseCompensationRange": { - "$ref": "ExtendedCompensationInfoCompensationRange", - "description": "Output only. Annualized base compensation range." - }, - "annualizedBaseCompensationUnspecified": { - "description": "Output only. Indicates annualized base compensation range cannot be derived, due to the job's base compensation entry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.", - "type": "boolean" - }, - "annualizedTotalCompensationRange": { - "$ref": "ExtendedCompensationInfoCompensationRange", - "description": "Output only. Annualized total compensation range." - }, - "annualizedTotalCompensationUnspecified": { - "description": "Output only. Indicates annualized total compensation range cannot be derived, due to the job's all CompensationEntry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.", - "type": "boolean" - }, - "currency": { - "description": "Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.", - "type": "string" - }, - "entries": { - "description": "Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.", - "items": { - "$ref": "ExtendedCompensationInfoCompensationEntry" - }, - "type": "array" - } - }, - "type": "object" - }, - "ExtendedCompensationInfoCompensationEntry": { - "description": "Deprecated. See CompensationInfo. A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", - "id": "ExtendedCompensationInfoCompensationEntry", - "properties": { - "amount": { - "$ref": "ExtendedCompensationInfoDecimal", - "description": "Optional. Monetary amount." - }, - "description": { - "description": "Optional. Compensation description.", - "type": "string" - }, - "expectedUnitsPerYear": { - "$ref": "ExtendedCompensationInfoDecimal", - "description": "Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1" - }, - "range": { - "$ref": "ExtendedCompensationInfoCompensationRange", - "description": "Optional. Compensation range." - }, - "type": { - "description": "Required. Compensation type.", - "enum": [ - "EXTENDED_COMPENSATION_TYPE_UNSPECIFIED", - "BASE", - "BONUS", - "SIGNING_BONUS", - "EQUITY", - "PROFIT_SHARING", - "COMMISSIONS", - "TIPS", - "OTHER_COMPENSATION_TYPE" - ], - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_TYPE.", - "Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.", - "Bonus.", - "Signing bonus.", - "Equity.", - "Profit sharing.", - "Commission.", - "Tips.", - "Other compensation type." - ], - "type": "string" - }, - "unit": { - "description": "Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", - "enum": [ - "EXTENDED_COMPENSATION_UNIT_UNSPECIFIED", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY", - "YEARLY", - "ONE_TIME", - "OTHER_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "Default value. Equivalent to OTHER_COMPENSATION_UNIT.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], - "type": "string" - }, - "unspecified": { - "description": "Optional. Indicates compensation amount and range are unset.", - "type": "boolean" - } - }, - "type": "object" - }, - "ExtendedCompensationInfoCompensationRange": { - "description": "Deprecated. See CompensationInfo. Compensation range.", - "id": "ExtendedCompensationInfoCompensationRange", - "properties": { - "max": { - "$ref": "ExtendedCompensationInfoDecimal", - "description": "Required. Maximum value." - }, - "min": { - "$ref": "ExtendedCompensationInfoDecimal", - "description": "Required. Minimum value." - } - }, - "type": "object" - }, - "ExtendedCompensationInfoDecimal": { - "description": "Deprecated. See CompensationInfo. Decimal number.", - "id": "ExtendedCompensationInfoDecimal", - "properties": { - "micros": { - "description": "Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. If `units` is positive, `micros` must be positive or zero. If `units` is zero, `micros` can be positive, zero, or negative. If `units` is negative, `micros` must be negative or zero. For example -1.75 is represented as `units`=-1 and `micros`=-750,000.", - "format": "int32", - "type": "integer" - }, - "units": { - "description": "Whole units.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "Filter": { - "description": "Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted.", - "id": "Filter", - "properties": { - "requisitionId": { - "description": "Required. The requisition ID (or posting ID) assigned by the client to identify a job. This is intended for client identification and tracking of listings. name takes precedence over this field The maximum number of allowed characters is 225.", - "type": "string" - } - }, - "type": "object" - }, - "GetHistogramRequest": { - "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method.", - "id": "GetHistogramRequest", - "properties": { - "allowBroadening": { - "description": "Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false.", - "type": "boolean" - }, - "filters": { - "$ref": "JobFilters", - "description": "Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram." - }, - "query": { - "$ref": "JobQuery", - "description": "Optional. Query used to search against jobs, such as keyword, location filters, etc." - }, - "requestMetadata": { - "$ref": "RequestMetadata", - "description": "Meta information, such as `user_id`, collected from the job searcher or other entity conducting a job search, is used to improve the service's search quality. Users determine identifier values, which must be unique and consist." - }, - "searchTypes": { - "description": "Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution.", - "items": { - "enum": [ - "JOB_FIELD_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "CUSTOM_FIELD_1", - "CUSTOM_FIELD_2", - "CUSTOM_FIELD_3", - "CUSTOM_FIELD_4", - "CUSTOM_FIELD_5", - "CUSTOM_FIELD_6", - "CUSTOM_FIELD_7", - "CUSTOM_FIELD_8", - "CUSTOM_FIELD_9", - "CUSTOM_FIELD_10", - "CUSTOM_FIELD_11", - "CUSTOM_FIELD_12", - "CUSTOM_FIELD_13", - "CUSTOM_FIELD_14", - "CUSTOM_FIELD_15", - "CUSTOM_FIELD_16", - "CUSTOM_FIELD_17", - "CUSTOM_FIELD_18", - "CUSTOM_FIELD_19", - "CUSTOM_FIELD_20", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN1_COUNTRY", - "COMPANY_TITLE", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Values are stringified with TimeRange, for example, TimeRange.PAST_MONTH.", - "Filter by custom field 1.", - "Filter by custom field 2.", - "Filter by custom field 3.", - "Filter by custom field 4.", - "Filter by custom field 5.", - "Filter by custom field 6.", - "Filter by custom field 7.", - "Filter by custom field 8.", - "Filter by custom field 9.", - "Filter by custom field 10.", - "Filter by custom field 11.", - "Filter by custom field 12.", - "Filter by custom field 13.", - "Filter by custom field 14.", - "Filter by custom field 15.", - "Filter by custom field 16.", - "Filter by custom field 17.", - "Filter by custom field 18.", - "Filter by custom field 19.", - "Filter by custom field 20.", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", - "Deprecated. Use COMPANY_DISPLAY_NAME instead. Company display name.", - "Company display name.", - "Base compensation unit." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GetHistogramResponse": { - "description": "Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method.", - "id": "GetHistogramResponse", - "properties": { - "metadata": { - "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request tracking id." - }, - "results": { - "description": "The Histogram results.", - "items": { - "$ref": "HistogramResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4BatchCreateJobsResponse": { - "description": "The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.", - "id": "GoogleCloudTalentV4BatchCreateJobsResponse", - "properties": { - "jobResults": { - "description": "List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", - "items": { - "$ref": "GoogleCloudTalentV4JobResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4BatchDeleteJobsResponse": { - "description": "The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.", - "id": "GoogleCloudTalentV4BatchDeleteJobsResponse", - "properties": { - "jobResults": { - "description": "List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", - "items": { - "$ref": "GoogleCloudTalentV4JobResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4BatchOperationMetadata": { - "description": "Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.", - "id": "GoogleCloudTalentV4BatchOperationMetadata", - "properties": { - "createTime": { - "description": "The time when the batch operation is created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of failed item(s) inside an operation.", - "format": "int32", - "type": "integer" - }, - "state": { - "description": "The state of a long running operation.", - "enum": [ - "STATE_UNSPECIFIED", - "INITIALIZING", - "PROCESSING", - "SUCCEEDED", - "FAILED", - "CANCELLING", - "CANCELLED" - ], - "enumDescriptions": [ - "Default value.", - "The batch operation is being prepared for processing.", - "The batch operation is actively being processed.", - "The batch operation is processed, and at least one item has been successfully processed.", - "The batch operation is done and no item has been successfully processed.", - "The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation is called.", - "The batch operation is done after google.longrunning.Operations.CancelOperation is called. Any items processed before cancelling are returned in the response." - ], - "type": "string" - }, - "stateDescription": { - "description": "More detailed information about operation state.", - "type": "string" - }, - "successCount": { - "description": "Count of successful item(s) inside an operation.", - "format": "int32", - "type": "integer" - }, - "totalCount": { - "description": "Count of total item(s) inside an operation.", - "format": "int32", - "type": "integer" - }, - "updateTime": { - "description": "The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4BatchUpdateJobsResponse": { - "description": "The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.", - "id": "GoogleCloudTalentV4BatchUpdateJobsResponse", - "properties": { - "jobResults": { - "description": "List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", - "items": { - "$ref": "GoogleCloudTalentV4JobResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CompensationInfo": { - "description": "Job compensation details.", - "id": "GoogleCloudTalentV4CompensationInfo", - "properties": { - "annualizedBaseCompensationRange": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", - "readOnly": true - }, - "annualizedTotalCompensationRange": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", - "readOnly": true - }, - "entries": { - "description": "Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.", - "items": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationEntry" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CompensationInfoCompensationEntry": { - "description": "A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", - "id": "GoogleCloudTalentV4CompensationInfoCompensationEntry", - "properties": { - "amount": { - "$ref": "Money", - "description": "Compensation amount." - }, - "description": { - "description": "Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", - "type": "string" - }, - "expectedUnitsPerYear": { - "description": "Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", - "format": "double", - "type": "number" - }, - "range": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "description": "Compensation range." - }, - "type": { - "description": "Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.", - "enum": [ - "COMPENSATION_TYPE_UNSPECIFIED", - "BASE", - "BONUS", - "SIGNING_BONUS", - "EQUITY", - "PROFIT_SHARING", - "COMMISSIONS", - "TIPS", - "OTHER_COMPENSATION_TYPE" - ], - "enumDescriptions": [ - "Default value.", - "Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.", - "Bonus.", - "Signing bonus.", - "Equity.", - "Profit sharing.", - "Commission.", - "Tips.", - "Other compensation type." - ], - "type": "string" - }, - "unit": { - "description": "Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", - "enum": [ - "COMPENSATION_UNIT_UNSPECIFIED", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY", - "YEARLY", - "ONE_TIME", - "OTHER_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "Default value.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CompensationInfoCompensationRange": { - "description": "Compensation range.", - "id": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "properties": { - "maxCompensation": { - "$ref": "Money", - "description": "The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation." - }, - "minCompensation": { - "$ref": "Money", - "description": "The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation." - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CustomAttribute": { - "description": "Custom attribute values that are either filterable or non-filterable.", - "id": "GoogleCloudTalentV4CustomAttribute", - "properties": { - "filterable": { - "description": "If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", - "type": "boolean" - }, - "keywordSearchable": { - "description": "If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.", - "type": "boolean" - }, - "longValues": { - "description": "Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - }, - "stringValues": { - "description": "Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4Job": { - "description": "A Job resource represents a job posting (also referred to as a \"job listing\" or \"job requisition\"). A job belongs to a Company, which is the hiring entity responsible for the job.", - "id": "GoogleCloudTalentV4Job", - "properties": { - "addresses": { - "description": "Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.", - "items": { - "type": "string" - }, - "type": "array" - }, - "applicationInfo": { - "$ref": "GoogleCloudTalentV4JobApplicationInfo", - "description": "Job application information." - }, - "company": { - "description": "Required. The resource name of the company listing the job. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\". For example, \"projects/foo/tenants/bar/companies/baz\".", - "type": "string" - }, - "companyDisplayName": { - "description": "Output only. Display name of the company listing the job.", - "readOnly": true, - "type": "string" - }, - "compensationInfo": { - "$ref": "GoogleCloudTalentV4CompensationInfo", - "description": "Job compensation information (a.k.a. \"pay rate\") i.e., the compensation that will paid to the employee." - }, - "customAttributes": { - "additionalProperties": { - "$ref": "GoogleCloudTalentV4CustomAttribute" - }, - "description": "A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", - "type": "object" - }, - "degreeTypes": { - "description": "The desired education degrees for the job, such as Bachelors, Masters.", - "items": { - "enum": [ - "DEGREE_TYPE_UNSPECIFIED", - "PRIMARY_EDUCATION", - "LOWER_SECONDARY_EDUCATION", - "UPPER_SECONDARY_EDUCATION", - "ADULT_REMEDIAL_EDUCATION", - "ASSOCIATES_OR_EQUIVALENT", - "BACHELORS_OR_EQUIVALENT", - "MASTERS_OR_EQUIVALENT", - "DOCTORAL_OR_EQUIVALENT" - ], - "enumDescriptions": [ - "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", - "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", - "Lower secondary education; First stage of secondary education building on primary education, typically with a more subject-oriented curriculum. ISCED code 2. Ex) Middle school", - "Middle education; Second/final stage of secondary education preparing for tertiary education and/or providing skills relevant to employment. Usually with an increased range of subject options and streams. ISCED code 3. Ex) High school", - "Adult Remedial Education; Programmes providing learning experiences that build on secondary education and prepare for labour market entry and/or tertiary education. The content is broader than secondary but not as complex as tertiary education. ISCED code 4.", - "Associate's or equivalent; Short first tertiary programmes that are typically practically-based, occupationally-specific and prepare for labour market entry. These programmes may also provide a pathway to other tertiary programmes. ISCED code 5.", - "Bachelor's or equivalent; Programmes designed to provide intermediate academic and/or professional knowledge, skills and competencies leading to a first tertiary degree or equivalent qualification. ISCED code 6.", - "Master's or equivalent; Programmes designed to provide advanced academic and/or professional knowledge, skills and competencies leading to a second tertiary degree or equivalent qualification. ISCED code 7.", - "Doctoral or equivalent; Programmes designed primarily to lead to an advanced research qualification, usually concluding with the submission and defense of a substantive dissertation of publishable quality based on original research. ISCED code 8." - ], - "type": "string" - }, - "type": "array" - }, - "department": { - "description": "The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", - "type": "string" - }, - "derivedInfo": { - "$ref": "GoogleCloudTalentV4JobDerivedInfo", - "description": "Output only. Derived details about the job posting.", - "readOnly": true - }, - "description": { - "description": "Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.", - "type": "string" - }, - "employmentTypes": { - "description": "The employment type(s) of a job, for example, full time or part time.", - "items": { - "enum": [ - "EMPLOYMENT_TYPE_UNSPECIFIED", - "FULL_TIME", - "PART_TIME", - "CONTRACTOR", - "CONTRACT_TO_HIRE", - "TEMPORARY", - "INTERN", - "VOLUNTEER", - "PER_DIEM", - "FLY_IN_FLY_OUT", - "OTHER_EMPLOYMENT_TYPE" - ], - "enumDescriptions": [ - "The default value if the employment type isn't specified.", - "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee, position.", - "The job is offered as a contracted position with the understanding that it's converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.", - "The job is offered as a temporary employment opportunity, usually a short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a flexible schedule.", - "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", - "The job does not fit any of the other listed types." - ], - "type": "string" - }, - "type": "array" - }, - "incentives": { - "description": "A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "jobBenefits": { - "description": "The benefits included with the job.", - "items": { - "enum": [ - "JOB_BENEFIT_UNSPECIFIED", - "CHILD_CARE", - "DENTAL", - "DOMESTIC_PARTNER", - "FLEXIBLE_HOURS", - "MEDICAL", - "LIFE_INSURANCE", - "PARENTAL_LEAVE", - "RETIREMENT_PLAN", - "SICK_DAYS", - "VACATION", - "VISION" - ], - "enumDescriptions": [ - "Default value if the type isn't specified.", - "The job includes access to programs that support child care, such as daycare.", - "The job includes dental services covered by a dental insurance plan.", - "The job offers specific benefits to domestic partners.", - "The job allows for a flexible work schedule.", - "The job includes health services covered by a medical insurance plan.", - "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", - "The job allows for a leave of absence to a parent to care for a newborn child.", - "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", - "The job allows for paid time off due to illness.", - "The job includes paid time off for vacation.", - "The job includes vision services covered by a vision insurance plan." - ], - "type": "string" - }, - "type": "array" - }, - "jobEndTime": { - "description": "The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", - "format": "google-datetime", - "type": "string" - }, - "jobLevel": { - "description": "The experience level associated with the job, such as \"Entry Level\".", - "enum": [ - "JOB_LEVEL_UNSPECIFIED", - "ENTRY_LEVEL", - "EXPERIENCED", - "MANAGER", - "DIRECTOR", - "EXECUTIVE" - ], - "enumDescriptions": [ - "The default value if the level isn't specified.", - "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", - "Experienced individual contributors, typically with 2+ years of experience in a similar role.", - "Entry- to mid-level managers responsible for managing a team of people.", - "Senior-level managers responsible for managing teams of managers.", - "Executive-level managers and above, including C-level positions." - ], - "type": "string" - }, - "jobStartTime": { - "description": "The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", - "format": "google-datetime", - "type": "string" - }, - "languageCode": { - "description": "The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", - "type": "string" - }, - "name": { - "description": "Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\". For example, \"projects/foo/tenants/bar/jobs/baz\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", - "type": "string" - }, - "postingCreateTime": { - "description": "Output only. The timestamp when this job posting was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "postingExpireTime": { - "description": "Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.", - "format": "google-datetime", - "type": "string" - }, - "postingPublishTime": { - "description": "The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.", - "format": "google-datetime", - "type": "string" - }, - "postingRegion": { - "description": "The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", - "enum": [ - "POSTING_REGION_UNSPECIFIED", - "ADMINISTRATIVE_AREA", - "NATION", - "TELECOMMUTE" - ], - "enumDescriptions": [ - "If the region is unspecified, the job is only returned if it matches the LocationFilter.", - "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if LocationFilter has \"Mountain View\". Administrative area refers to top-level administrative subdivision of this country. For example, US state, IT region, UK constituent nation and JP prefecture.", - "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", - "Job allows employees to work remotely (telecommute). If locations are provided with this value, the job is considered as having a location, but telecommuting is allowed." - ], - "type": "string" - }, - "postingUpdateTime": { - "description": "Output only. The timestamp when this job posting was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "processingOptions": { - "$ref": "GoogleCloudTalentV4JobProcessingOptions", - "description": "Options for job processing." - }, - "promotionValue": { - "description": "A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.", - "format": "int32", - "type": "integer" - }, - "qualifications": { - "description": "A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "requisitionId": { - "description": "Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id. The maximum number of allowed characters is 255.", - "type": "string" - }, - "responsibilities": { - "description": "A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "title": { - "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", - "type": "string" - }, - "visibility": { - "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", - "enum": [ - "VISIBILITY_UNSPECIFIED", - "ACCOUNT_ONLY", - "SHARED_WITH_GOOGLE", - "SHARED_WITH_PUBLIC" - ], - "enumDescriptions": [ - "Default value.", - "The resource is only visible to the GCP account who owns it.", - "The resource is visible to the owner and may be visible to other applications and processes at Google.", - "The resource is visible to the owner and may be visible to all other API clients." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobApplicationInfo": { - "description": "Application related details of a job posting.", - "id": "GoogleCloudTalentV4JobApplicationInfo", - "properties": { - "emails": { - "description": "Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255.", - "items": { - "type": "string" - }, - "type": "array" - }, - "instruction": { - "description": "Use this field to provide instructions, such as \"Mail your application to ...\", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.", - "type": "string" - }, - "uris": { - "description": "Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobDerivedInfo": { - "description": "Derived details about the job posting.", - "id": "GoogleCloudTalentV4JobDerivedInfo", - "properties": { - "jobCategories": { - "description": "Job categories derived from Job.title and Job.description.", - "items": { - "enum": [ - "JOB_CATEGORY_UNSPECIFIED", - "ACCOUNTING_AND_FINANCE", - "ADMINISTRATIVE_AND_OFFICE", - "ADVERTISING_AND_MARKETING", - "ANIMAL_CARE", - "ART_FASHION_AND_DESIGN", - "BUSINESS_OPERATIONS", - "CLEANING_AND_FACILITIES", - "COMPUTER_AND_IT", - "CONSTRUCTION", - "CUSTOMER_SERVICE", - "EDUCATION", - "ENTERTAINMENT_AND_TRAVEL", - "FARMING_AND_OUTDOORS", - "HEALTHCARE", - "HUMAN_RESOURCES", - "INSTALLATION_MAINTENANCE_AND_REPAIR", - "LEGAL", - "MANAGEMENT", - "MANUFACTURING_AND_WAREHOUSE", - "MEDIA_COMMUNICATIONS_AND_WRITING", - "OIL_GAS_AND_MINING", - "PERSONAL_CARE_AND_SERVICES", - "PROTECTIVE_SERVICES", - "REAL_ESTATE", - "RESTAURANT_AND_HOSPITALITY", - "SALES_AND_RETAIL", - "SCIENCE_AND_ENGINEERING", - "SOCIAL_SERVICES_AND_NON_PROFIT", - "SPORTS_FITNESS_AND_RECREATION", - "TRANSPORTATION_AND_LOGISTICS" - ], - "enumDescriptions": [ - "The default value if the category isn't specified.", - "An accounting and finance job, such as an Accountant.", - "An administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category, such as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], - "type": "string" - }, - "type": "array" - }, - "locations": { - "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", - "items": { - "$ref": "GoogleCloudTalentV4Location" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobProcessingOptions": { - "description": "Options for job processing.", - "id": "GoogleCloudTalentV4JobProcessingOptions", - "properties": { - "disableStreetAddressResolution": { - "description": "If set to `true`, the service does not attempt to resolve a more precise address for the job.", - "type": "boolean" - }, - "htmlSanitization": { - "description": "Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation isn't disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", - "enum": [ - "HTML_SANITIZATION_UNSPECIFIED", - "HTML_SANITIZATION_DISABLED", - "SIMPLE_FORMATTING_ONLY" - ], - "enumDescriptions": [ - "Default value.", - "Disables sanitization on HTML input.", - "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobResult": { - "description": "Mutation result of a job from a batch operation.", - "id": "GoogleCloudTalentV4JobResult", - "properties": { - "job": { - "$ref": "GoogleCloudTalentV4Job", - "description": "Here Job only contains basic information including name, company, language_code and requisition_id, use getJob method to retrieve detailed information of the created/updated job." - }, - "status": { - "$ref": "Status", - "description": "The status of the job processed. This field is populated if the processing of the job fails." - } - }, - "type": "object" - }, - "GoogleCloudTalentV4Location": { - "description": "A resource that represents a location with full geographic information.", - "id": "GoogleCloudTalentV4Location", - "properties": { - "latLng": { - "$ref": "LatLng", - "description": "An object representing a latitude/longitude pair." - }, - "locationType": { - "description": "The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType.NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType.LOCALITY.", - "enum": [ - "LOCATION_TYPE_UNSPECIFIED", - "COUNTRY", - "ADMINISTRATIVE_AREA", - "SUB_ADMINISTRATIVE_AREA", - "LOCALITY", - "POSTAL_CODE", - "SUB_LOCALITY", - "SUB_LOCALITY_1", - "SUB_LOCALITY_2", - "NEIGHBORHOOD", - "STREET_ADDRESS" - ], - "enumDescriptions": [ - "Default value if the type isn't specified.", - "A country level location.", - "A state or equivalent level location.", - "A county or equivalent level location.", - "A city or equivalent level location.", - "A postal code level location.", - "A sublocality is a subdivision of a locality, for example a city borough, ward, or arrondissement. Sublocalities are usually recognized by a local political authority. For example, Manhattan and Brooklyn are recognized as boroughs by the City of New York, and are therefore modeled as sublocalities.", - "A district or equivalent level location.", - "A smaller district or equivalent level display.", - "A neighborhood level location.", - "A street address level location." - ], - "type": "string" - }, - "postalAddress": { - "$ref": "PostalAddress", - "description": "Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location." - }, - "radiusMiles": { - "description": "Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "HistogramFacets": { - "description": "Input only. Histogram facets to be specified in SearchJobsRequest.", - "id": "HistogramFacets", - "properties": { - "compensationHistogramFacets": { - "description": "Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.", - "items": { - "$ref": "CompensationHistogramRequest" - }, - "type": "array" - }, - "customAttributeHistogramFacets": { - "description": "Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.", - "items": { - "$ref": "CustomAttributeHistogramRequest" - }, - "type": "array" - }, - "simpleHistogramFacets": { - "description": "Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to GetHistogramRequest.", - "items": { - "enum": [ - "JOB_FIELD_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "CUSTOM_FIELD_1", - "CUSTOM_FIELD_2", - "CUSTOM_FIELD_3", - "CUSTOM_FIELD_4", - "CUSTOM_FIELD_5", - "CUSTOM_FIELD_6", - "CUSTOM_FIELD_7", - "CUSTOM_FIELD_8", - "CUSTOM_FIELD_9", - "CUSTOM_FIELD_10", - "CUSTOM_FIELD_11", - "CUSTOM_FIELD_12", - "CUSTOM_FIELD_13", - "CUSTOM_FIELD_14", - "CUSTOM_FIELD_15", - "CUSTOM_FIELD_16", - "CUSTOM_FIELD_17", - "CUSTOM_FIELD_18", - "CUSTOM_FIELD_19", - "CUSTOM_FIELD_20", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN1_COUNTRY", - "COMPANY_TITLE", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Values are stringified with TimeRange, for example, TimeRange.PAST_MONTH.", - "Filter by custom field 1.", - "Filter by custom field 2.", - "Filter by custom field 3.", - "Filter by custom field 4.", - "Filter by custom field 5.", - "Filter by custom field 6.", - "Filter by custom field 7.", - "Filter by custom field 8.", - "Filter by custom field 9.", - "Filter by custom field 10.", - "Filter by custom field 11.", - "Filter by custom field 12.", - "Filter by custom field 13.", - "Filter by custom field 14.", - "Filter by custom field 15.", - "Filter by custom field 16.", - "Filter by custom field 17.", - "Filter by custom field 18.", - "Filter by custom field 19.", - "Filter by custom field 20.", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", - "Deprecated. Use COMPANY_DISPLAY_NAME instead. Company display name.", - "Company display name.", - "Base compensation unit." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "HistogramResult": { - "description": "Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter.", - "id": "HistogramResult", - "properties": { - "searchType": { - "description": "The Histogram search filters.", - "enum": [ - "JOB_FIELD_UNSPECIFIED", - "COMPANY_ID", - "EMPLOYMENT_TYPE", - "COMPANY_SIZE", - "DATE_PUBLISHED", - "CUSTOM_FIELD_1", - "CUSTOM_FIELD_2", - "CUSTOM_FIELD_3", - "CUSTOM_FIELD_4", - "CUSTOM_FIELD_5", - "CUSTOM_FIELD_6", - "CUSTOM_FIELD_7", - "CUSTOM_FIELD_8", - "CUSTOM_FIELD_9", - "CUSTOM_FIELD_10", - "CUSTOM_FIELD_11", - "CUSTOM_FIELD_12", - "CUSTOM_FIELD_13", - "CUSTOM_FIELD_14", - "CUSTOM_FIELD_15", - "CUSTOM_FIELD_16", - "CUSTOM_FIELD_17", - "CUSTOM_FIELD_18", - "CUSTOM_FIELD_19", - "CUSTOM_FIELD_20", - "EDUCATION_LEVEL", - "EXPERIENCE_LEVEL", - "ADMIN1", - "COUNTRY", - "CITY", - "LOCALE", - "LANGUAGE", - "CATEGORY", - "CITY_COORDINATE", - "ADMIN1_COUNTRY", - "COMPANY_TITLE", - "COMPANY_DISPLAY_NAME", - "BASE_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "The default value if search type is not specified.", - "Filter by the company id field.", - "Filter by the employment type field, such as `FULL_TIME` or `PART_TIME`.", - "Filter by the company size type field, such as `BIG`, `SMALL` or `BIGGER`.", - "Filter by the date published field. Values are stringified with TimeRange, for example, TimeRange.PAST_MONTH.", - "Filter by custom field 1.", - "Filter by custom field 2.", - "Filter by custom field 3.", - "Filter by custom field 4.", - "Filter by custom field 5.", - "Filter by custom field 6.", - "Filter by custom field 7.", - "Filter by custom field 8.", - "Filter by custom field 9.", - "Filter by custom field 10.", - "Filter by custom field 11.", - "Filter by custom field 12.", - "Filter by custom field 13.", - "Filter by custom field 14.", - "Filter by custom field 15.", - "Filter by custom field 16.", - "Filter by custom field 17.", - "Filter by custom field 18.", - "Filter by custom field 19.", - "Filter by custom field 20.", - "Filter by the required education level of the job.", - "Filter by the required experience level of the job.", - "Filter by Admin1, which is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as \"CA\", \"IL\", \"NY\", and provinces, such as \"BC\".", - "Filter by the country code of job, such as US, JP, FR.", - "Filter by the \"city name\", \"Admin1 code\", for example, \"Mountain View, CA\" or \"New York, NY\".", - "Filter by the locale field of a job, such as \"en-US\", \"fr-FR\". This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", - "Filter by the language code portion of the locale field, such as \"en\" or \"fr\".", - "Filter by the Category.", - "Filter by the city center GPS coordinate (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, clients may need to refresh them periodically.", - "A combination of state or province code with a country code. This field differs from `JOB_ADMIN1`, which can be used in multiple countries.", - "Deprecated. Use COMPANY_DISPLAY_NAME instead. Company display name.", - "Company display name.", - "Base compensation unit." - ], - "type": "string" - }, - "values": { - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "description": "A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search.", - "type": "object" - } - }, - "type": "object" - }, - "HistogramResults": { - "description": "Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest.", - "id": "HistogramResults", - "properties": { - "compensationHistogramResults": { - "description": "Specifies compensation field-based histogram results that matches HistogramFacets.compensation_histogram_requests.", - "items": { - "$ref": "CompensationHistogramResult" - }, - "type": "array" - }, - "customAttributeHistogramResults": { - "description": "Specifies histogram results for custom attributes that matches HistogramFacets.custom_attribute_histogram_facets.", - "items": { - "$ref": "CustomAttributeHistogramResult" - }, - "type": "array" - }, - "simpleHistogramResults": { - "description": "Specifies histogram results that matches HistogramFacets.simple_histogram_facets.", - "items": { - "$ref": "HistogramResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "Job": { - "description": "A Job resource represents a job posting (also referred to as a \"job listing\" or \"job requisition\"). A job belongs to a Company, which is the hiring entity responsible for the job.", - "id": "Job", - "properties": { - "applicationEmailList": { - "description": "Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255.", - "items": { - "type": "string" - }, - "type": "array" - }, - "applicationInstruction": { - "description": "Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to provide instructions, such as \"Mail your application to ...\", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.", - "type": "string" - }, - "applicationUrls": { - "description": "Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000.", - "items": { - "type": "string" - }, - "type": "array" - }, - "benefits": { - "description": "Optional. The benefits included with the job.", - "items": { - "enum": [ - "JOB_BENEFIT_TYPE_UNSPECIFIED", - "CHILD_CARE", - "DENTAL", - "DOMESTIC_PARTNER", - "FLEXIBLE_HOURS", - "MEDICAL", - "LIFE_INSURANCE", - "PARENTAL_LEAVE", - "RETIREMENT_PLAN", - "SICK_DAYS", - "TELECOMMUTE", - "VACATION", - "VISION" - ], - "enumDescriptions": [ - "Default value if the type is not specified.", - "The job includes access to programs that support child care, such as daycare.", - "The job includes dental services that are covered by a dental insurance plan.", - "The job offers specific benefits to domestic partners.", - "The job allows for a flexible work schedule.", - "The job includes health services that are covered by a medical insurance plan.", - "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", - "The job allows for a leave of absence to a parent to care for a newborn child.", - "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", - "The job allows for paid time off due to illness.", - "Deprecated. Set Region.TELECOMMUTE instead. The job allows telecommuting (working remotely).", - "The job includes paid time off for vacation.", - "The job includes vision services that are covered by a vision insurance plan." - ], - "type": "string" - }, - "type": "array" - }, - "companyDisplayName": { - "description": "Output only. The name of the company listing the job.", - "type": "string" - }, - "companyName": { - "description": "Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id.", - "type": "string" - }, - "companyTitle": { - "description": "Deprecated. Use company_display_name instead. Output only. The name of the company listing the job.", - "type": "string" - }, - "compensationInfo": { - "$ref": "CompensationInfo", - "description": "Optional. Job compensation information." - }, - "createTime": { - "description": "Output only. The timestamp when this job was created.", - "format": "google-datetime", - "type": "string" - }, - "customAttributes": { - "additionalProperties": { - "$ref": "CustomAttribute" - }, - "description": "Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", - "type": "object" - }, - "department": { - "description": "Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", - "type": "string" - }, - "description": { - "description": "Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.", - "type": "string" - }, - "distributorCompanyId": { - "description": "Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255.", - "type": "string" - }, - "educationLevels": { - "description": "Optional. The desired education level for the job, such as \"Bachelors\", \"Masters\", \"Doctorate\".", - "items": { - "enum": [ - "EDUCATION_LEVEL_UNSPECIFIED", - "HIGH_SCHOOL", - "ASSOCIATE", - "BACHELORS", - "MASTERS", - "DOCTORATE", - "NO_DEGREE_REQUIRED" - ], - "enumDescriptions": [ - "The default value if the level is not specified.", - "A High School diploma is required for the position.", - "An Associate degree is required for the position.", - "A Bachelors degree is required for the position.", - "A Masters degree is required for the position.", - "A Doctorate degree is required for the position.", - "No formal education is required for the position." - ], - "type": "string" - }, - "type": "array" - }, - "employmentTypes": { - "description": "Optional. The employment type(s) of a job, for example, full time or part time.", - "items": { - "enum": [ - "EMPLOYMENT_TYPE_UNSPECIFIED", - "FULL_TIME", - "PART_TIME", - "CONTRACTOR", - "TEMPORARY", - "INTERN", - "VOLUNTEER", - "PER_DIEM", - "CONTRACT_TO_HIRE", - "FLY_IN_FLY_OUT", - "OTHER" - ], - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee, position.", - "The job is offered as a temporary employment opportunity, usually a short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there is no expectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a flexible schedule.", - "The job is offered as a contracted position with the understanding that it is converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.", - "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", - "The job does not fit any of the other listed types." - ], - "type": "string" - }, - "type": "array" - }, - "endDate": { - "$ref": "Date", - "description": "Optional. The end date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored." - }, - "expireTime": { - "description": "Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.", - "format": "google-datetime", - "type": "string" - }, - "expiryDate": { - "$ref": "Date", - "description": "Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated." - }, - "extendedCompensationInfo": { - "$ref": "ExtendedCompensationInfo", - "description": "Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown." - }, - "filterableCustomFields": { - "additionalProperties": { - "$ref": "CustomField" - }, - "description": "Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned.", - "type": "object" - }, - "incentives": { - "description": "Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "jobLocations": { - "description": "Output only. Structured locations of the job, resolved from locations.", - "items": { - "$ref": "JobLocation" - }, - "type": "array" - }, - "jobTitle": { - "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", - "type": "string" - }, - "level": { - "description": "Optional. The experience level associated with the job, such as \"Entry Level\".", - "enum": [ - "JOB_LEVEL_UNSPECIFIED", - "ENTRY_LEVEL", - "EXPERIENCED", - "MANAGER", - "DIRECTOR", - "EXECUTIVE" - ], - "enumDescriptions": [ - "The default value if the level is not specified.", - "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", - "Experienced individual contributors, typically with 2+ years of experience in a similar role.", - "Entry- to mid-level managers responsible for managing a team of people.", - "Senior-level managers responsible for managing teams of managers.", - "Executive-level managers and above, including C-level positions." - ], - "type": "string" - }, - "locations": { - "description": "Optional but strongly recommended for the best service experience. Location(s) where the emploeyer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.", - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "Required during job update. Resource name assigned to a job by the API, for example, \"/jobs/foo\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", - "type": "string" - }, - "promotionValue": { - "description": "Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.", - "format": "int32", - "type": "integer" - }, - "publishDate": { - "$ref": "Date", - "description": "Optional. The date this job was most recently published in UTC format. The default value is the time the request arrives at the server." - }, - "qualifications": { - "description": "Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "referenceUrl": { - "description": "Output only. The URL of a web page that displays job details.", - "type": "string" - }, - "region": { - "description": "Optional. The job Region (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job if an exact location match is not specified. If this field is set, setting job locations to the same location level as this field is strongly recommended.", - "enum": [ - "REGION_UNSPECIFIED", - "STATE_WIDE", - "NATION_WIDE", - "TELECOMMUTE" - ], - "enumDescriptions": [ - "If the region is unspecified, the job is only returned if it matches the LocationFilter.", - "In additiona to exact location matching, job is returned when the LocationFilter in search query is in the same state as this job. For example, if a `STATE_WIDE` job is posted in \"CA, USA\", it is returned if LocationFilter has \"Mountain View\".", - "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it is returned if LocationFilter has 'Mountain View'.", - "Job allows employees to work remotely (telecommute). If locations are provided with this value, the job is considered as having a location, but telecommuting is allowed." - ], - "type": "string" - }, - "requisitionId": { - "description": "Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255.", - "type": "string" - }, - "responsibilities": { - "description": "Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "startDate": { - "$ref": "Date", - "description": "Optional. The start date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored." - }, - "unindexedCustomFields": { - "additionalProperties": { - "$ref": "CustomField" - }, - "description": "Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string.", - "type": "object" - }, - "updateTime": { - "description": "Output only. The timestamp when this job was last updated.", - "format": "google-datetime", - "type": "string" - }, - "visibility": { - "description": "Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE if not specified. Currently only JobVisibility.PRIVATE is supported.", - "enum": [ - "JOB_VISIBILITY_UNSPECIFIED", - "PRIVATE", - "GOOGLE", - "PUBLIC" - ], - "enumDescriptions": [ - "Default value.", - "The Job is only visible to the owner.", - "The Job is visible to the owner and may be visible to other applications and processes at Google. Not yet supported. Use PRIVATE.", - "The Job is visible to the owner and may be visible to all other API clients. Not yet supported. Use PRIVATE." - ], - "type": "string" - } - }, - "type": "object" - }, - "JobFilters": { - "description": "Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram.", - "id": "JobFilters", - "properties": { - "categories": { - "description": "Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.", - "items": { - "enum": [ - "JOB_CATEGORY_UNSPECIFIED", - "ACCOUNTING_AND_FINANCE", - "ADMINISTRATIVE_AND_OFFICE", - "ADVERTISING_AND_MARKETING", - "ANIMAL_CARE", - "ART_FASHION_AND_DESIGN", - "BUSINESS_OPERATIONS", - "CLEANING_AND_FACILITIES", - "COMPUTER_AND_IT", - "CONSTRUCTION", - "CUSTOMER_SERVICE", - "EDUCATION", - "ENTERTAINMENT_AND_TRAVEL", - "FARMING_AND_OUTDOORS", - "HEALTHCARE", - "HUMAN_RESOURCES", - "INSTALLATION_MAINTENANCE_AND_REPAIR", - "LEGAL", - "MANAGEMENT", - "MANUFACTURING_AND_WAREHOUSE", - "MEDIA_COMMUNICATIONS_AND_WRITING", - "OIL_GAS_AND_MINING", - "PERSONAL_CARE_AND_SERVICES", - "PROTECTIVE_SERVICES", - "REAL_ESTATE", - "RESTAURANT_AND_HOSPITALITY", - "SALES_AND_RETAIL", - "SCIENCE_AND_ENGINEERING", - "SOCIAL_SERVICES_AND_NON_PROFIT", - "SPORTS_FITNESS_AND_RECREATION", - "TRANSPORTATION_AND_LOGISTICS" - ], - "enumDescriptions": [ - "The default value if the category is not specified.", - "An accounting and finance job, such as an Accountant.", - "And administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category, such as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], - "type": "string" - }, - "type": "array" - }, - "commuteFilter": { - "$ref": "CommutePreference", - "description": "Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time." - }, - "companyNames": { - "description": "Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed.", - "items": { - "type": "string" - }, - "type": "array" - }, - "companyTitles": { - "description": "Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company title filters are allowed.", - "items": { - "type": "string" - }, - "type": "array" - }, - "compensationFilter": { - "$ref": "CompensationFilter", - "description": "Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as \"Hourly job with per-hour compensation > $15\", only jobs that meet this criteria are searched. If a filter is not defined, all open jobs are searched." - }, - "customAttributeFilter": { - "description": "Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER() to perform case insensitive match and EMPTY() to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (For example, \"((A AND B AND C) OR NOT D) AND E\"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = \"TEST\" OR LOWER(key1)=\"test\" OR NOT EMPTY(key1)) AND key2 > 100", - "type": "string" - }, - "customFieldFilters": { - "additionalProperties": { - "$ref": "CustomFieldFilter" - }, - "description": "Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown.", - "type": "object" - }, - "disableSpellCheck": { - "description": "Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, \"enginee\" is corrected to \"engineer\". Defaults to false: a spell check is performed.", - "type": "boolean" - }, - "employmentTypes": { - "description": "Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.", - "items": { - "enum": [ - "EMPLOYMENT_TYPE_UNSPECIFIED", - "FULL_TIME", - "PART_TIME", - "CONTRACTOR", - "TEMPORARY", - "INTERN", - "VOLUNTEER", - "PER_DIEM", - "CONTRACT_TO_HIRE", - "FLY_IN_FLY_OUT", - "OTHER" - ], - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee, position.", - "The job is offered as a temporary employment opportunity, usually a short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there is no expectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a flexible schedule.", - "The job is offered as a contracted position with the understanding that it is converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.", - "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", - "The job does not fit any of the other listed types." - ], - "type": "string" - }, - "type": "array" - }, - "extendedCompensationFilter": { - "$ref": "ExtendedCompensationFilter", - "description": "Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as \"Hourly job with per-hour compensation > $15\", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched." - }, - "languageCodes": { - "description": "Optional. This filter specifies the locale of jobs to search against, for example, \"en-US\". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.", - "items": { - "type": "string" - }, - "type": "array" - }, - "locationFilters": { - "description": "Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value is not specified, jobs are retrieved from all locations. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.", - "items": { - "$ref": "LocationFilter" - }, - "type": "array" - }, - "publishDateRange": { - "description": "Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value is not specified, all open jobs are searched against regardless of the date they were published.", - "enum": [ - "DATE_RANGE_UNSPECIFIED", - "PAST_24_HOURS", - "PAST_WEEK", - "PAST_MONTH", - "PAST_YEAR", - "PAST_3_DAYS" - ], - "enumDescriptions": [ - "Default value: Filtering on time is not performed.", - "The past 24 hours", - "The past week (7 days)", - "The past month (30 days)", - "The past year (365 days)", - "The past 3 days" - ], - "type": "string" - }, - "query": { - "description": "Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters.", - "type": "string" - }, - "tenantJobOnly": { - "description": "Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against.", - "type": "boolean" - } - }, - "type": "object" - }, - "JobLocation": { - "description": "Output only. A resource that represents a location with full geographic information.", - "id": "JobLocation", - "properties": { - "latLng": { - "$ref": "LatLng", - "description": "An object representing a latitude/longitude pair." - }, - "locationType": { - "description": "The type of a location, which corresponds to the address lines field of PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType#NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType#LOCALITY.", - "enum": [ - "LOCATION_TYPE_UNSPECIFIED", - "COUNTRY", - "ADMINISTRATIVE_AREA", - "SUB_ADMINISTRATIVE_AREA", - "LOCALITY", - "POSTAL_CODE", - "SUB_LOCALITY", - "SUB_LOCALITY_1", - "SUB_LOCALITY_2", - "NEIGHBORHOOD", - "STREET_ADDRESS" - ], - "enumDescriptions": [ - "Default value if the type is not specified.", - "A country level location.", - "A state or equivalent level location.", - "A county or equivalent level location.", - "A city or equivalent level location.", - "A postal code level location.", - "A sublocality is a subdivision of a locality, for example a city borough, ward, or arrondissement. Sublocalities are usually recognized by a local political authority. For example, Manhattan and Brooklyn are recognized as boroughs by the City of New York, and are therefore modeled as sublocalities.", - "A district or equivalent level location.", - "A smaller district or equivalent level display.", - "A neighborhood level location.", - "A street address level location." - ], - "type": "string" - }, - "postalAddress": { - "$ref": "PostalAddress", - "description": "Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location." - }, - "radiusMeters": { - "description": "Radius in meters of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng coves the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 7885.79 meters.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "JobProcessingOptions": { - "description": "Input only. Options for job processing.", - "id": "JobProcessingOptions", - "properties": { - "disableStreetAddressResolution": { - "description": "Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.", - "type": "boolean" - }, - "htmlSanitization": { - "description": "Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", - "enum": [ - "HTML_SANITIZATION_UNSPECIFIED", - "HTML_SANITIZATION_DISABLED", - "SIMPLE_FORMATTING_ONLY" - ], - "enumDescriptions": [ - "Default value.", - "Disables sanitization on HTML input.", - "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." - ], - "type": "string" - } - }, - "type": "object" - }, - "JobQuery": { - "description": "Input only. The query required to perform a search query or histogram.", - "id": "JobQuery", - "properties": { - "categories": { - "description": "Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.", - "items": { - "enum": [ - "JOB_CATEGORY_UNSPECIFIED", - "ACCOUNTING_AND_FINANCE", - "ADMINISTRATIVE_AND_OFFICE", - "ADVERTISING_AND_MARKETING", - "ANIMAL_CARE", - "ART_FASHION_AND_DESIGN", - "BUSINESS_OPERATIONS", - "CLEANING_AND_FACILITIES", - "COMPUTER_AND_IT", - "CONSTRUCTION", - "CUSTOMER_SERVICE", - "EDUCATION", - "ENTERTAINMENT_AND_TRAVEL", - "FARMING_AND_OUTDOORS", - "HEALTHCARE", - "HUMAN_RESOURCES", - "INSTALLATION_MAINTENANCE_AND_REPAIR", - "LEGAL", - "MANAGEMENT", - "MANUFACTURING_AND_WAREHOUSE", - "MEDIA_COMMUNICATIONS_AND_WRITING", - "OIL_GAS_AND_MINING", - "PERSONAL_CARE_AND_SERVICES", - "PROTECTIVE_SERVICES", - "REAL_ESTATE", - "RESTAURANT_AND_HOSPITALITY", - "SALES_AND_RETAIL", - "SCIENCE_AND_ENGINEERING", - "SOCIAL_SERVICES_AND_NON_PROFIT", - "SPORTS_FITNESS_AND_RECREATION", - "TRANSPORTATION_AND_LOGISTICS" - ], - "enumDescriptions": [ - "The default value if the category is not specified.", - "An accounting and finance job, such as an Accountant.", - "And administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category, such as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], - "type": "string" - }, - "type": "array" - }, - "commuteFilter": { - "$ref": "CommutePreference", - "description": "Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time." - }, - "companyDisplayNames": { - "description": "Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed.", - "items": { - "type": "string" - }, - "type": "array" - }, - "companyNames": { - "description": "Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. At most 20 company filters are allowed.", - "items": { - "type": "string" - }, - "type": "array" - }, - "compensationFilter": { - "$ref": "CompensationFilter", - "description": "Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as \"Hourly job with per-hour compensation > $15\", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched." - }, - "customAttributeFilter": { - "description": "Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER() to perform case insensitive match and EMPTY() to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, \"((A AND B AND C) OR NOT D) AND E\"), a maximum of 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = \"TEST\" OR LOWER(key1)=\"test\" OR NOT EMPTY(key1)) AND key2 > 100", - "type": "string" - }, - "disableSpellCheck": { - "description": "Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, \"enginee\" is corrected to \"engineer\". Defaults to false: a spell check is performed.", - "type": "boolean" - }, - "employmentTypes": { - "description": "Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.", - "items": { - "enum": [ - "EMPLOYMENT_TYPE_UNSPECIFIED", - "FULL_TIME", - "PART_TIME", - "CONTRACTOR", - "TEMPORARY", - "INTERN", - "VOLUNTEER", - "PER_DIEM", - "CONTRACT_TO_HIRE", - "FLY_IN_FLY_OUT", - "OTHER" - ], - "enumDescriptions": [ - "The default value if the employment type is not specified.", - "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee, position.", - "The job is offered as a temporary employment opportunity, usually a short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there is no expectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a flexible schedule.", - "The job is offered as a contracted position with the understanding that it is converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.", - "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", - "The job does not fit any of the other listed types." - ], - "type": "string" - }, - "type": "array" - }, - "languageCodes": { - "description": "Optional. This filter specifies the locale of jobs to search against, for example, \"en-US\". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.", - "items": { - "type": "string" - }, - "type": "array" - }, - "locationFilters": { - "description": "Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.", - "items": { - "$ref": "LocationFilter" - }, - "type": "array" - }, - "publishDateRange": { - "description": "Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value isn't specified, all open jobs are searched against regardless of their published date.", - "enum": [ - "DATE_RANGE_UNSPECIFIED", - "PAST_24_HOURS", - "PAST_WEEK", - "PAST_MONTH", - "PAST_YEAR", - "PAST_3_DAYS" - ], - "enumDescriptions": [ - "Default value: Filtering on time is not performed.", - "The past 24 hours", - "The past week (7 days)", - "The past month (30 days)", - "The past year (365 days)", - "The past 3 days" - ], - "type": "string" - }, - "query": { - "description": "Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes.", - "type": "string" - } - }, - "type": "object" - }, - "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", - "id": "LatLng", - "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "ListCompaniesResponse": { - "description": "Output only. The List companies response object.", - "id": "ListCompaniesResponse", - "properties": { - "companies": { - "description": "Companies for the current client.", - "items": { - "$ref": "Company" - }, - "type": "array" - }, - "metadata": { - "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request tracking id." - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "ListCompanyJobsResponse": { - "description": "Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object.", - "id": "ListCompanyJobsResponse", - "properties": { - "jobs": { - "description": "The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.", - "items": { - "$ref": "Job" - }, - "type": "array" - }, - "metadata": { - "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request tracking id." - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.", - "type": "string" - }, - "totalSize": { - "description": "The total number of open jobs. The result will be empty if ListCompanyJobsRequest.include_jobs_count is not enabled or if no open jobs are available.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "ListJobsResponse": { - "description": "Output only. List jobs response.", - "id": "ListJobsResponse", - "properties": { - "jobs": { - "description": "The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.", - "items": { - "$ref": "Job" - }, - "type": "array" - }, - "metadata": { - "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request tracking id." - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "LocationFilter": { - "description": "Input only. Geographic region of the search.", - "id": "LocationFilter", - "properties": { - "distanceInMiles": { - "description": "Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored.", - "format": "double", - "type": "number" - }, - "isTelecommute": { - "description": "Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.allow_telecommute indicates if a job permits telecommuting. If this field is true, telecommuting jobs are searched, and name and lat_lng are ignored. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as \"Mountain View\" or \"telecommuting\" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response.", - "type": "boolean" - }, - "latLng": { - "$ref": "LatLng", - "description": "Optional. The latitude and longitude of the geographic center from which to search. This field is ignored if `location_name` is provided." - }, - "name": { - "description": "Optional. The address name, such as \"Mountain View\" or \"Bay Area\".", - "type": "string" - }, - "regionCode": { - "description": "Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. \"Liverpool\" against \"Liverpool, NY, US\" or \"Liverpool, UK\". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", - "type": "string" - } - }, - "type": "object" - }, - "MatchingJob": { - "description": "Output only. Job entry with metadata inside SearchJobsResponse.", - "id": "MatchingJob", - "properties": { - "commuteInfo": { - "$ref": "CommuteInfo", - "description": "Commute information which is generated based on specified CommutePreference." - }, - "job": { - "$ref": "Job", - "description": "Job resource that matches the specified SearchJobsRequest." - }, - "jobSummary": { - "description": "A summary of the job with core information that's displayed on the search results listing page.", - "type": "string" - }, - "jobTitleSnippet": { - "description": "Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.", - "type": "string" - }, - "searchTextSnippet": { - "description": "Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.", - "type": "string" - } - }, - "type": "object" - }, - "MendelDebugInput": { - "description": "Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2", - "id": "MendelDebugInput", - "properties": { - "namespacedDebugInput": { - "additionalProperties": { - "$ref": "NamespacedDebugInput" - }, - "description": "When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == \"\"). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details.", - "type": "object" - } - }, - "type": "object" - }, - "Money": { - "description": "Represents an amount of money with its currency type.", - "id": "Money", - "properties": { - "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", - "type": "string" - }, - "nanos": { - "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", - "type": "integer" - }, - "units": { - "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "NamespacedDebugInput": { - "description": "Next ID: 15", - "id": "NamespacedDebugInput", - "properties": { - "absolutelyForcedExpNames": { - "description": "Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions.", - "items": { - "type": "string" - }, - "type": "array" - }, - "absolutelyForcedExpTags": { - "description": "Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions.", - "items": { - "type": "string" - }, - "type": "array" - }, - "absolutelyForcedExps": { - "description": "Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "conditionallyForcedExpNames": { - "description": "Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true.", - "items": { - "type": "string" - }, - "type": "array" - }, - "conditionallyForcedExpTags": { - "description": "Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true.", - "items": { - "type": "string" - }, - "type": "array" - }, - "conditionallyForcedExps": { - "description": "Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "disableAutomaticEnrollmentSelection": { - "description": "If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments.", - "type": "boolean" - }, - "disableExpNames": { - "description": "Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", - "items": { - "type": "string" - }, - "type": "array" - }, - "disableExpTags": { - "description": "Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together.", - "items": { - "type": "string" - }, - "type": "array" - }, - "disableExps": { - "description": "Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "disableManualEnrollmentSelection": { - "description": "If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments.", - "type": "boolean" - }, - "disableOrganicSelection": { - "description": "If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem.", - "type": "boolean" - }, - "forcedFlags": { - "additionalProperties": { - "type": "string" - }, - "description": "Flags to force in a particular experiment state. Map from flag name to flag value.", - "type": "object" - }, - "forcedRollouts": { - "additionalProperties": { - "type": "boolean" - }, - "description": "Rollouts to force in a particular experiment state. Map from rollout name to rollout value.", - "type": "object" - } - }, - "type": "object" - }, - "NumericBucketingOption": { - "description": "Input only. Use this field to specify bucketing option for the histogram search response.", - "id": "NumericBucketingOption", - "properties": { - "bucketBounds": { - "description": "Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported.", - "items": { - "format": "double", - "type": "number" - }, - "type": "array" - }, - "requiresMinMax": { - "description": "Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.", - "type": "boolean" - } - }, - "type": "object" - }, - "NumericBucketingResult": { - "description": "Output only. Custom numeric bucketing result.", - "id": "NumericBucketingResult", - "properties": { - "counts": { - "description": "Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1.", - "items": { - "$ref": "BucketizedCount" - }, - "type": "array" - }, - "maxValue": { - "description": "Stores the maximum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.", - "format": "double", - "type": "number" - }, - "minValue": { - "description": "Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "PostalAddress": { - "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", - "id": "PostalAddress", - "properties": { - "addressLines": { - "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", - "items": { - "type": "string" - }, - "type": "array" - }, - "administrativeArea": { - "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.", - "type": "string" - }, - "languageCode": { - "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", - "type": "string" - }, - "locality": { - "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", - "type": "string" - }, - "organization": { - "description": "Optional. The name of the organization at the address.", - "type": "string" - }, - "postalCode": { - "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).", - "type": "string" - }, - "recipients": { - "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", - "items": { - "type": "string" - }, - "type": "array" - }, - "regionCode": { - "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", - "type": "string" - }, - "revision": { - "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", - "format": "int32", - "type": "integer" - }, - "sortingCode": { - "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", - "type": "string" - }, - "sublocality": { - "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", - "type": "string" - } - }, - "type": "object" - }, - "RequestMetadata": { - "description": "Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.", - "id": "RequestMetadata", - "properties": { - "deviceInfo": { - "$ref": "DeviceInfo", - "description": "Optional. The type of device used by the job seeker at the time of the call to the service." - }, - "domain": { - "description": "Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client *Foo, Inc.*, on job board www.foo.com and career site www.bar.com, then this field is set to \"foo.com\" for use on the job board, and \"bar.com\" for use on the career site. If this field is not available for some reason, send \"UNKNOWN\". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain.", - "type": "string" - }, - "sessionId": { - "description": "Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send \"UNKNOWN\". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id.", - "type": "string" - }, - "userId": { - "description": "Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send \"UNKNOWN\". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id.", - "type": "string" - } - }, - "type": "object" - }, - "ResponseMetadata": { - "description": "Output only. Additional information returned to client, such as debugging information.", - "id": "ResponseMetadata", - "properties": { - "experimentIdList": { - "description": "Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "mode": { - "description": "For search response only. Indicates the mode of a performed search.", - "enum": [ - "SEARCH_MODE_UNSPECIFIED", - "JOB_SEARCH", - "FEATURED_JOB_SEARCH", - "EMAIL_ALERT_SEARCH" - ], - "enumDescriptions": [ - "The mode of the search method isn't specified.", - "The job search doesn't include support for featured jobs.", - "The job search matches only against featured jobs (jobs with a promotionValue > 0). This method doesn't return any jobs having a promotionValue <= 0. The search results order is determined by the promotionValue (jobs with a higher promotionValue are returned higher up in the search results), with relevance being used as a tiebreaker.", - "Deprecated. Please use the SearchJobsForAlert API. The job search matches against jobs suited to email notifications." - ], - "type": "string" - }, - "requestId": { - "description": "A unique id associated with this call. This id is logged for tracking purposes.", - "type": "string" - } - }, - "type": "object" - }, - "SearchJobsRequest": { - "description": "Input only. The Request body of the `SearchJobs` call.", - "id": "SearchJobsRequest", - "properties": { - "disableRelevanceThresholding": { - "description": "Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing \"Assistant to the CEO\" positions from the search results of a search for \"CEO\". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false.", - "type": "boolean" - }, - "enableBroadening": { - "description": "Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false.", - "type": "boolean" - }, - "enablePreciseResultSize": { - "description": "Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false.", - "type": "boolean" - }, - "filters": { - "$ref": "JobFilters", - "description": "Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location." - }, - "histogramFacets": { - "$ref": "HistogramFacets", - "description": "Optional. Restrictions on what fields to perform histogram on, such as `COMPANY_SIZE` etc." - }, - "jobView": { - "description": "Optional. The number of job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified.", - "enum": [ - "JOB_VIEW_UNSPECIFIED", - "SMALL", - "MINIMAL", - "FULL" - ], - "enumDescriptions": [ - "Default value.", - "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations, Job.description, Job.visibility. Note: Job.description is deprecated. It is scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018.", - "A minimal view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations.", - "All available attributes are included in the search results. Note: [Job.description, Job.responsibilities, Job.qualifications and Job.incentives are deprecated. These fields are scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018. See the alternative MatchingJob.search_text_snippet and MatchingJob.job_summary fields." - ], - "type": "string" - }, - "mode": { - "description": "Required. Mode of a search.", - "enum": [ - "SEARCH_MODE_UNSPECIFIED", - "JOB_SEARCH", - "FEATURED_JOB_SEARCH", - "EMAIL_ALERT_SEARCH" - ], - "enumDescriptions": [ - "The mode of the search method isn't specified.", - "The job search doesn't include support for featured jobs.", - "The job search matches only against featured jobs (jobs with a promotionValue > 0). This method doesn't return any jobs having a promotionValue <= 0. The search results order is determined by the promotionValue (jobs with a higher promotionValue are returned higher up in the search results), with relevance being used as a tiebreaker.", - "Deprecated. Please use the SearchJobsForAlert API. The job search matches against jobs suited to email notifications." - ], - "type": "string" - }, - "offset": { - "description": "Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).", - "format": "int32", - "type": "integer" - }, - "orderBy": { - "description": "Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified.", - "enum": [ - "SORT_BY_UNSPECIFIED", - "RELEVANCE_DESC", - "PUBLISHED_DATE_DESC", - "UPDATED_DATE_DESC", - "TITLE", - "TITLE_DESC", - "ANNUALIZED_BASE_COMPENSATION", - "ANNUALIZED_TOTAL_COMPENSATION", - "ANNUALIZED_BASE_COMPENSATION_DESC", - "ANNUALIZED_TOTAL_COMPENSATION_DESC" - ], - "enumDescriptions": [ - "Default value.", - "By descending relevance, as determined by the API algorithms. Relevance thresholding of query results is only available for queries if RELEVANCE_DESC sort ordering is specified.", - "Sort by published date descending.", - "Sort by updated date descending.", - "Sort by job title ascending.", - "Sort by job title descending.", - "Sort by job annualized base compensation in ascending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", - "Sort by job annualized total compensation in ascending order. If job's annualized total compensation is unspecified, they are put at the end of search result.", - "Sort by job annualized base compensation in descending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", - "Sort by job annualized total compensation in descending order. If job's annualized total compensation is unspecified, they are put at the end of search result." - ], - "type": "string" - }, - "pageSize": { - "description": "Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.", - "format": "int32", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.", - "type": "string" - }, - "query": { - "$ref": "JobQuery", - "description": "Optional. Query used to search against jobs, such as keyword, location filters, etc." - }, - "requestMetadata": { - "$ref": "RequestMetadata", - "description": "Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent." - }, - "sortBy": { - "description": "Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified.", - "enum": [ - "SORT_BY_UNSPECIFIED", - "RELEVANCE_DESC", - "PUBLISHED_DATE_DESC", - "UPDATED_DATE_DESC", - "TITLE", - "TITLE_DESC", - "ANNUALIZED_BASE_COMPENSATION", - "ANNUALIZED_TOTAL_COMPENSATION", - "ANNUALIZED_BASE_COMPENSATION_DESC", - "ANNUALIZED_TOTAL_COMPENSATION_DESC" - ], - "enumDescriptions": [ - "Default value.", - "By descending relevance, as determined by the API algorithms. Relevance thresholding of query results is only available for queries if RELEVANCE_DESC sort ordering is specified.", - "Sort by published date descending.", - "Sort by updated date descending.", - "Sort by job title ascending.", - "Sort by job title descending.", - "Sort by job annualized base compensation in ascending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", - "Sort by job annualized total compensation in ascending order. If job's annualized total compensation is unspecified, they are put at the end of search result.", - "Sort by job annualized base compensation in descending order. If job's annualized base compensation is unspecified, they are put at the end of search result.", - "Sort by job annualized total compensation in descending order. If job's annualized total compensation is unspecified, they are put at the end of search result." - ], - "type": "string" - } - }, - "type": "object" - }, - "SearchJobsResponse": { - "description": "Output only. Response for SearchJob method.", - "id": "SearchJobsResponse", - "properties": { - "appliedCommuteFilter": { - "$ref": "CommutePreference", - "description": "The commute filter the service applied to the specified query. This information is only available when query has a valid CommutePreference." - }, - "appliedJobLocationFilters": { - "description": "The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.", - "items": { - "$ref": "JobLocation" - }, - "type": "array" - }, - "estimatedTotalSize": { - "description": "An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size.", - "format": "int64", - "type": "string" - }, - "histogramResults": { - "$ref": "HistogramResults", - "description": "The histogram results that match specified SearchJobsRequest.HistogramFacets." - }, - "jobView": { - "description": "Corresponds to SearchJobsRequest.job_view.", - "enum": [ - "JOB_VIEW_UNSPECIFIED", - "SMALL", - "MINIMAL", - "FULL" - ], - "enumDescriptions": [ - "Default value.", - "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations, Job.description, Job.visibility. Note: Job.description is deprecated. It is scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018.", - "A minimal view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.job_title, Job.company_name, Job.job_locations.", - "All available attributes are included in the search results. Note: [Job.description, Job.responsibilities, Job.qualifications and Job.incentives are deprecated. These fields are scheduled to be removed from MatchingJob.Job objects in the SearchJobsResponse results on 12/31/2018. See the alternative MatchingJob.search_text_snippet and MatchingJob.job_summary fields." - ], - "type": "string" - }, - "matchingJobs": { - "description": "The Job entities that match the specified SearchJobsRequest.", - "items": { - "$ref": "MatchingJob" - }, - "type": "array" - }, - "metadata": { - "$ref": "ResponseMetadata", - "description": "Additional information for the API invocation, such as the request tracking id." - }, - "nextPageToken": { - "description": "The token that specifies the starting position of the next page of results. This field is empty if there are no more results.", - "type": "string" - }, - "numJobsFromBroadenedQuery": { - "description": "If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0 means all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.", - "format": "int32", - "type": "integer" - }, - "spellResult": { - "$ref": "SpellingCorrection", - "description": "The spell checking result, and correction." - }, - "totalSize": { - "description": "The precise result count, which is available only if the client set enable_precise_result_size to `true` or if the response is the last page of results. Otherwise, the value will be `-1`.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "SpellingCorrection": { - "description": "Output only. Spell check result.", - "id": "SpellingCorrection", - "properties": { - "corrected": { - "description": "Indicates if the query was corrected by the spell checker.", - "type": "boolean" - }, - "correctedText": { - "description": "Correction output consisting of the corrected keyword string.", - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "StringValues": { - "description": "Represents array of string values.", - "id": "StringValues", - "properties": { - "values": { - "description": "Required. String values.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "UpdateJobRequest": { - "description": "Input only. Update job request.", - "id": "UpdateJobRequest", - "properties": { - "disableStreetAddressResolution": { - "description": "Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job.", - "type": "boolean" - }, - "job": { - "$ref": "Job", - "description": "Required. The Job to be updated." - }, - "processingOptions": { - "$ref": "JobProcessingOptions", - "description": "Optional. Options for job processing. UpdateJobRequest.disable_street_address_resolution is ignored if this flag is set." - }, - "updateJobFields": { - "description": "Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated)", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Talent Solution API", - "version": "v2", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis/jobs__v3.json b/discovery/googleapis/jobs__v3.json index e108858..31ef178 100644 --- a/discovery/googleapis/jobs__v3.json +++ b/discovery/googleapis/jobs__v3.json
@@ -634,7 +634,7 @@ } } }, - "revision": "20200929", + "revision": "20210107", "rootUrl": "https://jobs.googleapis.com/", "schemas": { "ApplicationInfo": { @@ -1316,725 +1316,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudTalentV4BatchCreateJobsResponse": { - "description": "The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.", - "id": "GoogleCloudTalentV4BatchCreateJobsResponse", - "properties": { - "jobResults": { - "description": "List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", - "items": { - "$ref": "GoogleCloudTalentV4JobResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4BatchDeleteJobsResponse": { - "description": "The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.", - "id": "GoogleCloudTalentV4BatchDeleteJobsResponse", - "properties": { - "jobResults": { - "description": "List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", - "items": { - "$ref": "GoogleCloudTalentV4JobResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4BatchOperationMetadata": { - "description": "Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.", - "id": "GoogleCloudTalentV4BatchOperationMetadata", - "properties": { - "createTime": { - "description": "The time when the batch operation is created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of failed item(s) inside an operation.", - "format": "int32", - "type": "integer" - }, - "state": { - "description": "The state of a long running operation.", - "enum": [ - "STATE_UNSPECIFIED", - "INITIALIZING", - "PROCESSING", - "SUCCEEDED", - "FAILED", - "CANCELLING", - "CANCELLED" - ], - "enumDescriptions": [ - "Default value.", - "The batch operation is being prepared for processing.", - "The batch operation is actively being processed.", - "The batch operation is processed, and at least one item has been successfully processed.", - "The batch operation is done and no item has been successfully processed.", - "The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation is called.", - "The batch operation is done after google.longrunning.Operations.CancelOperation is called. Any items processed before cancelling are returned in the response." - ], - "type": "string" - }, - "stateDescription": { - "description": "More detailed information about operation state.", - "type": "string" - }, - "successCount": { - "description": "Count of successful item(s) inside an operation.", - "format": "int32", - "type": "integer" - }, - "totalCount": { - "description": "Count of total item(s) inside an operation.", - "format": "int32", - "type": "integer" - }, - "updateTime": { - "description": "The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4BatchUpdateJobsResponse": { - "description": "The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.", - "id": "GoogleCloudTalentV4BatchUpdateJobsResponse", - "properties": { - "jobResults": { - "description": "List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", - "items": { - "$ref": "GoogleCloudTalentV4JobResult" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CompensationInfo": { - "description": "Job compensation details.", - "id": "GoogleCloudTalentV4CompensationInfo", - "properties": { - "annualizedBaseCompensationRange": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", - "readOnly": true - }, - "annualizedTotalCompensationRange": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", - "readOnly": true - }, - "entries": { - "description": "Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.", - "items": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationEntry" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CompensationInfoCompensationEntry": { - "description": "A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", - "id": "GoogleCloudTalentV4CompensationInfoCompensationEntry", - "properties": { - "amount": { - "$ref": "Money", - "description": "Compensation amount." - }, - "description": { - "description": "Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", - "type": "string" - }, - "expectedUnitsPerYear": { - "description": "Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", - "format": "double", - "type": "number" - }, - "range": { - "$ref": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "description": "Compensation range." - }, - "type": { - "description": "Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.", - "enum": [ - "COMPENSATION_TYPE_UNSPECIFIED", - "BASE", - "BONUS", - "SIGNING_BONUS", - "EQUITY", - "PROFIT_SHARING", - "COMMISSIONS", - "TIPS", - "OTHER_COMPENSATION_TYPE" - ], - "enumDescriptions": [ - "Default value.", - "Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.", - "Bonus.", - "Signing bonus.", - "Equity.", - "Profit sharing.", - "Commission.", - "Tips.", - "Other compensation type." - ], - "type": "string" - }, - "unit": { - "description": "Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", - "enum": [ - "COMPENSATION_UNIT_UNSPECIFIED", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY", - "YEARLY", - "ONE_TIME", - "OTHER_COMPENSATION_UNIT" - ], - "enumDescriptions": [ - "Default value.", - "Hourly.", - "Daily.", - "Weekly", - "Monthly.", - "Yearly.", - "One time.", - "Other compensation units." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CompensationInfoCompensationRange": { - "description": "Compensation range.", - "id": "GoogleCloudTalentV4CompensationInfoCompensationRange", - "properties": { - "maxCompensation": { - "$ref": "Money", - "description": "The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation." - }, - "minCompensation": { - "$ref": "Money", - "description": "The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation." - } - }, - "type": "object" - }, - "GoogleCloudTalentV4CustomAttribute": { - "description": "Custom attribute values that are either filterable or non-filterable.", - "id": "GoogleCloudTalentV4CustomAttribute", - "properties": { - "filterable": { - "description": "If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", - "type": "boolean" - }, - "keywordSearchable": { - "description": "If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.", - "type": "boolean" - }, - "longValues": { - "description": "Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - }, - "stringValues": { - "description": "Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4Job": { - "description": "A Job resource represents a job posting (also referred to as a \"job listing\" or \"job requisition\"). A job belongs to a Company, which is the hiring entity responsible for the job.", - "id": "GoogleCloudTalentV4Job", - "properties": { - "addresses": { - "description": "Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.", - "items": { - "type": "string" - }, - "type": "array" - }, - "applicationInfo": { - "$ref": "GoogleCloudTalentV4JobApplicationInfo", - "description": "Job application information." - }, - "company": { - "description": "Required. The resource name of the company listing the job. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\". For example, \"projects/foo/tenants/bar/companies/baz\".", - "type": "string" - }, - "companyDisplayName": { - "description": "Output only. Display name of the company listing the job.", - "readOnly": true, - "type": "string" - }, - "compensationInfo": { - "$ref": "GoogleCloudTalentV4CompensationInfo", - "description": "Job compensation information (a.k.a. \"pay rate\") i.e., the compensation that will paid to the employee." - }, - "customAttributes": { - "additionalProperties": { - "$ref": "GoogleCloudTalentV4CustomAttribute" - }, - "description": "A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", - "type": "object" - }, - "degreeTypes": { - "description": "The desired education degrees for the job, such as Bachelors, Masters.", - "items": { - "enum": [ - "DEGREE_TYPE_UNSPECIFIED", - "PRIMARY_EDUCATION", - "LOWER_SECONDARY_EDUCATION", - "UPPER_SECONDARY_EDUCATION", - "ADULT_REMEDIAL_EDUCATION", - "ASSOCIATES_OR_EQUIVALENT", - "BACHELORS_OR_EQUIVALENT", - "MASTERS_OR_EQUIVALENT", - "DOCTORAL_OR_EQUIVALENT" - ], - "enumDescriptions": [ - "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", - "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", - "Lower secondary education; First stage of secondary education building on primary education, typically with a more subject-oriented curriculum. ISCED code 2. Ex) Middle school", - "Middle education; Second/final stage of secondary education preparing for tertiary education and/or providing skills relevant to employment. Usually with an increased range of subject options and streams. ISCED code 3. Ex) High school", - "Adult Remedial Education; Programmes providing learning experiences that build on secondary education and prepare for labour market entry and/or tertiary education. The content is broader than secondary but not as complex as tertiary education. ISCED code 4.", - "Associate's or equivalent; Short first tertiary programmes that are typically practically-based, occupationally-specific and prepare for labour market entry. These programmes may also provide a pathway to other tertiary programmes. ISCED code 5.", - "Bachelor's or equivalent; Programmes designed to provide intermediate academic and/or professional knowledge, skills and competencies leading to a first tertiary degree or equivalent qualification. ISCED code 6.", - "Master's or equivalent; Programmes designed to provide advanced academic and/or professional knowledge, skills and competencies leading to a second tertiary degree or equivalent qualification. ISCED code 7.", - "Doctoral or equivalent; Programmes designed primarily to lead to an advanced research qualification, usually concluding with the submission and defense of a substantive dissertation of publishable quality based on original research. ISCED code 8." - ], - "type": "string" - }, - "type": "array" - }, - "department": { - "description": "The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", - "type": "string" - }, - "derivedInfo": { - "$ref": "GoogleCloudTalentV4JobDerivedInfo", - "description": "Output only. Derived details about the job posting.", - "readOnly": true - }, - "description": { - "description": "Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.", - "type": "string" - }, - "employmentTypes": { - "description": "The employment type(s) of a job, for example, full time or part time.", - "items": { - "enum": [ - "EMPLOYMENT_TYPE_UNSPECIFIED", - "FULL_TIME", - "PART_TIME", - "CONTRACTOR", - "CONTRACT_TO_HIRE", - "TEMPORARY", - "INTERN", - "VOLUNTEER", - "PER_DIEM", - "FLY_IN_FLY_OUT", - "OTHER_EMPLOYMENT_TYPE" - ], - "enumDescriptions": [ - "The default value if the employment type isn't specified.", - "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", - "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", - "The job is offered as a contracted, as opposed to a salaried employee, position.", - "The job is offered as a contracted position with the understanding that it's converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.", - "The job is offered as a temporary employment opportunity, usually a short-term engagement.", - "The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.", - "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", - "The job requires an employee to work on an as-needed basis with a flexible schedule.", - "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", - "The job does not fit any of the other listed types." - ], - "type": "string" - }, - "type": "array" - }, - "incentives": { - "description": "A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "jobBenefits": { - "description": "The benefits included with the job.", - "items": { - "enum": [ - "JOB_BENEFIT_UNSPECIFIED", - "CHILD_CARE", - "DENTAL", - "DOMESTIC_PARTNER", - "FLEXIBLE_HOURS", - "MEDICAL", - "LIFE_INSURANCE", - "PARENTAL_LEAVE", - "RETIREMENT_PLAN", - "SICK_DAYS", - "VACATION", - "VISION" - ], - "enumDescriptions": [ - "Default value if the type isn't specified.", - "The job includes access to programs that support child care, such as daycare.", - "The job includes dental services covered by a dental insurance plan.", - "The job offers specific benefits to domestic partners.", - "The job allows for a flexible work schedule.", - "The job includes health services covered by a medical insurance plan.", - "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", - "The job allows for a leave of absence to a parent to care for a newborn child.", - "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", - "The job allows for paid time off due to illness.", - "The job includes paid time off for vacation.", - "The job includes vision services covered by a vision insurance plan." - ], - "type": "string" - }, - "type": "array" - }, - "jobEndTime": { - "description": "The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", - "format": "google-datetime", - "type": "string" - }, - "jobLevel": { - "description": "The experience level associated with the job, such as \"Entry Level\".", - "enum": [ - "JOB_LEVEL_UNSPECIFIED", - "ENTRY_LEVEL", - "EXPERIENCED", - "MANAGER", - "DIRECTOR", - "EXECUTIVE" - ], - "enumDescriptions": [ - "The default value if the level isn't specified.", - "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", - "Experienced individual contributors, typically with 2+ years of experience in a similar role.", - "Entry- to mid-level managers responsible for managing a team of people.", - "Senior-level managers responsible for managing teams of managers.", - "Executive-level managers and above, including C-level positions." - ], - "type": "string" - }, - "jobStartTime": { - "description": "The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", - "format": "google-datetime", - "type": "string" - }, - "languageCode": { - "description": "The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", - "type": "string" - }, - "name": { - "description": "Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\". For example, \"projects/foo/tenants/bar/jobs/baz\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", - "type": "string" - }, - "postingCreateTime": { - "description": "Output only. The timestamp when this job posting was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "postingExpireTime": { - "description": "Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.", - "format": "google-datetime", - "type": "string" - }, - "postingPublishTime": { - "description": "The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.", - "format": "google-datetime", - "type": "string" - }, - "postingRegion": { - "description": "The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", - "enum": [ - "POSTING_REGION_UNSPECIFIED", - "ADMINISTRATIVE_AREA", - "NATION", - "TELECOMMUTE" - ], - "enumDescriptions": [ - "If the region is unspecified, the job is only returned if it matches the LocationFilter.", - "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if LocationFilter has \"Mountain View\". Administrative area refers to top-level administrative subdivision of this country. For example, US state, IT region, UK constituent nation and JP prefecture.", - "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", - "Job allows employees to work remotely (telecommute). If locations are provided with this value, the job is considered as having a location, but telecommuting is allowed." - ], - "type": "string" - }, - "postingUpdateTime": { - "description": "Output only. The timestamp when this job posting was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "processingOptions": { - "$ref": "GoogleCloudTalentV4JobProcessingOptions", - "description": "Options for job processing." - }, - "promotionValue": { - "description": "A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.", - "format": "int32", - "type": "integer" - }, - "qualifications": { - "description": "A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "requisitionId": { - "description": "Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id. The maximum number of allowed characters is 255.", - "type": "string" - }, - "responsibilities": { - "description": "A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", - "type": "string" - }, - "title": { - "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", - "type": "string" - }, - "visibility": { - "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", - "enum": [ - "VISIBILITY_UNSPECIFIED", - "ACCOUNT_ONLY", - "SHARED_WITH_GOOGLE", - "SHARED_WITH_PUBLIC" - ], - "enumDescriptions": [ - "Default value.", - "The resource is only visible to the GCP account who owns it.", - "The resource is visible to the owner and may be visible to other applications and processes at Google.", - "The resource is visible to the owner and may be visible to all other API clients." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobApplicationInfo": { - "description": "Application related details of a job posting.", - "id": "GoogleCloudTalentV4JobApplicationInfo", - "properties": { - "emails": { - "description": "Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255.", - "items": { - "type": "string" - }, - "type": "array" - }, - "instruction": { - "description": "Use this field to provide instructions, such as \"Mail your application to ...\", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.", - "type": "string" - }, - "uris": { - "description": "Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobDerivedInfo": { - "description": "Derived details about the job posting.", - "id": "GoogleCloudTalentV4JobDerivedInfo", - "properties": { - "jobCategories": { - "description": "Job categories derived from Job.title and Job.description.", - "items": { - "enum": [ - "JOB_CATEGORY_UNSPECIFIED", - "ACCOUNTING_AND_FINANCE", - "ADMINISTRATIVE_AND_OFFICE", - "ADVERTISING_AND_MARKETING", - "ANIMAL_CARE", - "ART_FASHION_AND_DESIGN", - "BUSINESS_OPERATIONS", - "CLEANING_AND_FACILITIES", - "COMPUTER_AND_IT", - "CONSTRUCTION", - "CUSTOMER_SERVICE", - "EDUCATION", - "ENTERTAINMENT_AND_TRAVEL", - "FARMING_AND_OUTDOORS", - "HEALTHCARE", - "HUMAN_RESOURCES", - "INSTALLATION_MAINTENANCE_AND_REPAIR", - "LEGAL", - "MANAGEMENT", - "MANUFACTURING_AND_WAREHOUSE", - "MEDIA_COMMUNICATIONS_AND_WRITING", - "OIL_GAS_AND_MINING", - "PERSONAL_CARE_AND_SERVICES", - "PROTECTIVE_SERVICES", - "REAL_ESTATE", - "RESTAURANT_AND_HOSPITALITY", - "SALES_AND_RETAIL", - "SCIENCE_AND_ENGINEERING", - "SOCIAL_SERVICES_AND_NON_PROFIT", - "SPORTS_FITNESS_AND_RECREATION", - "TRANSPORTATION_AND_LOGISTICS" - ], - "enumDescriptions": [ - "The default value if the category isn't specified.", - "An accounting and finance job, such as an Accountant.", - "An administrative and office job, such as an Administrative Assistant.", - "An advertising and marketing job, such as Marketing Manager.", - "An animal care job, such as Veterinarian.", - "An art, fashion, or design job, such as Designer.", - "A business operations job, such as Business Operations Manager.", - "A cleaning and facilities job, such as Custodial Staff.", - "A computer and IT job, such as Systems Administrator.", - "A construction job, such as General Laborer.", - "A customer service job, such s Cashier.", - "An education job, such as School Teacher.", - "An entertainment and travel job, such as Flight Attendant.", - "A farming or outdoor job, such as Park Ranger.", - "A healthcare job, such as Registered Nurse.", - "A human resources job, such as Human Resources Director.", - "An installation, maintenance, or repair job, such as Electrician.", - "A legal job, such as Law Clerk.", - "A management job, often used in conjunction with another category, such as Store Manager.", - "A manufacturing or warehouse job, such as Assembly Technician.", - "A media, communications, or writing job, such as Media Relations.", - "An oil, gas or mining job, such as Offshore Driller.", - "A personal care and services job, such as Hair Stylist.", - "A protective services job, such as Security Guard.", - "A real estate job, such as Buyer's Agent.", - "A restaurant and hospitality job, such as Restaurant Server.", - "A sales and/or retail job, such Sales Associate.", - "A science and engineering job, such as Lab Technician.", - "A social services or non-profit job, such as Case Worker.", - "A sports, fitness, or recreation job, such as Personal Trainer.", - "A transportation or logistics job, such as Truck Driver." - ], - "type": "string" - }, - "type": "array" - }, - "locations": { - "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", - "items": { - "$ref": "GoogleCloudTalentV4Location" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobProcessingOptions": { - "description": "Options for job processing.", - "id": "GoogleCloudTalentV4JobProcessingOptions", - "properties": { - "disableStreetAddressResolution": { - "description": "If set to `true`, the service does not attempt to resolve a more precise address for the job.", - "type": "boolean" - }, - "htmlSanitization": { - "description": "Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation isn't disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", - "enum": [ - "HTML_SANITIZATION_UNSPECIFIED", - "HTML_SANITIZATION_DISABLED", - "SIMPLE_FORMATTING_ONLY" - ], - "enumDescriptions": [ - "Default value.", - "Disables sanitization on HTML input.", - "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudTalentV4JobResult": { - "description": "Mutation result of a job from a batch operation.", - "id": "GoogleCloudTalentV4JobResult", - "properties": { - "job": { - "$ref": "GoogleCloudTalentV4Job", - "description": "Here Job only contains basic information including name, company, language_code and requisition_id, use getJob method to retrieve detailed information of the created/updated job." - }, - "status": { - "$ref": "Status", - "description": "The status of the job processed. This field is populated if the processing of the job fails." - } - }, - "type": "object" - }, - "GoogleCloudTalentV4Location": { - "description": "A resource that represents a location with full geographic information.", - "id": "GoogleCloudTalentV4Location", - "properties": { - "latLng": { - "$ref": "LatLng", - "description": "An object representing a latitude/longitude pair." - }, - "locationType": { - "description": "The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType.NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType.LOCALITY.", - "enum": [ - "LOCATION_TYPE_UNSPECIFIED", - "COUNTRY", - "ADMINISTRATIVE_AREA", - "SUB_ADMINISTRATIVE_AREA", - "LOCALITY", - "POSTAL_CODE", - "SUB_LOCALITY", - "SUB_LOCALITY_1", - "SUB_LOCALITY_2", - "NEIGHBORHOOD", - "STREET_ADDRESS" - ], - "enumDescriptions": [ - "Default value if the type isn't specified.", - "A country level location.", - "A state or equivalent level location.", - "A county or equivalent level location.", - "A city or equivalent level location.", - "A postal code level location.", - "A sublocality is a subdivision of a locality, for example a city borough, ward, or arrondissement. Sublocalities are usually recognized by a local political authority. For example, Manhattan and Brooklyn are recognized as boroughs by the City of New York, and are therefore modeled as sublocalities.", - "A district or equivalent level location.", - "A smaller district or equivalent level display.", - "A neighborhood level location.", - "A street address level location." - ], - "type": "string" - }, - "postalAddress": { - "$ref": "PostalAddress", - "description": "Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location." - }, - "radiusMiles": { - "description": "Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, "HistogramFacets": { "description": "Input only. Histogram facets to be specified in SearchJobsRequest.", "id": "HistogramFacets", @@ -2764,7 +2045,7 @@ "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -2958,7 +2239,7 @@ "id": "Money", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { @@ -3395,33 +2676,6 @@ }, "type": "object" }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay",
diff --git a/discovery/googleapis/jobs__v4.json b/discovery/googleapis/jobs__v4.json new file mode 100644 index 0000000..1167983 --- /dev/null +++ b/discovery/googleapis/jobs__v4.json
@@ -0,0 +1,2924 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/jobs": { + "description": "Manage job postings" + } + } + } + }, + "basePath": "", + "baseUrl": "https://jobs.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Talent Solution", + "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "jobs:v4", + "kind": "discovery#restDescription", + "name": "jobs", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "tenants": { + "methods": { + "completeQuery": { + "description": "Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.", + "httpMethod": "GET", + "id": "jobs.projects.tenants.completeQuery", + "parameterOrder": [ + "tenant" + ], + "parameters": { + "company": { + "description": "If provided, restricts completion to specified company. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\", for example, \"projects/foo/tenants/bar/companies/baz\".", + "location": "query", + "type": "string" + }, + "languageCodes": { + "description": "The list of languages of the query. This is the BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of allowed characters is 255.", + "location": "query", + "repeated": true, + "type": "string" + }, + "pageSize": { + "description": "Required. Completion result count. The maximum allowed page size is 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "query": { + "description": "Required. The query used to generate suggestions. The maximum number of allowed characters is 255.", + "location": "query", + "type": "string" + }, + "scope": { + "description": "The scope of the completion. The defaults is CompletionScope.PUBLIC.", + "enum": [ + "COMPLETION_SCOPE_UNSPECIFIED", + "TENANT", + "PUBLIC" + ], + "enumDescriptions": [ + "Default value.", + "Suggestions are based only on the data provided by the client.", + "Suggestions are based on all jobs data in the system that's visible to the client" + ], + "location": "query", + "type": "string" + }, + "tenant": { + "description": "Required. Resource name of tenant the completion is performed within. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + }, + "type": { + "description": "The completion topic. The default is CompletionType.COMBINED.", + "enum": [ + "COMPLETION_TYPE_UNSPECIFIED", + "JOB_TITLE", + "COMPANY_NAME", + "COMBINED" + ], + "enumDescriptions": [ + "Default value.", + "Suggest job titles for jobs autocomplete. For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned.", + "Suggest company names for jobs autocomplete. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned.", + "Suggest both job titles and company names for jobs autocomplete. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned." + ], + "location": "query", + "type": "string" + } + }, + "path": "v4/{+tenant}:completeQuery", + "response": { + "$ref": "CompleteQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "create": { + "description": "Creates a new tenant entity.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the project under which the tenant is created. The format is \"projects/{project_id}\", for example, \"projects/foo\".", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/tenants", + "request": { + "$ref": "Tenant" + }, + "response": { + "$ref": "Tenant" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "delete": { + "description": "Deletes specified tenant.", + "httpMethod": "DELETE", + "id": "jobs.projects.tenants.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the tenant to be deleted. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "get": { + "description": "Retrieves specified tenant.", + "httpMethod": "GET", + "id": "jobs.projects.tenants.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the tenant to be retrieved. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Tenant" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "list": { + "description": "Lists all tenants associated with the project.", + "httpMethod": "GET", + "id": "jobs.projects.tenants.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of tenants to be returned, at most 100. Default is 100 if a non-positive number is provided.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The starting indicator from which to return results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the project under which the tenant is created. The format is \"projects/{project_id}\", for example, \"projects/foo\".", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/tenants", + "response": { + "$ref": "ListTenantsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "patch": { + "description": "Updates specified tenant.", + "httpMethod": "PATCH", + "id": "jobs.projects.tenants.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in tenant are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/{+name}", + "request": { + "$ref": "Tenant" + }, + "response": { + "$ref": "Tenant" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + } + }, + "resources": { + "clientEvents": { + "methods": { + "create": { + "description": "Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in [self service tools](https://console.cloud.google.com/talent-solution/overview). [Learn more](https://cloud.google.com/talent-solution/docs/management-tools) about self service tools.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.clientEvents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the tenant under which the event is created. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/clientEvents", + "request": { + "$ref": "ClientEvent" + }, + "response": { + "$ref": "ClientEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + } + } + }, + "companies": { + "methods": { + "create": { + "description": "Creates a new company entity.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.companies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the tenant under which the company is created. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/companies", + "request": { + "$ref": "Company" + }, + "response": { + "$ref": "Company" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "delete": { + "description": "Deletes specified company. Prerequisite: The company has no jobs associated with it.", + "httpMethod": "DELETE", + "id": "jobs.projects.tenants.companies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the company to be deleted. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\", for example, \"projects/foo/tenants/bar/companies/baz\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+/companies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "get": { + "description": "Retrieves specified company.", + "httpMethod": "GET", + "id": "jobs.projects.tenants.companies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the company to be retrieved. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\", for example, \"projects/api-test-project/tenants/foo/companies/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+/companies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Company" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "list": { + "description": "Lists all companies associated with the project.", + "httpMethod": "GET", + "id": "jobs.projects.tenants.companies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The starting indicator from which to return results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the tenant under which the company is created. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + }, + "requireOpenJobs": { + "description": "Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.", + "location": "query", + "type": "boolean" + } + }, + "path": "v4/{+parent}/companies", + "response": { + "$ref": "ListCompaniesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "patch": { + "description": "Updates specified company.", + "httpMethod": "PATCH", + "id": "jobs.projects.tenants.companies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\", for example, \"projects/foo/tenants/bar/companies/baz\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+/companies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/{+name}", + "request": { + "$ref": "Company" + }, + "response": { + "$ref": "Company" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + } + } + }, + "jobs": { + "methods": { + "batchCreate": { + "description": "Begins executing a batch create jobs operation.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.jobs.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the tenant under which the job is created. The format is \"projects/{project_id}/tenants/{tenant_id}\". For example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/jobs:batchCreate", + "request": { + "$ref": "BatchCreateJobsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "batchDelete": { + "description": "Begins executing a batch delete jobs operation.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.jobs.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the tenant under which the job is created. The format is \"projects/{project_id}/tenants/{tenant_id}\". For example, \"projects/foo/tenants/bar\". The parent of all of the jobs specified in `names` must match this field.", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/jobs:batchDelete", + "request": { + "$ref": "BatchDeleteJobsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "batchUpdate": { + "description": "Begins executing a batch update jobs operation.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.jobs.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the tenant under which the job is created. The format is \"projects/{project_id}/tenants/{tenant_id}\". For example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/jobs:batchUpdate", + "request": { + "$ref": "BatchUpdateJobsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "create": { + "description": "Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.jobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the tenant under which the job is created. The format is \"projects/{project_id}/tenants/{tenant_id}\". For example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/jobs", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "delete": { + "description": "Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.", + "httpMethod": "DELETE", + "id": "jobs.projects.tenants.jobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the job to be deleted. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\". For example, \"projects/foo/tenants/bar/jobs/baz\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "get": { + "description": "Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.", + "httpMethod": "GET", + "id": "jobs.projects.tenants.jobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the job to retrieve. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\". For example, \"projects/foo/tenants/bar/jobs/baz\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+name}", + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "list": { + "description": "Lists jobs by filter.", + "httpMethod": "GET", + "id": "jobs.projects.tenants.jobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` * `status` Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. Sample Query: * companyName = \"projects/foo/tenants/bar/companies/baz\" * companyName = \"projects/foo/tenants/bar/companies/baz\" AND requisitionId = \"req-1\" * companyName = \"projects/foo/tenants/bar/companies/baz\" AND status = \"EXPIRED\"", + "location": "query", + "type": "string" + }, + "jobView": { + "description": "The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.", + "enum": [ + "JOB_VIEW_UNSPECIFIED", + "JOB_VIEW_ID_ONLY", + "JOB_VIEW_MINIMAL", + "JOB_VIEW_SMALL", + "JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "Default value.", + "A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.", + "A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company, Job.DerivedInfo.locations, Job.language_code.", + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.", + "All available attributes are included in the search results." + ], + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The starting point of a query result.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the tenant under which the job is created. The format is \"projects/{project_id}/tenants/{tenant_id}\". For example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/jobs", + "response": { + "$ref": "ListJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "patch": { + "description": "Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.", + "httpMethod": "PATCH", + "id": "jobs.projects.tenants.jobs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\". For example, \"projects/foo/tenants/bar/jobs/baz\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/{+name}", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "search": { + "description": "Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.jobs.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the tenant to search within. The format is \"projects/{project_id}/tenants/{tenant_id}\". For example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/jobs:search", + "request": { + "$ref": "SearchJobsRequest" + }, + "response": { + "$ref": "SearchJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + }, + "searchForAlert": { + "description": "Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), it has different algorithmic adjustments that are designed to specifically target passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.", + "httpMethod": "POST", + "id": "jobs.projects.tenants.jobs.searchForAlert", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the tenant to search within. The format is \"projects/{project_id}/tenants/{tenant_id}\". For example, \"projects/foo/tenants/bar\".", + "location": "path", + "pattern": "^projects/[^/]+/tenants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/{+parent}/jobs:searchForAlert", + "request": { + "$ref": "SearchJobsRequest" + }, + "response": { + "$ref": "SearchJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/jobs" + ] + } + } + } + } + } + } + } + }, + "revision": "20210107", + "rootUrl": "https://jobs.googleapis.com/", + "schemas": { + "ApplicationInfo": { + "description": "Application related details of a job posting.", + "id": "ApplicationInfo", + "properties": { + "emails": { + "description": "Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters for each entry is 255.", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Use this field to provide instructions, such as \"Mail your application to ...\", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.", + "type": "string" + }, + "uris": { + "description": "Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchCreateJobsRequest": { + "description": "Request to create a batch of jobs.", + "id": "BatchCreateJobsRequest", + "properties": { + "jobs": { + "description": "Required. The jobs to be created. A maximum of 200 jobs can be created in a batch.", + "items": { + "$ref": "Job" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchCreateJobsResponse": { + "description": "The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "BatchCreateJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch create operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", + "items": { + "$ref": "JobResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchDeleteJobsRequest": { + "description": "Request to delete a batch of jobs.", + "id": "BatchDeleteJobsRequest", + "properties": { + "names": { + "description": "The names of the jobs to delete. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\". For example, \"projects/foo/tenants/bar/jobs/baz\". A maximum of 200 jobs can be deleted in a batch.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchDeleteJobsResponse": { + "description": "The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "BatchDeleteJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch delete operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", + "items": { + "$ref": "JobResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchOperationMetadata": { + "description": "Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.", + "id": "BatchOperationMetadata", + "properties": { + "createTime": { + "description": "The time when the batch operation is created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of failed item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "The state of a long running operation.", + "enum": [ + "STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "SUCCEEDED", + "FAILED", + "CANCELLING", + "CANCELLED" + ], + "enumDescriptions": [ + "Default value.", + "The batch operation is being prepared for processing.", + "The batch operation is actively being processed.", + "The batch operation is processed, and at least one item has been successfully processed.", + "The batch operation is done and no item has been successfully processed.", + "The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation is called.", + "The batch operation is done after google.longrunning.Operations.CancelOperation is called. Any items processed before cancelling are returned in the response." + ], + "type": "string" + }, + "stateDescription": { + "description": "More detailed information about operation state.", + "type": "string" + }, + "successCount": { + "description": "Count of successful item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Count of total item(s) inside an operation.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "BatchUpdateJobsRequest": { + "description": "Request to update a batch of jobs.", + "id": "BatchUpdateJobsRequest", + "properties": { + "jobs": { + "description": "Required. The jobs to be updated. A maximum of 200 jobs can be updated in a batch.", + "items": { + "$ref": "Job" + }, + "type": "array" + }, + "updateMask": { + "description": "Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation. If update_mask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported. If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "BatchUpdateJobsResponse": { + "description": "The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.", + "id": "BatchUpdateJobsResponse", + "properties": { + "jobResults": { + "description": "List of job mutation results from a batch update operation. It can change until operation status is FINISHED, FAILED or CANCELLED.", + "items": { + "$ref": "JobResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClientEvent": { + "description": "An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.", + "id": "ClientEvent", + "properties": { + "createTime": { + "description": "Required. The timestamp of the event.", + "format": "google-datetime", + "type": "string" + }, + "eventId": { + "description": "Required. A unique identifier, generated by the client application.", + "type": "string" + }, + "eventNotes": { + "description": "Notes about the event provided by recruiters or other users, for example, feedback on why a job was bookmarked.", + "type": "string" + }, + "jobEvent": { + "$ref": "JobEvent", + "description": "An event issued when a job seeker interacts with the application that implements Cloud Talent Solution." + }, + "requestId": { + "description": "Strongly recommended for the best service experience. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id.", + "type": "string" + } + }, + "type": "object" + }, + "CommuteFilter": { + "description": "Parameters needed for commute search.", + "id": "CommuteFilter", + "properties": { + "allowImpreciseAddresses": { + "description": "If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or isn't specified, only jobs that include street level addresses will be returned by commute search.", + "type": "boolean" + }, + "commuteMethod": { + "description": "Required. The method of transportation to calculate the commute time for.", + "enum": [ + "COMMUTE_METHOD_UNSPECIFIED", + "DRIVING", + "TRANSIT" + ], + "enumDescriptions": [ + "Commute method isn't specified.", + "Commute time is calculated based on driving time.", + "Commute time is calculated based on public transit including bus, metro, subway, and so on." + ], + "type": "string" + }, + "departureTime": { + "$ref": "TimeOfDay", + "description": "The departure time used to calculate traffic impact, represented as google.type.TimeOfDay in local time zone. Currently traffic model is restricted to hour level resolution." + }, + "roadTraffic": { + "description": "Specifies the traffic density to use when calculating commute time.", + "enum": [ + "ROAD_TRAFFIC_UNSPECIFIED", + "TRAFFIC_FREE", + "BUSY_HOUR" + ], + "enumDescriptions": [ + "Road traffic situation isn't specified.", + "Optimal commute time without considering any traffic impact.", + "Commute time calculation takes in account the peak traffic impact." + ], + "type": "string" + }, + "startCoordinates": { + "$ref": "LatLng", + "description": "Required. The latitude and longitude of the location to calculate the commute time from." + }, + "travelDuration": { + "description": "Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "CommuteInfo": { + "description": "Commute details related to this job.", + "id": "CommuteInfo", + "properties": { + "jobLocation": { + "$ref": "Location", + "description": "Location used as the destination in the commute calculation." + }, + "travelDuration": { + "description": "The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job isn't reachable within the requested duration, but was returned as part of an expanded query.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "Company": { + "description": "A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.", + "id": "Company", + "properties": { + "careerSiteUri": { + "description": "The URI to employer's career site or careers page on the employer's web site, for example, \"https://careers.google.com\".", + "type": "string" + }, + "derivedInfo": { + "$ref": "CompanyDerivedInfo", + "description": "Output only. Derived details about the company.", + "readOnly": true + }, + "displayName": { + "description": "Required. The display name of the company, for example, \"Google LLC\".", + "type": "string" + }, + "eeoText": { + "description": "Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.", + "type": "string" + }, + "externalId": { + "description": "Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255.", + "type": "string" + }, + "headquartersAddress": { + "description": "The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location.", + "type": "string" + }, + "hiringAgency": { + "description": "Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.", + "type": "boolean" + }, + "imageUri": { + "description": "A URI that hosts the employer's company logo.", + "type": "string" + }, + "keywordSearchableJobCustomAttributes": { + "description": "A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword searches. Jobs with `string_values` under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\", for example, \"projects/foo/tenants/bar/companies/baz\".", + "type": "string" + }, + "size": { + "description": "The employer's company size.", + "enum": [ + "COMPANY_SIZE_UNSPECIFIED", + "MINI", + "SMALL", + "SMEDIUM", + "MEDIUM", + "BIG", + "BIGGER", + "GIANT" + ], + "enumDescriptions": [ + "Default value if the size isn't specified.", + "The company has less than 50 employees.", + "The company has between 50 and 99 employees.", + "The company has between 100 and 499 employees.", + "The company has between 500 and 999 employees.", + "The company has between 1,000 and 4,999 employees.", + "The company has between 5,000 and 9,999 employees.", + "The company has 10,000 or more employees." + ], + "type": "string" + }, + "suspended": { + "description": "Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.", + "readOnly": true, + "type": "boolean" + }, + "websiteUri": { + "description": "The URI representing the company's primary web site or home page, for example, \"https://www.google.com\". The maximum number of allowed characters is 255.", + "type": "string" + } + }, + "type": "object" + }, + "CompanyDerivedInfo": { + "description": "Derived details about the company.", + "id": "CompanyDerivedInfo", + "properties": { + "headquartersLocation": { + "$ref": "Location", + "description": "A structured headquarters location of the company, resolved from Company.headquarters_address if provided." + } + }, + "type": "object" + }, + "CompensationEntry": { + "description": "A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.", + "id": "CompensationEntry", + "properties": { + "amount": { + "$ref": "Money", + "description": "Compensation amount." + }, + "description": { + "description": "Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.", + "type": "string" + }, + "expectedUnitsPerYear": { + "description": "Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1", + "format": "double", + "type": "number" + }, + "range": { + "$ref": "CompensationRange", + "description": "Compensation range." + }, + "type": { + "description": "Compensation type. Default is CompensationType.COMPENSATION_TYPE_UNSPECIFIED.", + "enum": [ + "COMPENSATION_TYPE_UNSPECIFIED", + "BASE", + "BONUS", + "SIGNING_BONUS", + "EQUITY", + "PROFIT_SHARING", + "COMMISSIONS", + "TIPS", + "OTHER_COMPENSATION_TYPE" + ], + "enumDescriptions": [ + "Default value.", + "Base compensation: Refers to the fixed amount of money paid to an employee by an employer in return for work performed. Base compensation does not include benefits, bonuses or any other potential compensation from an employer.", + "Bonus.", + "Signing bonus.", + "Equity.", + "Profit sharing.", + "Commission.", + "Tips.", + "Other compensation type." + ], + "type": "string" + }, + "unit": { + "description": "Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.", + "enum": [ + "COMPENSATION_UNIT_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY", + "ONE_TIME", + "OTHER_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "Default value.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], + "type": "string" + } + }, + "type": "object" + }, + "CompensationFilter": { + "description": "Filter on job compensation type and amount.", + "id": "CompensationFilter", + "properties": { + "includeJobsWithUnspecifiedCompensationRange": { + "description": "If set to true, jobs with unspecified compensation range fields are included.", + "type": "boolean" + }, + "range": { + "$ref": "CompensationRange", + "description": "Compensation range." + }, + "type": { + "description": "Required. Type of filter.", + "enum": [ + "FILTER_TYPE_UNSPECIFIED", + "UNIT_ONLY", + "UNIT_AND_AMOUNT", + "ANNUALIZED_BASE_AMOUNT", + "ANNUALIZED_TOTAL_AMOUNT" + ], + "enumDescriptions": [ + "Filter type unspecified. Position holder, INVALID, should never be used.", + "Filter by `base compensation entry's` unit. A job is a match if and only if the job contains a base CompensationEntry and the base CompensationEntry's unit matches provided units. Populate one or more units. See CompensationInfo.CompensationEntry for definition of base compensation entry.", + "Filter by `base compensation entry's` unit and amount / range. A job is a match if and only if the job contains a base CompensationEntry, and the base entry's unit matches provided CompensationUnit and amount or range overlaps with provided CompensationRange. See CompensationInfo.CompensationEntry for definition of base compensation entry. Set exactly one units and populate range.", + "Filter by annualized base compensation amount and `base compensation entry's` unit. Populate range and zero or more units.", + "Filter by annualized total compensation amount and `base compensation entry's` unit . Populate range and zero or more units." + ], + "type": "string" + }, + "units": { + "description": "Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.", + "items": { + "enum": [ + "COMPENSATION_UNIT_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY", + "ONE_TIME", + "OTHER_COMPENSATION_UNIT" + ], + "enumDescriptions": [ + "Default value.", + "Hourly.", + "Daily.", + "Weekly", + "Monthly.", + "Yearly.", + "One time.", + "Other compensation units." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CompensationInfo": { + "description": "Job compensation details.", + "id": "CompensationInfo", + "properties": { + "annualizedBaseCompensationRange": { + "$ref": "CompensationRange", + "description": "Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true + }, + "annualizedTotalCompensationRange": { + "$ref": "CompensationRange", + "description": "Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.amount times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.", + "readOnly": true + }, + "entries": { + "description": "Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as **base compensation entry** for the job.", + "items": { + "$ref": "CompensationEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "CompensationRange": { + "description": "Compensation range.", + "id": "CompensationRange", + "properties": { + "maxCompensation": { + "$ref": "Money", + "description": "The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation." + }, + "minCompensation": { + "$ref": "Money", + "description": "The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation." + } + }, + "type": "object" + }, + "CompleteQueryResponse": { + "description": "Response of auto-complete query.", + "id": "CompleteQueryResponse", + "properties": { + "completionResults": { + "description": "Results of the matching job/company candidates.", + "items": { + "$ref": "CompletionResult" + }, + "type": "array" + }, + "metadata": { + "$ref": "ResponseMetadata", + "description": "Additional information for the API invocation, such as the request tracking id." + } + }, + "type": "object" + }, + "CompletionResult": { + "description": "Resource that represents completion results.", + "id": "CompletionResult", + "properties": { + "imageUri": { + "description": "The URI of the company image for COMPANY_NAME.", + "type": "string" + }, + "suggestion": { + "description": "The suggestion for the query.", + "type": "string" + }, + "type": { + "description": "The completion topic.", + "enum": [ + "COMPLETION_TYPE_UNSPECIFIED", + "JOB_TITLE", + "COMPANY_NAME", + "COMBINED" + ], + "enumDescriptions": [ + "Default value.", + "Suggest job titles for jobs autocomplete. For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned.", + "Suggest company names for jobs autocomplete. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned.", + "Suggest both job titles and company names for jobs autocomplete. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned." + ], + "type": "string" + } + }, + "type": "object" + }, + "CustomAttribute": { + "description": "Custom attribute values that are either filterable or non-filterable.", + "id": "CustomAttribute", + "properties": { + "filterable": { + "description": "If the `filterable` flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters. Default is false.", + "type": "boolean" + }, + "keywordSearchable": { + "description": "If the `keyword_searchable` flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match. Default is false.", + "type": "boolean" + }, + "longValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. Currently at most 1 long_values is supported.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "stringValues": { + "description": "Exactly one of string_values or long_values must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 500B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty string isn't allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomRankingInfo": { + "description": "Custom ranking information for SearchJobsRequest.", + "id": "CustomRankingInfo", + "properties": { + "importanceLevel": { + "description": "Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position. An error is thrown if not specified.", + "enum": [ + "IMPORTANCE_LEVEL_UNSPECIFIED", + "NONE", + "LOW", + "MILD", + "MEDIUM", + "HIGH", + "EXTREME" + ], + "enumDescriptions": [ + "Default value if the importance level isn't specified.", + "The given ranking expression is of None importance, existing relevance score (determined by API algorithm) dominates job's final ranking position.", + "The given ranking expression is of Low importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).", + "The given ranking expression is of Mild importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).", + "The given ranking expression is of Medium importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).", + "The given ranking expression is of High importance in terms of job's final ranking position compared to existing relevance score (determined by API algorithm).", + "The given ranking expression is of Extreme importance, and dominates job's final ranking position with existing relevance score (determined by API algorithm) ignored." + ], + "type": "string" + }, + "rankingExpression": { + "description": "Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)", + "type": "string" + } + }, + "type": "object" + }, + "DeviceInfo": { + "description": "Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.", + "id": "DeviceInfo", + "properties": { + "deviceType": { + "description": "Type of the device.", + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "WEB", + "MOBILE_WEB", + "ANDROID", + "IOS", + "BOT", + "OTHER" + ], + "enumDescriptions": [ + "The device type isn't specified.", + "A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)", + "A mobile device web browser, such as a phone or tablet with a Chrome browser.", + "An Android device native application.", + "An iOS device native application.", + "A bot, as opposed to a device operated by human beings, such as a web crawler.", + "Other devices types." + ], + "type": "string" + }, + "id": { + "description": "A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "HistogramQuery": { + "description": "The histogram request.", + "id": "HistogramQuery", + "properties": { + "histogramQuery": { + "description": "An expression specifies a histogram request against matching jobs for searches. See SearchJobsRequest.histogram_queries for details about syntax.", + "type": "string" + } + }, + "type": "object" + }, + "HistogramQueryResult": { + "description": "Histogram result that matches HistogramQuery specified in searches.", + "id": "HistogramQueryResult", + "properties": { + "histogram": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: * (for string histogram) string values stored in the field. * (for named numeric bucket) name specified in `bucket()` function, like for `bucket(0, MAX, \"non-negative\")`, the key will be `non-negative`. * (for anonymous numeric bucket) range formatted as `-`, for example, `0-1000`, `MIN-0`, and `0-MAX`.", + "type": "object" + }, + "histogramQuery": { + "description": "Requested histogram expression.", + "type": "string" + } + }, + "type": "object" + }, + "Job": { + "description": "A Job resource represents a job posting (also referred to as a \"job listing\" or \"job requisition\"). A job belongs to a Company, which is the hiring entity responsible for the job.", + "id": "Job", + "properties": { + "addresses": { + "description": "Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.", + "items": { + "type": "string" + }, + "type": "array" + }, + "applicationInfo": { + "$ref": "ApplicationInfo", + "description": "Job application information." + }, + "company": { + "description": "Required. The resource name of the company listing the job. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\". For example, \"projects/foo/tenants/bar/companies/baz\".", + "type": "string" + }, + "companyDisplayName": { + "description": "Output only. Display name of the company listing the job.", + "readOnly": true, + "type": "string" + }, + "compensationInfo": { + "$ref": "CompensationInfo", + "description": "Job compensation information (a.k.a. \"pay rate\") i.e., the compensation that will paid to the employee." + }, + "customAttributes": { + "additionalProperties": { + "$ref": "CustomAttribute" + }, + "description": "A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.", + "type": "object" + }, + "degreeTypes": { + "description": "The desired education degrees for the job, such as Bachelors, Masters.", + "items": { + "enum": [ + "DEGREE_TYPE_UNSPECIFIED", + "PRIMARY_EDUCATION", + "LOWER_SECONDARY_EDUCATION", + "UPPER_SECONDARY_EDUCATION", + "ADULT_REMEDIAL_EDUCATION", + "ASSOCIATES_OR_EQUIVALENT", + "BACHELORS_OR_EQUIVALENT", + "MASTERS_OR_EQUIVALENT", + "DOCTORAL_OR_EQUIVALENT" + ], + "enumDescriptions": [ + "Default value. Represents no degree, or early childhood education. Maps to ISCED code 0. Ex) Kindergarten", + "Primary education which is typically the first stage of compulsory education. ISCED code 1. Ex) Elementary school", + "Lower secondary education; First stage of secondary education building on primary education, typically with a more subject-oriented curriculum. ISCED code 2. Ex) Middle school", + "Middle education; Second/final stage of secondary education preparing for tertiary education and/or providing skills relevant to employment. Usually with an increased range of subject options and streams. ISCED code 3. Ex) High school", + "Adult Remedial Education; Programmes providing learning experiences that build on secondary education and prepare for labour market entry and/or tertiary education. The content is broader than secondary but not as complex as tertiary education. ISCED code 4.", + "Associate's or equivalent; Short first tertiary programmes that are typically practically-based, occupationally-specific and prepare for labour market entry. These programmes may also provide a pathway to other tertiary programmes. ISCED code 5.", + "Bachelor's or equivalent; Programmes designed to provide intermediate academic and/or professional knowledge, skills and competencies leading to a first tertiary degree or equivalent qualification. ISCED code 6.", + "Master's or equivalent; Programmes designed to provide advanced academic and/or professional knowledge, skills and competencies leading to a second tertiary degree or equivalent qualification. ISCED code 7.", + "Doctoral or equivalent; Programmes designed primarily to lead to an advanced research qualification, usually concluding with the submission and defense of a substantive dissertation of publishable quality based on original research. ISCED code 8." + ], + "type": "string" + }, + "type": "array" + }, + "department": { + "description": "The department or functional area within the company with the open position. The maximum number of allowed characters is 255.", + "type": "string" + }, + "derivedInfo": { + "$ref": "JobDerivedInfo", + "description": "Output only. Derived details about the job posting.", + "readOnly": true + }, + "description": { + "description": "Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.", + "type": "string" + }, + "employmentTypes": { + "description": "The employment type(s) of a job, for example, full time or part time.", + "items": { + "enum": [ + "EMPLOYMENT_TYPE_UNSPECIFIED", + "FULL_TIME", + "PART_TIME", + "CONTRACTOR", + "CONTRACT_TO_HIRE", + "TEMPORARY", + "INTERN", + "VOLUNTEER", + "PER_DIEM", + "FLY_IN_FLY_OUT", + "OTHER_EMPLOYMENT_TYPE" + ], + "enumDescriptions": [ + "The default value if the employment type isn't specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "The job is offered as a contracted position with the understanding that it's converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], + "type": "string" + }, + "type": "array" + }, + "incentives": { + "description": "A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.", + "type": "string" + }, + "jobBenefits": { + "description": "The benefits included with the job.", + "items": { + "enum": [ + "JOB_BENEFIT_UNSPECIFIED", + "CHILD_CARE", + "DENTAL", + "DOMESTIC_PARTNER", + "FLEXIBLE_HOURS", + "MEDICAL", + "LIFE_INSURANCE", + "PARENTAL_LEAVE", + "RETIREMENT_PLAN", + "SICK_DAYS", + "VACATION", + "VISION" + ], + "enumDescriptions": [ + "Default value if the type isn't specified.", + "The job includes access to programs that support child care, such as daycare.", + "The job includes dental services covered by a dental insurance plan.", + "The job offers specific benefits to domestic partners.", + "The job allows for a flexible work schedule.", + "The job includes health services covered by a medical insurance plan.", + "The job includes a life insurance plan provided by the employer or available for purchase by the employee.", + "The job allows for a leave of absence to a parent to care for a newborn child.", + "The job includes a workplace retirement plan provided by the employer or available for purchase by the employee.", + "The job allows for paid time off due to illness.", + "The job includes paid time off for vacation.", + "The job includes vision services covered by a vision insurance plan." + ], + "type": "string" + }, + "type": "array" + }, + "jobEndTime": { + "description": "The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "jobLevel": { + "description": "The experience level associated with the job, such as \"Entry Level\".", + "enum": [ + "JOB_LEVEL_UNSPECIFIED", + "ENTRY_LEVEL", + "EXPERIENCED", + "MANAGER", + "DIRECTOR", + "EXECUTIVE" + ], + "enumDescriptions": [ + "The default value if the level isn't specified.", + "Entry-level individual contributors, typically with less than 2 years of experience in a similar role. Includes interns.", + "Experienced individual contributors, typically with 2+ years of experience in a similar role.", + "Entry- to mid-level managers responsible for managing a team of people.", + "Senior-level managers responsible for managing teams of managers.", + "Executive-level managers and above, including C-level positions." + ], + "type": "string" + }, + "jobStartTime": { + "description": "The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "languageCode": { + "description": "The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class=\"external\" target=\"_blank\" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.", + "type": "string" + }, + "name": { + "description": "Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\". For example, \"projects/foo/tenants/bar/jobs/baz\". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.", + "type": "string" + }, + "postingCreateTime": { + "description": "Output only. The timestamp when this job posting was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "postingExpireTime": { + "description": "Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.", + "format": "google-datetime", + "type": "string" + }, + "postingPublishTime": { + "description": "The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored.", + "format": "google-datetime", + "type": "string" + }, + "postingRegion": { + "description": "The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended.", + "enum": [ + "POSTING_REGION_UNSPECIFIED", + "ADMINISTRATIVE_AREA", + "NATION", + "TELECOMMUTE" + ], + "enumDescriptions": [ + "If the region is unspecified, the job is only returned if it matches the LocationFilter.", + "In addition to exact location matching, job posting is returned when the LocationFilter in the search query is in the same administrative area as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job is posted in \"CA, USA\", it's returned if LocationFilter has \"Mountain View\". Administrative area refers to top-level administrative subdivision of this country. For example, US state, IT region, UK constituent nation and JP prefecture.", + "In addition to exact location matching, job is returned when LocationFilter in search query is in the same country as this job. For example, if a `NATION_WIDE` job is posted in \"USA\", it's returned if LocationFilter has 'Mountain View'.", + "Job allows employees to work remotely (telecommute). If locations are provided with this value, the job is considered as having a location, but telecommuting is allowed." + ], + "type": "string" + }, + "postingUpdateTime": { + "description": "Output only. The timestamp when this job posting was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "processingOptions": { + "$ref": "ProcessingOptions", + "description": "Options for job processing." + }, + "promotionValue": { + "description": "A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.", + "format": "int32", + "type": "integer" + }, + "qualifications": { + "description": "A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", + "type": "string" + }, + "requisitionId": { + "description": "Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id. The maximum number of allowed characters is 255.", + "type": "string" + }, + "responsibilities": { + "description": "A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.", + "type": "string" + }, + "title": { + "description": "Required. The title of the job, such as \"Software Engineer\" The maximum number of allowed characters is 500.", + "type": "string" + }, + "visibility": { + "description": "Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.", + "enum": [ + "VISIBILITY_UNSPECIFIED", + "ACCOUNT_ONLY", + "SHARED_WITH_GOOGLE", + "SHARED_WITH_PUBLIC" + ], + "enumDescriptions": [ + "Default value.", + "The resource is only visible to the GCP account who owns it.", + "The resource is visible to the owner and may be visible to other applications and processes at Google.", + "The resource is visible to the owner and may be visible to all other API clients." + ], + "type": "string" + } + }, + "type": "object" + }, + "JobDerivedInfo": { + "description": "Derived details about the job posting.", + "id": "JobDerivedInfo", + "properties": { + "jobCategories": { + "description": "Job categories derived from Job.title and Job.description.", + "items": { + "enum": [ + "JOB_CATEGORY_UNSPECIFIED", + "ACCOUNTING_AND_FINANCE", + "ADMINISTRATIVE_AND_OFFICE", + "ADVERTISING_AND_MARKETING", + "ANIMAL_CARE", + "ART_FASHION_AND_DESIGN", + "BUSINESS_OPERATIONS", + "CLEANING_AND_FACILITIES", + "COMPUTER_AND_IT", + "CONSTRUCTION", + "CUSTOMER_SERVICE", + "EDUCATION", + "ENTERTAINMENT_AND_TRAVEL", + "FARMING_AND_OUTDOORS", + "HEALTHCARE", + "HUMAN_RESOURCES", + "INSTALLATION_MAINTENANCE_AND_REPAIR", + "LEGAL", + "MANAGEMENT", + "MANUFACTURING_AND_WAREHOUSE", + "MEDIA_COMMUNICATIONS_AND_WRITING", + "OIL_GAS_AND_MINING", + "PERSONAL_CARE_AND_SERVICES", + "PROTECTIVE_SERVICES", + "REAL_ESTATE", + "RESTAURANT_AND_HOSPITALITY", + "SALES_AND_RETAIL", + "SCIENCE_AND_ENGINEERING", + "SOCIAL_SERVICES_AND_NON_PROFIT", + "SPORTS_FITNESS_AND_RECREATION", + "TRANSPORTATION_AND_LOGISTICS" + ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], + "type": "string" + }, + "type": "array" + }, + "locations": { + "description": "Structured locations of the job, resolved from Job.addresses. locations are exactly matched to Job.addresses in the same order.", + "items": { + "$ref": "Location" + }, + "type": "array" + } + }, + "type": "object" + }, + "JobEvent": { + "description": "An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.", + "id": "JobEvent", + "properties": { + "jobs": { + "description": "Required. The job name(s) associated with this event. For example, if this is an impression event, this field contains the identifiers of all jobs shown to the job seeker. If this was a view event, this field contains the identifier of the viewed job. The format is \"projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}\", for example, \"projects/foo/tenants/bar/jobs/baz\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "Required. The type of the event (see JobEventType).", + "enum": [ + "JOB_EVENT_TYPE_UNSPECIFIED", + "IMPRESSION", + "VIEW", + "VIEW_REDIRECT", + "APPLICATION_START", + "APPLICATION_FINISH", + "APPLICATION_QUICK_SUBMISSION", + "APPLICATION_REDIRECT", + "APPLICATION_START_FROM_SEARCH", + "APPLICATION_REDIRECT_FROM_SEARCH", + "APPLICATION_COMPANY_SUBMIT", + "BOOKMARK", + "NOTIFICATION", + "HIRED", + "SENT_CV", + "INTERVIEW_GRANTED" + ], + "enumDescriptions": [ + "The event is unspecified by other provided values.", + "The job seeker or other entity interacting with the service has had a job rendered in their view, such as in a list of search results in a compressed or clipped format. This event is typically associated with the viewing of a jobs list on a single page by a job seeker.", + "The job seeker, or other entity interacting with the service, has viewed the details of a job, including the full description. This event doesn't apply to the viewing a snippet of a job appearing as a part of the job search results. Viewing a snippet is associated with an impression).", + "The job seeker or other entity interacting with the service performed an action to view a job and was redirected to a different website for job.", + "The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job.", + "The job seeker or other entity interacting with the service submitted an application for a job.", + "The job seeker or other entity interacting with the service submitted an application for a job with a single click without entering information. If a job seeker performs this action, send only this event to the service. Do not also send JobEventType.APPLICATION_START or JobEventType.APPLICATION_FINISH events.", + "The job seeker or other entity interacting with the service performed an action to apply to a job and was redirected to a different website to complete the application.", + "The job seeker or other entity interacting with the service began the process or demonstrated the intention of applying for a job from the search results page without viewing the details of the job posting. If sending this event, JobEventType.VIEW event shouldn't be sent.", + "The job seeker, or other entity interacting with the service, performs an action with a single click from the search results page to apply to a job (without viewing the details of the job posting), and is redirected to a different website to complete the application. If a candidate performs this action, send only this event to the service. Do not also send JobEventType.APPLICATION_START, JobEventType.APPLICATION_FINISH or JobEventType.VIEW events.", + "This event should be used when a company submits an application on behalf of a job seeker. This event is intended for use by staffing agencies attempting to place candidates.", + "The job seeker or other entity interacting with the service demonstrated an interest in a job by bookmarking or saving it.", + "The job seeker or other entity interacting with the service was sent a notification, such as an email alert or device notification, containing one or more jobs listings generated by the service.", + "The job seeker or other entity interacting with the service was employed by the hiring entity (employer). Send this event only if the job seeker was hired through an application that was initiated by a search conducted through the Cloud Talent Solution service.", + "A recruiter or staffing agency submitted an application on behalf of the candidate after interacting with the service to identify a suitable job posting.", + "The entity interacting with the service (for example, the job seeker), was granted an initial interview by the hiring entity (employer). This event should only be sent if the job seeker was granted an interview as part of an application that was initiated by a search conducted through / recommendation provided by the Cloud Talent Solution service." + ], + "type": "string" + } + }, + "type": "object" + }, + "JobQuery": { + "description": "The query required to perform a search query.", + "id": "JobQuery", + "properties": { + "commuteFilter": { + "$ref": "CommuteFilter", + "description": "Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored. Currently we don't support sorting by commute time." + }, + "companies": { + "description": "This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. The format is \"projects/{project_id}/tenants/{tenant_id}/companies/{company_id}\". For example, \"projects/foo/tenants/bar/companies/baz\". At most 20 company filters are allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "companyDisplayNames": { + "description": "This filter specifies the exact company Company.display_name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "compensationFilter": { + "$ref": "CompensationFilter", + "description": "This search filter is applied only to Job.compensation_info. For example, if the filter is specified as \"Hourly job with per-hour compensation > $15\", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched." + }, + "customAttributeFilter": { + "description": "This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\\\) and quote (\\\") characters. Supported functions are `LOWER([field_name])` to perform a case insensitive match and `EMPTY([field_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, \"((A AND B AND C) OR NOT D) AND E\"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)=\"class \\\"a\\\"\" OR EMPTY(driving_license)) AND driving_years > 10`", + "type": "string" + }, + "disableSpellCheck": { + "description": "This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, \"enginee\" is corrected to \"engineer\". Defaults to false: a spell check is performed.", + "type": "boolean" + }, + "employmentTypes": { + "description": "The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value isn't specified, jobs in the search results includes any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.", + "items": { + "enum": [ + "EMPLOYMENT_TYPE_UNSPECIFIED", + "FULL_TIME", + "PART_TIME", + "CONTRACTOR", + "CONTRACT_TO_HIRE", + "TEMPORARY", + "INTERN", + "VOLUNTEER", + "PER_DIEM", + "FLY_IN_FLY_OUT", + "OTHER_EMPLOYMENT_TYPE" + ], + "enumDescriptions": [ + "The default value if the employment type isn't specified.", + "The job requires working a number of hours that constitute full time employment, typically 40 or more hours per week.", + "The job entails working fewer hours than a full time job, typically less than 40 hours a week.", + "The job is offered as a contracted, as opposed to a salaried employee, position.", + "The job is offered as a contracted position with the understanding that it's converted into a full-time position at the end of the contract. Jobs of this type are also returned by a search for EmploymentType.CONTRACTOR jobs.", + "The job is offered as a temporary employment opportunity, usually a short-term engagement.", + "The job is a fixed-term opportunity for students or entry-level job seekers to obtain on-the-job training, typically offered as a summer position.", + "The is an opportunity for an individual to volunteer, where there's no expectation of compensation for the provided services.", + "The job requires an employee to work on an as-needed basis with a flexible schedule.", + "The job involves employing people in remote areas and flying them temporarily to the work site instead of relocating employees and their families permanently.", + "The job does not fit any of the other listed types." + ], + "type": "string" + }, + "type": "array" + }, + "excludedJobs": { + "description": "This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "jobCategories": { + "description": "The category filter specifies the categories of jobs to search against. See JobCategory for more information. If a value isn't specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.", + "items": { + "enum": [ + "JOB_CATEGORY_UNSPECIFIED", + "ACCOUNTING_AND_FINANCE", + "ADMINISTRATIVE_AND_OFFICE", + "ADVERTISING_AND_MARKETING", + "ANIMAL_CARE", + "ART_FASHION_AND_DESIGN", + "BUSINESS_OPERATIONS", + "CLEANING_AND_FACILITIES", + "COMPUTER_AND_IT", + "CONSTRUCTION", + "CUSTOMER_SERVICE", + "EDUCATION", + "ENTERTAINMENT_AND_TRAVEL", + "FARMING_AND_OUTDOORS", + "HEALTHCARE", + "HUMAN_RESOURCES", + "INSTALLATION_MAINTENANCE_AND_REPAIR", + "LEGAL", + "MANAGEMENT", + "MANUFACTURING_AND_WAREHOUSE", + "MEDIA_COMMUNICATIONS_AND_WRITING", + "OIL_GAS_AND_MINING", + "PERSONAL_CARE_AND_SERVICES", + "PROTECTIVE_SERVICES", + "REAL_ESTATE", + "RESTAURANT_AND_HOSPITALITY", + "SALES_AND_RETAIL", + "SCIENCE_AND_ENGINEERING", + "SOCIAL_SERVICES_AND_NON_PROFIT", + "SPORTS_FITNESS_AND_RECREATION", + "TRANSPORTATION_AND_LOGISTICS" + ], + "enumDescriptions": [ + "The default value if the category isn't specified.", + "An accounting and finance job, such as an Accountant.", + "An administrative and office job, such as an Administrative Assistant.", + "An advertising and marketing job, such as Marketing Manager.", + "An animal care job, such as Veterinarian.", + "An art, fashion, or design job, such as Designer.", + "A business operations job, such as Business Operations Manager.", + "A cleaning and facilities job, such as Custodial Staff.", + "A computer and IT job, such as Systems Administrator.", + "A construction job, such as General Laborer.", + "A customer service job, such s Cashier.", + "An education job, such as School Teacher.", + "An entertainment and travel job, such as Flight Attendant.", + "A farming or outdoor job, such as Park Ranger.", + "A healthcare job, such as Registered Nurse.", + "A human resources job, such as Human Resources Director.", + "An installation, maintenance, or repair job, such as Electrician.", + "A legal job, such as Law Clerk.", + "A management job, often used in conjunction with another category, such as Store Manager.", + "A manufacturing or warehouse job, such as Assembly Technician.", + "A media, communications, or writing job, such as Media Relations.", + "An oil, gas or mining job, such as Offshore Driller.", + "A personal care and services job, such as Hair Stylist.", + "A protective services job, such as Security Guard.", + "A real estate job, such as Buyer's Agent.", + "A restaurant and hospitality job, such as Restaurant Server.", + "A sales and/or retail job, such Sales Associate.", + "A science and engineering job, such as Lab Technician.", + "A social services or non-profit job, such as Case Worker.", + "A sports, fitness, or recreation job, such as Personal Trainer.", + "A transportation or logistics job, such as Truck Driver." + ], + "type": "string" + }, + "type": "array" + }, + "languageCodes": { + "description": "This filter specifies the locale of jobs to search against, for example, \"en-US\". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "locationFilters": { + "description": "The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.", + "items": { + "$ref": "LocationFilter" + }, + "type": "array" + }, + "publishTimeRange": { + "$ref": "TimestampRange", + "description": "Jobs published within a range specified by this filter are searched against." + }, + "query": { + "description": "The query string that matches against the job title, description, and location fields. The maximum number of allowed characters is 255.", + "type": "string" + }, + "queryLanguageCode": { + "description": "The language code of query. For example, \"en-US\". This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. Language code should be in BCP-47 format, such as \"en-US\" or \"sr-Latn\". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).", + "type": "string" + } + }, + "type": "object" + }, + "JobResult": { + "description": "Mutation result of a job from a batch operation.", + "id": "JobResult", + "properties": { + "job": { + "$ref": "Job", + "description": "Here Job only contains basic information including name, company, language_code and requisition_id, use getJob method to retrieve detailed information of the created/updated job." + }, + "status": { + "$ref": "Status", + "description": "The status of the job processed. This field is populated if the processing of the job fails." + } + }, + "type": "object" + }, + "LatLng": { + "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", + "id": "LatLng", + "properties": { + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ListCompaniesResponse": { + "description": "The List companies response object.", + "id": "ListCompaniesResponse", + "properties": { + "companies": { + "description": "Companies for the current client.", + "items": { + "$ref": "Company" + }, + "type": "array" + }, + "metadata": { + "$ref": "ResponseMetadata", + "description": "Additional information for the API invocation, such as the request tracking id." + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListJobsResponse": { + "description": "List jobs response.", + "id": "ListJobsResponse", + "properties": { + "jobs": { + "description": "The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.", + "items": { + "$ref": "Job" + }, + "type": "array" + }, + "metadata": { + "$ref": "ResponseMetadata", + "description": "Additional information for the API invocation, such as the request tracking id." + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListTenantsResponse": { + "description": "The List tenants response object.", + "id": "ListTenantsResponse", + "properties": { + "metadata": { + "$ref": "ResponseMetadata", + "description": "Additional information for the API invocation, such as the request tracking id." + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + }, + "tenants": { + "description": "Tenants for the current client.", + "items": { + "$ref": "Tenant" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a location with full geographic information.", + "id": "Location", + "properties": { + "latLng": { + "$ref": "LatLng", + "description": "An object representing a latitude/longitude pair." + }, + "locationType": { + "description": "The type of a location, which corresponds to the address lines field of google.type.PostalAddress. For example, \"Downtown, Atlanta, GA, USA\" has a type of LocationType.NEIGHBORHOOD, and \"Kansas City, KS, USA\" has a type of LocationType.LOCALITY.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "COUNTRY", + "ADMINISTRATIVE_AREA", + "SUB_ADMINISTRATIVE_AREA", + "LOCALITY", + "POSTAL_CODE", + "SUB_LOCALITY", + "SUB_LOCALITY_1", + "SUB_LOCALITY_2", + "NEIGHBORHOOD", + "STREET_ADDRESS" + ], + "enumDescriptions": [ + "Default value if the type isn't specified.", + "A country level location.", + "A state or equivalent level location.", + "A county or equivalent level location.", + "A city or equivalent level location.", + "A postal code level location.", + "A sublocality is a subdivision of a locality, for example a city borough, ward, or arrondissement. Sublocalities are usually recognized by a local political authority. For example, Manhattan and Brooklyn are recognized as boroughs by the City of New York, and are therefore modeled as sublocalities.", + "A district or equivalent level location.", + "A smaller district or equivalent level display.", + "A neighborhood level location.", + "A street address level location." + ], + "type": "string" + }, + "postalAddress": { + "$ref": "PostalAddress", + "description": "Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location." + }, + "radiusMiles": { + "description": "Radius in miles of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from google.type.LatLng covers the area associated with the job location. For example, currently, \"Mountain View, CA, USA\" has a radius of 6.17 miles.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "LocationFilter": { + "description": "Geographic region of the search.", + "id": "LocationFilter", + "properties": { + "address": { + "description": "The address name, such as \"Mountain View\" or \"Bay Area\".", + "type": "string" + }, + "distanceInMiles": { + "description": "The distance_in_miles is applied when the location being searched for is identified as a city or smaller. This field is ignored if the location being searched for is a state or larger.", + "format": "double", + "type": "number" + }, + "latLng": { + "$ref": "LatLng", + "description": "The latitude and longitude of the geographic center to search from. This field is ignored if `address` is provided." + }, + "regionCode": { + "description": "CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, \"Liverpool\" against \"Liverpool, NY, US\" or \"Liverpool, UK\". Set this field to bias location resolution toward a specific country or territory. If this field is not set, application behavior is biased toward the United States by default. See https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", + "type": "string" + }, + "telecommutePreference": { + "description": "Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. Job.posting_region indicates if a job permits telecommuting. If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not searched. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as \"Mountain View\" or \"telecommuting\" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. This field is only used for job search requests.", + "enum": [ + "TELECOMMUTE_PREFERENCE_UNSPECIFIED", + "TELECOMMUTE_EXCLUDED", + "TELECOMMUTE_ALLOWED" + ], + "enumDescriptions": [ + "Default value if the telecommute preference isn't specified.", + "Exclude telecommute jobs.", + "Allow telecommute jobs." + ], + "type": "string" + } + }, + "type": "object" + }, + "MatchingJob": { + "description": "Job entry with metadata inside SearchJobsResponse.", + "id": "MatchingJob", + "properties": { + "commuteInfo": { + "$ref": "CommuteInfo", + "description": "Commute information which is generated based on specified CommuteFilter." + }, + "job": { + "$ref": "Job", + "description": "Job resource that matches the specified SearchJobsRequest." + }, + "jobSummary": { + "description": "A summary of the job with core information that's displayed on the search results listing page.", + "type": "string" + }, + "jobTitleSnippet": { + "description": "Contains snippets of text from the Job.title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.", + "type": "string" + }, + "searchTextSnippet": { + "description": "Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.", + "type": "string" + } + }, + "type": "object" + }, + "MendelDebugInput": { + "description": "Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2", + "id": "MendelDebugInput", + "properties": { + "namespacedDebugInput": { + "additionalProperties": { + "$ref": "NamespacedDebugInput" + }, + "description": "When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == \"\"). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details.", + "type": "object" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "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", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "NamespacedDebugInput": { + "description": "Next ID: 15", + "id": "NamespacedDebugInput", + "properties": { + "absolutelyForcedExpNames": { + "description": "Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "absolutelyForcedExpTags": { + "description": "Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "absolutelyForcedExps": { + "description": "Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "conditionallyForcedExpNames": { + "description": "Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true.", + "items": { + "type": "string" + }, + "type": "array" + }, + "conditionallyForcedExpTags": { + "description": "Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true.", + "items": { + "type": "string" + }, + "type": "array" + }, + "conditionallyForcedExps": { + "description": "Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "disableAutomaticEnrollmentSelection": { + "description": "If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments.", + "type": "boolean" + }, + "disableExpNames": { + "description": "Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", + "items": { + "type": "string" + }, + "type": "array" + }, + "disableExpTags": { + "description": "Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together.", + "items": { + "type": "string" + }, + "type": "array" + }, + "disableExps": { + "description": "Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "disableManualEnrollmentSelection": { + "description": "If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments.", + "type": "boolean" + }, + "disableOrganicSelection": { + "description": "If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem.", + "type": "boolean" + }, + "forcedFlags": { + "additionalProperties": { + "type": "string" + }, + "description": "Flags to force in a particular experiment state. Map from flag name to flag value.", + "type": "object" + }, + "forcedRollouts": { + "additionalProperties": { + "type": "boolean" + }, + "description": "Rollouts to force in a particular experiment state. Map from rollout name to rollout value.", + "type": "object" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "PostalAddress": { + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "id": "PostalAddress", + "properties": { + "addressLines": { + "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", + "items": { + "type": "string" + }, + "type": "array" + }, + "administrativeArea": { + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.", + "type": "string" + }, + "languageCode": { + "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", + "type": "string" + }, + "locality": { + "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", + "type": "string" + }, + "organization": { + "description": "Optional. The name of the organization at the address.", + "type": "string" + }, + "postalCode": { + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).", + "type": "string" + }, + "recipients": { + "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", + "items": { + "type": "string" + }, + "type": "array" + }, + "regionCode": { + "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", + "type": "string" + }, + "revision": { + "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", + "format": "int32", + "type": "integer" + }, + "sortingCode": { + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", + "type": "string" + }, + "sublocality": { + "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "type": "string" + } + }, + "type": "object" + }, + "ProcessingOptions": { + "description": "Options for job processing.", + "id": "ProcessingOptions", + "properties": { + "disableStreetAddressResolution": { + "description": "If set to `true`, the service does not attempt to resolve a more precise address for the job.", + "type": "boolean" + }, + "htmlSanitization": { + "description": "Option for job HTML content sanitization. Applied fields are: * description * applicationInfo.instruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation isn't disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.", + "enum": [ + "HTML_SANITIZATION_UNSPECIFIED", + "HTML_SANITIZATION_DISABLED", + "SIMPLE_FORMATTING_ONLY" + ], + "enumDescriptions": [ + "Default value.", + "Disables sanitization on HTML input.", + "Sanitizes HTML input, only accepts bold, italic, ordered list, and unordered list markup tags." + ], + "type": "string" + } + }, + "type": "object" + }, + "RequestMetadata": { + "description": "Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.", + "id": "RequestMetadata", + "properties": { + "allowMissingIds": { + "description": "Only set when any of domain, session_id and user_id isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, session_id and user_id for the best service experience.", + "type": "boolean" + }, + "deviceInfo": { + "$ref": "DeviceInfo", + "description": "The type of device used by the job seeker at the time of the call to the service." + }, + "domain": { + "description": "Required if allow_missing_ids is unset or `false`. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client *Foo, Inc.*, on job board www.foo.com and career site www.bar.com, then this field is set to \"foo.com\" for use on the job board, and \"bar.com\" for use on the career site. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique domain. The maximum number of allowed characters is 255.", + "type": "string" + }, + "sessionId": { + "description": "Required if allow_missing_ids is unset or `false`. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique session ID. The maximum number of allowed characters is 255.", + "type": "string" + }, + "userId": { + "description": "Required if allow_missing_ids is unset or `false`. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique user ID. The maximum number of allowed characters is 255.", + "type": "string" + } + }, + "type": "object" + }, + "ResponseMetadata": { + "description": "Additional information returned to client, such as debugging information.", + "id": "ResponseMetadata", + "properties": { + "requestId": { + "description": "A unique id associated with this call. This id is logged for tracking purposes.", + "type": "string" + } + }, + "type": "object" + }, + "SearchJobsRequest": { + "description": "The Request body of the `SearchJobs` call.", + "id": "SearchJobsRequest", + "properties": { + "customRankingInfo": { + "$ref": "CustomRankingInfo", + "description": "Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm)." + }, + "disableKeywordMatch": { + "description": "Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query \"program manager,\" a result is returned even if the job posting has the title \"software developer,\" which doesn't fall into \"program manager\" ontology, but does have \"program manager\" appearing in its description. For queries like \"cloud\" that don't contain title or location specific ontology, jobs with \"cloud\" keyword matches are returned regardless of this flag's value. Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. Defaults to false.", + "type": "boolean" + }, + "diversificationLevel": { + "description": "Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. Defaults to DiversificationLevel.SIMPLE if no value is specified.", + "enum": [ + "DIVERSIFICATION_LEVEL_UNSPECIFIED", + "DISABLED", + "SIMPLE" + ], + "enumDescriptions": [ + "The diversification level isn't specified.", + "Disables diversification. Jobs that would normally be pushed to the last page would not have their positions altered. This may result in highly similar jobs appearing in sequence in the search results.", + "Default diversifying behavior. The result list is ordered so that highly similar results are pushed to the end of the last page of search results. If you are using pageToken to page through the result set, latency might be lower but we can't guarantee that all results are returned. If you are using page offset, latency might be higher but all results are returned." + ], + "type": "string" + }, + "enableBroadening": { + "description": "Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false.", + "type": "boolean" + }, + "histogramQueries": { + "description": "An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: * `count(string_histogram_facet)`: Count the number of matching entities, for each distinct attribute value. * `count(numeric_histogram_facet, list of buckets)`: Count the number of matching entities within each bucket. Data types: * Histogram facet: facet names with format a-zA-Z+. * String: string like \"any string with backslash escape for quote(\\\").\" * Number: whole number and floating point number like 10, -1 and -0.01. * List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and [\"one\", \"two\", \"three\"]. Built-in constants: * MIN (minimum number similar to java Double.MIN_VALUE) * MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: * bucket(start, end[, label]): bucket built-in function creates a bucket with range of start, end). Note that the end is exclusive, for example, bucket(1, MAX, \"positive number\") or bucket(1, 10). Job histogram facets: * company_display_name: histogram by [Job.company_display_name. * employment_type: histogram by Job.employment_types, for example, \"FULL_TIME\", \"PART_TIME\". * company_size: histogram by CompanySize, for example, \"SMALL\", \"MEDIUM\", \"BIG\". * publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec. * publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec. * degree_types: histogram by the Job.degree_types, for example, \"Bachelors\", \"Masters\". * job_level: histogram by the Job.job_level, for example, \"Entry Level\". * country: histogram by the country code of jobs, for example, \"US\", \"FR\". * admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, \"CA\", \"IL\". * city: histogram by a combination of the \"city name, admin1 code\". For example, \"Mountain View, CA\", \"New York, NY\". * admin1_country: histogram by a combination of the \"admin1 code, country\", for example, \"CA, US\", \"IL, US\". * city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically. * locale: histogram by the Job.language_code, for example, \"en-US\", \"fr-FR\". * language: histogram by the language subtag of the Job.language_code, for example, \"en\", \"fr\". * category: histogram by the JobCategory, for example, \"COMPUTER_AND_IT\", \"HEALTHCARE\". * base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, \"WEEKLY\", \"MONTHLY\". * base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by. * annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by. * annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by. * string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute[\"key1\"]. * numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute[\"key1\"]. Must specify list of numeric buckets to group results by. Example expressions: * `count(admin1)` * `count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])` * `count(string_custom_attribute[\"some-string-custom-attribute\"])` * `count(numeric_custom_attribute[\"some-numeric-custom-attribute\"], [bucket(MIN, 0, \"negative\"), bucket(0, MAX, \"non-negative\"])`", + "items": { + "$ref": "HistogramQuery" + }, + "type": "array" + }, + "jobQuery": { + "$ref": "JobQuery", + "description": "Query used to search against jobs, such as keyword, location filters, etc." + }, + "jobView": { + "description": "The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_SMALL if no value is specified.", + "enum": [ + "JOB_VIEW_UNSPECIFIED", + "JOB_VIEW_ID_ONLY", + "JOB_VIEW_MINIMAL", + "JOB_VIEW_SMALL", + "JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "Default value.", + "A ID only view of job, with following attributes: Job.name, Job.requisition_id, Job.language_code.", + "A minimal view of the job, with the following attributes: Job.name, Job.requisition_id, Job.title, Job.company, Job.DerivedInfo.locations, Job.language_code.", + "A small view of the job, with the following attributes in the search results: Job.name, Job.requisition_id, Job.title, Job.company, Job.DerivedInfo.locations, Job.visibility, Job.language_code, Job.description.", + "All available attributes are included in the search results." + ], + "type": "string" + }, + "maxPageSize": { + "description": "A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).", + "format": "int32", + "type": "integer" + }, + "orderBy": { + "description": "The criteria determining how search results are sorted. Default is `\"relevance desc\"`. Supported options are: * `\"relevance desc\"`: By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering. * `\"posting_publish_time desc\"`: By Job.posting_publish_time descending. * `\"posting_update_time desc\"`: By Job.posting_update_time descending. * `\"title\"`: By Job.title ascending. * `\"title desc\"`: By Job.title descending. * `\"annualized_base_compensation\"`: By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `\"annualized_base_compensation desc\"`: By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `\"annualized_total_compensation\"`: By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `\"annualized_total_compensation desc\"`: By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. * `\"custom_ranking desc\"`: By the relevance score adjusted to the SearchJobsRequest.CustomRankingInfo.ranking_expression with weight factor assigned by SearchJobsRequest.CustomRankingInfo.importance_level in descending order. * Location sorting: Use the special syntax to order jobs by distance: `\"distance_from('Hawaii')\"`: Order by distance from Hawaii. `\"distance_from(19.89, 155.5)\"`: Order by distance from a coordinate. `\"distance_from('Hawaii'), distance_from('Puerto Rico')\"`: Order by multiple locations. See details below. `\"distance_from('Hawaii'), distance_from(19.89, 155.5)\"`: Order by multiple locations. See details below. The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level.", + "type": "string" + }, + "pageToken": { + "description": "The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.", + "type": "string" + }, + "requestMetadata": { + "$ref": "RequestMetadata", + "description": "Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as `user_id`) are provided by users, and must be unique and consistent." + }, + "searchMode": { + "description": "Mode of a search. Defaults to SearchMode.JOB_SEARCH.", + "enum": [ + "SEARCH_MODE_UNSPECIFIED", + "JOB_SEARCH", + "FEATURED_JOB_SEARCH" + ], + "enumDescriptions": [ + "The mode of the search method isn't specified. The default search behavior is identical to JOB_SEARCH search behavior.", + "The job search matches against all jobs, and featured jobs (jobs with promotionValue > 0) are not specially handled.", + "The job search matches only against featured jobs (jobs with a promotionValue > 0). This method doesn't return any jobs having a promotionValue <= 0. The search results order is determined by the promotionValue (jobs with a higher promotionValue are returned higher up in the search results), with relevance being used as a tiebreaker." + ], + "type": "string" + } + }, + "type": "object" + }, + "SearchJobsResponse": { + "description": "Response for SearchJob method.", + "id": "SearchJobsResponse", + "properties": { + "broadenedQueryJobsCount": { + "description": "If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0, or if the field isn't set, all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.", + "format": "int32", + "type": "integer" + }, + "histogramQueryResults": { + "description": "The histogram results that match with specified SearchJobsRequest.histogram_queries.", + "items": { + "$ref": "HistogramQueryResult" + }, + "type": "array" + }, + "locationFilters": { + "description": "The location filters that the service applied to the specified query. If any filters are lat-lng based, the Location.location_type is Location.LocationType.LOCATION_TYPE_UNSPECIFIED.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "matchingJobs": { + "description": "The Job entities that match the specified SearchJobsRequest.", + "items": { + "$ref": "MatchingJob" + }, + "type": "array" + }, + "metadata": { + "$ref": "ResponseMetadata", + "description": "Additional information for the API invocation, such as the request tracking id." + }, + "nextPageToken": { + "description": "The token that specifies the starting position of the next page of results. This field is empty if there are no more results.", + "type": "string" + }, + "spellCorrection": { + "$ref": "SpellingCorrection", + "description": "The spell checking result, and correction." + }, + "totalSize": { + "description": "Number of jobs that match the specified query. Note: This size is precise only if the total is less than 100,000.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SpellingCorrection": { + "description": "Spell check result.", + "id": "SpellingCorrection", + "properties": { + "corrected": { + "description": "Indicates if the query was corrected by the spell checker.", + "type": "boolean" + }, + "correctedHtml": { + "description": "Corrected output with html tags to highlight the corrected words. Corrected words are called out with the \"*...*\" html tags. For example, the user input query is \"software enginear\", where the second word, \"enginear,\" is incorrect. It should be \"engineer\". When spelling correction is enabled, this value is \"software *engineer*\".", + "type": "string" + }, + "correctedText": { + "description": "Correction output consisting of the corrected keyword string.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "Tenant": { + "description": "A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups.", + "id": "Tenant", + "properties": { + "externalId": { + "description": "Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255.", + "type": "string" + }, + "name": { + "description": "Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is \"projects/{project_id}/tenants/{tenant_id}\", for example, \"projects/foo/tenants/bar\".", + "type": "string" + } + }, + "type": "object" + }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TimestampRange": { + "description": "Message representing a period of time between two timestamps.", + "id": "TimestampRange", + "properties": { + "endTime": { + "description": "End of the period (exclusive).", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Begin of the period (inclusive).", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Talent Solution API", + "version": "v4", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/kgsearch__v1.json b/discovery/googleapis/kgsearch__v1.json index 05ccb16..fe2396c 100644 --- a/discovery/googleapis/kgsearch__v1.json +++ b/discovery/googleapis/kgsearch__v1.json
@@ -149,7 +149,7 @@ } } }, - "revision": "20200912", + "revision": "20201113", "rootUrl": "https://kgsearch.googleapis.com/", "schemas": { "SearchResponse": {
diff --git a/discovery/googleapis/language__v1.json b/discovery/googleapis/language__v1.json index d9551ce..7bdd79e 100644 --- a/discovery/googleapis/language__v1.json +++ b/discovery/googleapis/language__v1.json
@@ -219,7 +219,7 @@ } } }, - "revision": "20200919", + "revision": "20210130", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": {
diff --git a/discovery/googleapis/libraryagent__v1.json b/discovery/googleapis/libraryagent__v1.json index 20b7ab5..0b8ab0a 100644 --- a/discovery/googleapis/libraryagent__v1.json +++ b/discovery/googleapis/libraryagent__v1.json
@@ -271,7 +271,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": {
diff --git a/discovery/googleapis/licensing__v1.json b/discovery/googleapis/licensing__v1.json index 7de99e2..59bff63 100644 --- a/discovery/googleapis/licensing__v1.json +++ b/discovery/googleapis/licensing__v1.json
@@ -9,8 +9,8 @@ } }, "basePath": "", - "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch/licensing/v1", + "baseUrl": "https://licensing.googleapis.com/", + "batchPath": "batch", "description": "The Google Enterprise License Manager API's allows you to license apps for all the users of a domain managed by you.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/admin-sdk/licensing/", @@ -127,13 +127,16 @@ "type": "string" }, "userId": { - "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.", + "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.", "location": "path", "required": true, "type": "string" } }, "path": "apps/licensing/v1/product/{productId}/sku/{skuId}/user/{userId}", + "response": { + "$ref": "Empty" + }, "scopes": [ "https://www.googleapis.com/auth/apps.licensing" ] @@ -161,7 +164,7 @@ "type": "string" }, "userId": { - "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.", + "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.", "location": "path", "required": true, "type": "string" @@ -218,14 +221,14 @@ ], "parameters": { "customerId": { - "description": "Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.", + "description": "Customer's `customerId`. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.", "location": "query", "required": true, "type": "string" }, "maxResults": { "default": "100", - "description": "The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.", + "description": "The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.", "format": "uint32", "location": "query", "maximum": "1000", @@ -234,7 +237,7 @@ }, "pageToken": { "default": "", - "description": "Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.", + "description": "Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.", "location": "query", "type": "string" }, @@ -264,14 +267,14 @@ ], "parameters": { "customerId": { - "description": "Customer's customerId. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.", + "description": "Customer's `customerId`. A previous version of this API accepted the primary domain name as a value for this field. If the customer is suspended, the server returns an error.", "location": "query", "required": true, "type": "string" }, "maxResults": { "default": "100", - "description": "The maxResults query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.", + "description": "The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.", "format": "uint32", "location": "query", "maximum": "1000", @@ -280,7 +283,7 @@ }, "pageToken": { "default": "", - "description": "Token to fetch the next page of data. The maxResults query string is related to the pageToken since maxResults determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.", + "description": "Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.", "location": "query", "type": "string" }, @@ -306,7 +309,7 @@ ] }, "patch": { - "description": "Patch a Licensing info via Apiary Patch Orchestration", + "description": "Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics.", "httpMethod": "PATCH", "id": "licensing.licenseAssignments.patch", "parameterOrder": [ @@ -328,7 +331,7 @@ "type": "string" }, "userId": { - "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.", + "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.", "location": "path", "required": true, "type": "string" @@ -368,7 +371,7 @@ "type": "string" }, "userId": { - "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.", + "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.", "location": "path", "required": true, "type": "string" @@ -388,9 +391,15 @@ } } }, - "revision": "20201003", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210130", + "rootUrl": "https://licensing.googleapis.com/", "schemas": { + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, "LicenseAssignment": { "description": "Representation of a license assignment.", "id": "LicenseAssignment", @@ -401,7 +410,7 @@ }, "kind": { "default": "licensing#licenseAssignment", - "description": "Identifies the resource as a LicenseAssignment.", + "description": "Identifies the resource as a LicenseAssignment, which is `licensing#licenseAssignment`.", "type": "string" }, "productId": { @@ -440,7 +449,7 @@ "licensing.licenseAssignments.update" ] }, - "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a userId is subject to change, do not use a userId value as a key for persistent data. This key could break if the current user's email address changes. If the userId is suspended, the license status changes.", + "description": "The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.", "type": "string" } }, @@ -482,7 +491,7 @@ "type": "string" }, "nextPageToken": { - "description": "The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The maxResults query string is related to the nextPageToken since maxResults determines how many entries are returned on each next page.", + "description": "The token that you must submit in a subsequent request to retrieve additional license results matching your query parameters. The `maxResults` query string is related to the `nextPageToken` since `maxResults` determines how many entries are returned on each next page.", "type": "string" } },
diff --git a/discovery/googleapis/localservices__v1.json b/discovery/googleapis/localservices__v1.json new file mode 100644 index 0000000..09e3f42 --- /dev/null +++ b/discovery/googleapis/localservices__v1.json
@@ -0,0 +1,538 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/adwords": { + "description": "Manage your AdWords campaigns" + } + } + } + }, + "basePath": "", + "baseUrl": "https://localservices.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Localservices", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://ads.google.com/local-services-ads/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "localservices:v1", + "kind": "discovery#restDescription", + "name": "localservices", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "accountReports": { + "methods": { + "search": { + "description": "Get account reports containing aggregate account data of all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.", + "httpMethod": "GET", + "id": "localservices.accountReports.search", + "parameterOrder": [], + "parameters": { + "endDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageSize": { + "description": "The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The `next_page_token` value returned from a previous request to SearchAccountReports that indicates where listing should continue. Optional.", + "location": "query", + "type": "string" + }, + "query": { + "description": "A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Account Report for Manager with id 123. | Required.", + "location": "query", + "type": "string" + }, + "startDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/accountReports:search", + "response": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adwords" + ] + } + } + }, + "detailedLeadReports": { + "methods": { + "search": { + "description": "Get detailed lead reports containing leads that have been received by all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.", + "httpMethod": "GET", + "id": "localservices.detailedLeadReports.search", + "parameterOrder": [], + "parameters": { + "endDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "endDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageSize": { + "description": "The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The `next_page_token` value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue. Optional.", + "location": "query", + "type": "string" + }, + "query": { + "description": "A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Detailed Lead Report for Manager with id | | | 123. | Required.", + "location": "query", + "type": "string" + }, + "startDate.day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "startDate.year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/detailedLeadReports:search", + "response": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adwords" + ] + } + } + } + }, + "revision": "20210202", + "rootUrl": "https://localservices.googleapis.com/", + "schemas": { + "GoogleAdsHomeservicesLocalservicesV1AccountReport": { + "description": "An Account Report of a GLS account identified by their account id containing aggregate data gathered from a particular date range.", + "id": "GoogleAdsHomeservicesLocalservicesV1AccountReport", + "properties": { + "accountId": { + "description": "Unique identifier of the GLS account.", + "format": "int64", + "type": "string" + }, + "aggregatorInfo": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo", + "description": "Aggregator specific information related to the account." + }, + "averageFiveStarRating": { + "description": "Average review rating score from 1-5 stars.", + "format": "double", + "type": "number" + }, + "averageWeeklyBudget": { + "description": "Average weekly budget in the currency code of the account.", + "format": "double", + "type": "number" + }, + "businessName": { + "description": "Business name of the account.", + "type": "string" + }, + "currencyCode": { + "description": "Currency code of the account.", + "type": "string" + }, + "currentPeriodChargedLeads": { + "description": "Number of charged leads the account received in current specified period.", + "format": "int64", + "type": "string" + }, + "currentPeriodConnectedPhoneCalls": { + "description": "Number of connected phone calls (duration over 30s) in current specified period.", + "format": "int64", + "type": "string" + }, + "currentPeriodPhoneCalls": { + "description": "Number of phone calls in current specified period, including both connected and unconnected calls.", + "format": "int64", + "type": "string" + }, + "currentPeriodTotalCost": { + "description": "Total cost of the account in current specified period in the account's specified currency.", + "format": "double", + "type": "number" + }, + "phoneLeadResponsiveness": { + "description": "Phone lead responsiveness of the account for the past 90 days from current date. This is computed by taking the total number of connected calls from charged phone leads and dividing by the total number of calls received.", + "format": "double", + "type": "number" + }, + "previousPeriodChargedLeads": { + "description": "Number of charged leads the account received in previous specified period.", + "format": "int64", + "type": "string" + }, + "previousPeriodConnectedPhoneCalls": { + "description": "Number of connected phone calls (duration over 30s) in previous specified period.", + "format": "int64", + "type": "string" + }, + "previousPeriodPhoneCalls": { + "description": "Number of phone calls in previous specified period, including both connected and unconnected calls.", + "format": "int64", + "type": "string" + }, + "previousPeriodTotalCost": { + "description": "Total cost of the account in previous specified period in the account's specified currency.", + "format": "double", + "type": "number" + }, + "totalReview": { + "description": "Total number of reviews the account has up to current date.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo": { + "description": "Conatiner for aggregator specific information if lead is for an aggregator GLS account.", + "id": "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo", + "properties": { + "aggregatorProviderId": { + "description": "Provider id (listed in aggregator system) which maps to a account id in GLS system.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport": { + "description": "A Detailed Lead Report of a lead identified by their lead id and contains consumer, account, monetization, and lead data.", + "id": "GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport", + "properties": { + "accountId": { + "description": "Identifies account that received the lead.", + "format": "int64", + "type": "string" + }, + "aggregatorInfo": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1AggregatorInfo", + "description": "Aggregator specific information related to the lead." + }, + "businessName": { + "description": "Business name associated to the account.", + "type": "string" + }, + "chargeStatus": { + "description": "Whether the lead has been charged.", + "enum": [ + "CHARGE_STATUS_UNSPECIFIED", + "CHARGED", + "NOT_CHARGED" + ], + "enumDescriptions": [ + "Not specified.", + "Charged.", + "Not charged." + ], + "type": "string" + }, + "currencyCode": { + "description": "Currency code.", + "type": "string" + }, + "disputeStatus": { + "description": "Dispute status related to the lead.", + "type": "string" + }, + "geo": { + "description": "Location of the associated account's home city.", + "type": "string" + }, + "leadCategory": { + "description": "Lead category (e.g. hvac, plumber)", + "type": "string" + }, + "leadCreationTimestamp": { + "description": "Timestamp of when the lead was created.", + "format": "google-datetime", + "type": "string" + }, + "leadId": { + "description": "Unique identifier of a Detailed Lead Report.", + "format": "int64", + "type": "string" + }, + "leadPrice": { + "description": "Price of the lead (available only after it has been charged).", + "format": "double", + "type": "number" + }, + "leadType": { + "description": "Lead type.", + "enum": [ + "LEAD_TYPE_UNSPECIFIED", + "MESSAGE", + "PHONE_CALL" + ], + "enumDescriptions": [ + "Not specified.", + "Message lead.", + "Phone call lead." + ], + "type": "string" + }, + "messageLead": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1MessageLead", + "description": "More information associated to only message leads." + }, + "phoneLead": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1PhoneLead", + "description": "More information associated to only phone leads." + }, + "timezone": { + "$ref": "GoogleTypeTimeZone", + "description": "Timezone of the particular provider associated to a lead." + } + }, + "type": "object" + }, + "GoogleAdsHomeservicesLocalservicesV1MessageLead": { + "description": "Container for message lead specific information.", + "id": "GoogleAdsHomeservicesLocalservicesV1MessageLead", + "properties": { + "consumerPhoneNumber": { + "description": "Consumer phone number associated with the message lead.", + "type": "string" + }, + "customerName": { + "description": "Name of the customer who created the lead.", + "type": "string" + }, + "jobType": { + "description": "The job type of the specified lead.", + "type": "string" + }, + "postalCode": { + "description": "The postal code of the customer who created the lead.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsHomeservicesLocalservicesV1PhoneLead": { + "description": "Container for phone lead specific information.", + "id": "GoogleAdsHomeservicesLocalservicesV1PhoneLead", + "properties": { + "chargedCallTimestamp": { + "description": "Timestamp of the phone call which resulted in a charged phone lead.", + "format": "google-datetime", + "type": "string" + }, + "chargedConnectedCallDurationSeconds": { + "description": "Duration of the charged phone call in seconds.", + "format": "google-duration", + "type": "string" + }, + "consumerPhoneNumber": { + "description": "Consumer phone number associated with the phone lead.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse": { + "description": "A page of the response received from the SearchAccountReports method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.", + "id": "GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse", + "properties": { + "accountReports": { + "description": "List of account reports which maps 1:1 to a particular linked GLS account.", + "items": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1AccountReport" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token to retrieve the next page of results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse": { + "description": "A page of the response received from the SearchDetailedLeadReports method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.", + "id": "GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse", + "properties": { + "detailedLeadReports": { + "description": "List of detailed lead reports uniquely identified by external lead id.", + "items": { + "$ref": "GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token to retrieve the next page of results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleTypeTimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "GoogleTypeTimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Local Services API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/logging__v2.json b/discovery/googleapis/logging__v2.json index daf937f..a465cbb 100644 --- a/discovery/googleapis/logging__v2.json +++ b/discovery/googleapis/logging__v2.json
@@ -120,7 +120,7 @@ "buckets": { "methods": { "get": { - "description": "Gets a bucket (Beta).", + "description": "Gets a bucket.", "httpMethod": "GET", "id": "logging.billingAccounts.buckets.get", "parameterOrder": [ @@ -146,6 +146,39 @@ "https://www.googleapis.com/auth/logging.read" ] } + }, + "resources": { + "views": { + "methods": { + "get": { + "description": "Gets a view.", + "httpMethod": "GET", + "id": "logging.billingAccounts.buckets.views.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^billingAccounts/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + } + } + } } }, "exclusions": { @@ -305,6 +338,78 @@ } }, "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "logging.billingAccounts.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "logging.billingAccounts.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^billingAccounts/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + } + }, "resources": { "buckets": { "methods": { @@ -367,7 +472,7 @@ ] }, "list": { - "description": "Lists buckets (Beta).", + "description": "Lists buckets.", "httpMethod": "GET", "id": "logging.billingAccounts.locations.buckets.list", "parameterOrder": [ @@ -405,7 +510,7 @@ ] }, "patch": { - "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta.", + "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created.", "httpMethod": "PATCH", "id": "logging.billingAccounts.locations.buckets.patch", "parameterOrder": [ @@ -466,6 +571,142 @@ "https://www.googleapis.com/auth/logging.admin" ] } + }, + "resources": { + "views": { + "methods": { + "create": { + "description": "Creates a view over logs in a bucket. A bucket may contain a maximum of 50 views.", + "httpMethod": "POST", + "id": "logging.billingAccounts.locations.buckets.views.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The bucket in which to create the view \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" Example: \"projects/my-logging-project/locations/my-location/buckets/my-bucket\"", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + }, + "viewId": { + "description": "Required. The id to use for this view.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a view from a bucket.", + "httpMethod": "DELETE", + "id": "logging.billingAccounts.locations.buckets.views.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "list": { + "description": "Lists views on a bucket.", + "httpMethod": "GET", + "id": "logging.billingAccounts.locations.buckets.views.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "response": { + "$ref": "ListViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a view. This method replaces the following fields in the existing view with values from the new view: filter.", + "httpMethod": "PATCH", + "id": "logging.billingAccounts.locations.buckets.views.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + } } } } @@ -473,7 +714,7 @@ "logs": { "methods": { "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", + "description": "Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", "httpMethod": "DELETE", "id": "logging.billingAccounts.logs.delete", "parameterOrder": [ @@ -522,6 +763,12 @@ "pattern": "^billingAccounts/[^/]+$", "required": true, "type": "string" + }, + "resourceNames": { + "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v2/{+parent}/logs", @@ -766,6 +1013,26 @@ "https://www.googleapis.com/auth/logging.read" ] }, + "tail": { + "description": "Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.", + "httpMethod": "POST", + "id": "logging.entries.tail", + "parameterOrder": [], + "parameters": {}, + "path": "v2/entries:tail", + "request": { + "$ref": "TailLogEntriesRequest" + }, + "response": { + "$ref": "TailLogEntriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, "write": { "description": "Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)", "httpMethod": "POST", @@ -1102,6 +1369,78 @@ } }, "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "logging.folders.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "logging.folders.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + } + }, "resources": { "buckets": { "methods": { @@ -1164,7 +1503,7 @@ ] }, "get": { - "description": "Gets a bucket (Beta).", + "description": "Gets a bucket.", "httpMethod": "GET", "id": "logging.folders.locations.buckets.get", "parameterOrder": [ @@ -1191,7 +1530,7 @@ ] }, "list": { - "description": "Lists buckets (Beta).", + "description": "Lists buckets.", "httpMethod": "GET", "id": "logging.folders.locations.buckets.list", "parameterOrder": [ @@ -1229,7 +1568,7 @@ ] }, "patch": { - "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta.", + "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created.", "httpMethod": "PATCH", "id": "logging.folders.locations.buckets.patch", "parameterOrder": [ @@ -1290,6 +1629,169 @@ "https://www.googleapis.com/auth/logging.admin" ] } + }, + "resources": { + "views": { + "methods": { + "create": { + "description": "Creates a view over logs in a bucket. A bucket may contain a maximum of 50 views.", + "httpMethod": "POST", + "id": "logging.folders.locations.buckets.views.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The bucket in which to create the view \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" Example: \"projects/my-logging-project/locations/my-location/buckets/my-bucket\"", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + }, + "viewId": { + "description": "Required. The id to use for this view.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a view from a bucket.", + "httpMethod": "DELETE", + "id": "logging.folders.locations.buckets.views.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "get": { + "description": "Gets a view.", + "httpMethod": "GET", + "id": "logging.folders.locations.buckets.views.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists views on a bucket.", + "httpMethod": "GET", + "id": "logging.folders.locations.buckets.views.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "response": { + "$ref": "ListViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a view. This method replaces the following fields in the existing view with values from the new view: filter.", + "httpMethod": "PATCH", + "id": "logging.folders.locations.buckets.views.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + } } } } @@ -1297,7 +1799,7 @@ "logs": { "methods": { "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", + "description": "Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", "httpMethod": "DELETE", "id": "logging.folders.logs.delete", "parameterOrder": [ @@ -1346,6 +1848,12 @@ "pattern": "^folders/[^/]+$", "required": true, "type": "string" + }, + "resourceNames": { + "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v2/{+parent}/logs", @@ -1569,6 +2077,78 @@ } }, "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "logging.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^[^/]+/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "logging.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^[^/]+/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + } + }, "resources": { "buckets": { "methods": { @@ -1631,7 +2211,7 @@ ] }, "get": { - "description": "Gets a bucket (Beta).", + "description": "Gets a bucket.", "httpMethod": "GET", "id": "logging.locations.buckets.get", "parameterOrder": [ @@ -1658,7 +2238,7 @@ ] }, "list": { - "description": "Lists buckets (Beta).", + "description": "Lists buckets.", "httpMethod": "GET", "id": "logging.locations.buckets.list", "parameterOrder": [ @@ -1696,7 +2276,7 @@ ] }, "patch": { - "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta.", + "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created.", "httpMethod": "PATCH", "id": "logging.locations.buckets.patch", "parameterOrder": [ @@ -1757,6 +2337,169 @@ "https://www.googleapis.com/auth/logging.admin" ] } + }, + "resources": { + "views": { + "methods": { + "create": { + "description": "Creates a view over logs in a bucket. A bucket may contain a maximum of 50 views.", + "httpMethod": "POST", + "id": "logging.locations.buckets.views.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The bucket in which to create the view \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" Example: \"projects/my-logging-project/locations/my-location/buckets/my-bucket\"", + "location": "path", + "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + }, + "viewId": { + "description": "Required. The id to use for this view.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a view from a bucket.", + "httpMethod": "DELETE", + "id": "logging.locations.buckets.views.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "get": { + "description": "Gets a view.", + "httpMethod": "GET", + "id": "logging.locations.buckets.views.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists views on a bucket.", + "httpMethod": "GET", + "id": "logging.locations.buckets.views.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "location": "path", + "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "response": { + "$ref": "ListViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a view. This method replaces the following fields in the existing view with values from the new view: filter.", + "httpMethod": "PATCH", + "id": "logging.locations.buckets.views.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^[^/]+/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + } } } } @@ -1764,7 +2507,7 @@ "logs": { "methods": { "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", + "description": "Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", "httpMethod": "DELETE", "id": "logging.logs.delete", "parameterOrder": [ @@ -1813,6 +2556,12 @@ "pattern": "^[^/]+/[^/]+$", "required": true, "type": "string" + }, + "resourceNames": { + "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v2/{+parent}/logs", @@ -2083,6 +2832,78 @@ } }, "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "logging.organizations.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "logging.organizations.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + } + }, "resources": { "buckets": { "methods": { @@ -2145,7 +2966,7 @@ ] }, "get": { - "description": "Gets a bucket (Beta).", + "description": "Gets a bucket.", "httpMethod": "GET", "id": "logging.organizations.locations.buckets.get", "parameterOrder": [ @@ -2172,7 +2993,7 @@ ] }, "list": { - "description": "Lists buckets (Beta).", + "description": "Lists buckets.", "httpMethod": "GET", "id": "logging.organizations.locations.buckets.list", "parameterOrder": [ @@ -2210,7 +3031,7 @@ ] }, "patch": { - "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta.", + "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created.", "httpMethod": "PATCH", "id": "logging.organizations.locations.buckets.patch", "parameterOrder": [ @@ -2271,6 +3092,169 @@ "https://www.googleapis.com/auth/logging.admin" ] } + }, + "resources": { + "views": { + "methods": { + "create": { + "description": "Creates a view over logs in a bucket. A bucket may contain a maximum of 50 views.", + "httpMethod": "POST", + "id": "logging.organizations.locations.buckets.views.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The bucket in which to create the view \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" Example: \"projects/my-logging-project/locations/my-location/buckets/my-bucket\"", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + }, + "viewId": { + "description": "Required. The id to use for this view.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a view from a bucket.", + "httpMethod": "DELETE", + "id": "logging.organizations.locations.buckets.views.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "get": { + "description": "Gets a view.", + "httpMethod": "GET", + "id": "logging.organizations.locations.buckets.views.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists views on a bucket.", + "httpMethod": "GET", + "id": "logging.organizations.locations.buckets.views.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "response": { + "$ref": "ListViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a view. This method replaces the following fields in the existing view with values from the new view: filter.", + "httpMethod": "PATCH", + "id": "logging.organizations.locations.buckets.views.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + } } } } @@ -2278,7 +3262,7 @@ "logs": { "methods": { "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", + "description": "Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", "httpMethod": "DELETE", "id": "logging.organizations.logs.delete", "parameterOrder": [ @@ -2327,6 +3311,12 @@ "pattern": "^organizations/[^/]+$", "required": true, "type": "string" + }, + "resourceNames": { + "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v2/{+parent}/logs", @@ -2708,6 +3698,78 @@ } }, "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "logging.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "logging.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + } + }, "resources": { "buckets": { "methods": { @@ -2770,7 +3832,7 @@ ] }, "get": { - "description": "Gets a bucket (Beta).", + "description": "Gets a bucket.", "httpMethod": "GET", "id": "logging.projects.locations.buckets.get", "parameterOrder": [ @@ -2797,7 +3859,7 @@ ] }, "list": { - "description": "Lists buckets (Beta).", + "description": "Lists buckets.", "httpMethod": "GET", "id": "logging.projects.locations.buckets.list", "parameterOrder": [ @@ -2835,7 +3897,7 @@ ] }, "patch": { - "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta.", + "description": "Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created.", "httpMethod": "PATCH", "id": "logging.projects.locations.buckets.patch", "parameterOrder": [ @@ -2896,6 +3958,169 @@ "https://www.googleapis.com/auth/logging.admin" ] } + }, + "resources": { + "views": { + "methods": { + "create": { + "description": "Creates a view over logs in a bucket. A bucket may contain a maximum of 50 views.", + "httpMethod": "POST", + "id": "logging.projects.locations.buckets.views.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The bucket in which to create the view \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" Example: \"projects/my-logging-project/locations/my-location/buckets/my-bucket\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + }, + "viewId": { + "description": "Required. The id to use for this view.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a view from a bucket.", + "httpMethod": "DELETE", + "id": "logging.projects.locations.buckets.views.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "get": { + "description": "Gets a view.", + "httpMethod": "GET", + "id": "logging.projects.locations.buckets.views.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the policy: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists views on a bucket.", + "httpMethod": "GET", + "id": "logging.projects.locations.buckets.views.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The bucket whose views are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]\" ", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/views", + "response": { + "$ref": "ListViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a view. This method replaces the following fields in the existing view with values from the new view: filter.", + "httpMethod": "PATCH", + "id": "logging.projects.locations.buckets.views.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The full resource name of the view to update \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\" Example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view-id\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/buckets/[^/]+/views/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=filter.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogView" + }, + "response": { + "$ref": "LogView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + } } } } @@ -2903,7 +4128,7 @@ "logs": { "methods": { "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", + "description": "Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.", "httpMethod": "DELETE", "id": "logging.projects.logs.delete", "parameterOrder": [ @@ -2952,6 +4177,12 @@ "pattern": "^projects/[^/]+$", "required": true, "type": "string" + }, + "resourceNames": { + "description": "Optional. The resource name that owns the logs: projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDTo support legacy queries, it could also be: \"projects/PROJECT_ID\" \"organizations/ORGANIZATION_ID\" \"billingAccounts/BILLING_ACCOUNT_ID\" \"folders/FOLDER_ID\"", + "location": "query", + "repeated": true, + "type": "string" } }, "path": "v2/{+parent}/logs", @@ -3559,7 +4790,7 @@ } } }, - "revision": "20200801", + "revision": "20210128", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryOptions": { @@ -3696,7 +4927,7 @@ "type": "string" }, "remoteIp": { - "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".", + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. This field can include port information. Examples: \"192.168.1.1\", \"10.0.0.1:80\", \"FE80::0202:B3FF:FE1E:8329\".", "type": "string" }, "requestMethod": { @@ -3718,7 +4949,7 @@ "type": "string" }, "serverIp": { - "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: \"192.168.1.1\", \"10.0.0.1:80\", \"FE80::0202:B3FF:FE1E:8329\".", "type": "string" }, "status": { @@ -3785,7 +5016,7 @@ "type": "object" }, "ListBucketsResponse": { - "description": "The response from ListBuckets (Beta).", + "description": "The response from ListBuckets.", "id": "ListBucketsResponse", "properties": { "buckets": { @@ -3820,6 +5051,24 @@ }, "type": "object" }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, "ListLogEntriesRequest": { "description": "The parameters to ListLogEntries.", "id": "ListLogEntriesRequest", @@ -3849,7 +5098,7 @@ "type": "array" }, "resourceNames": { - "description": "Required. Names of one or more parent resources from which to retrieve log entries: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" Projects listed in the project_ids field are added to this list.", + "description": "Required. Names of one or more parent resources from which to retrieve log entries: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" May alternatively be one or more views projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_IDProjects listed in the project_ids field are added to this list.", "items": { "type": "string" }, @@ -3948,8 +5197,60 @@ }, "type": "object" }, + "ListViewsResponse": { + "description": "The response from ListViews.", + "id": "ListViewsResponse", + "properties": { + "nextPageToken": { + "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.", + "type": "string" + }, + "views": { + "description": "A list of views.", + "items": { + "$ref": "LogView" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"} ", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: \"us-east1\".", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", + "type": "string" + } + }, + "type": "object" + }, "LogBucket": { - "description": "Describes a repository of logs (Beta).", + "description": "Describes a repository of logs.", "id": "LogBucket", "properties": { "createTime": { @@ -3982,7 +5283,8 @@ "type": "boolean" }, "name": { - "description": "The resource name of the bucket. For example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id The supported locations are: \"global\"For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed.", + "description": "Output only. The resource name of the bucket. For example: \"projects/my-project-id/locations/my-location/buckets/my-bucket-id\" The supported locations are: global, us-central1, us-east1, us-west1, asia-east1, europe-west1.For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed.", + "readOnly": true, "type": "string" }, "retentionDays": { @@ -4236,7 +5538,7 @@ "type": "object" }, "LogMetric": { - "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.", + "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metrics can also be used to extract values from logs and create a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.", "id": "LogMetric", "properties": { "bucketOptions": { @@ -4298,7 +5600,7 @@ "type": "object" }, "LogSink": { - "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.", + "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, a Cloud Pub/Sub topic or a Cloud Logging Bucket. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.", "id": "LogSink", "properties": { "bigqueryOptions": { @@ -4370,8 +5672,39 @@ }, "type": "object" }, + "LogView": { + "description": "Describes a view over logs in a bucket.", + "id": "LogView", + "properties": { + "createTime": { + "description": "Output only. The creation timestamp of the view.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Describes this view.", + "type": "string" + }, + "filter": { + "description": "Filter that restricts which log entries in a bucket are visible in this view. Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log id Example: SOURCE(\"projects/myproject\") AND resource.type = \"gce_instance\" AND LOG_ID(\"stdout\")", + "type": "string" + }, + "name": { + "description": "The resource name of the view. For example \"projects/my-project-id/locations/my-location/buckets/my-bucket-id/views/my-view", + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update timestamp of the view.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.The following are specific rules for service defined Monitoring metric descriptors: type, metric_kind, value_type and description fields are all required. The unit field must be specified if the value_type is any of DOUBLE, INT64, DISTRIBUTION. Maximum of default 500 metric descriptors per service is allowed. Maximum of default 10 labels per metric descriptor is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.", "id": "MetricDescriptor", "properties": { "description": { @@ -4383,7 +5716,7 @@ "type": "string" }, "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type.The label key name must follow: Only upper and lower-case letters, digits and underscores (_) are allowed. Label name must start with a letter or digit. The maximum length of a label name is 100 characters.For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.", + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.", "items": { "$ref": "LabelDescriptor" }, @@ -4406,7 +5739,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation." @@ -4445,11 +5778,11 @@ "type": "string" }, "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded.All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must follow: Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. The maximum number of characters allowed for the relative_metric_name is 100.All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\" ", + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: \"custom.googleapis.com/invoice/paid/amount\" \"external.googleapis.com/prometheus/up\" \"appengine.googleapis.com/http/server/response_latencies\" ", "type": "string" }, "unit": { - "description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean \"5300 page views per day\"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means \"3 percent\"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means \"3 percent\").", + "description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean \"5300 page views per day\"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means \"3 percent\"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means \"3 percent\").", "type": "string" }, "valueType": { @@ -4503,7 +5836,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation." @@ -4537,7 +5870,7 @@ "type": "object" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different services can support different monitored resource types.The following are specific rules to service defined monitored resources for Monitoring and Logging: The type, display_name, description, labels and launch_stage fields are all required. The first label of the monitored resource descriptor must be resource_container. There are legacy monitored resource descritptors start with project_id. It must include a location label. Maximum of default 5 service defined monitored resource descriptors is allowed per service. Maximum of default 10 labels per monitored resource is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.", "id": "MonitoredResourceDescriptor", "properties": { "description": { @@ -4549,7 +5882,7 @@ "type": "string" }, "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow: Only upper and lower-case letters, digits and underscores (_) are allowed. Label name must start with a letter or digit. The maximum length of a label name is 100 characters.For example, an individual Google Cloud SQL database is identified by values for the labels database_id and location.", + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".", "items": { "$ref": "LabelDescriptor" }, @@ -4572,7 +5905,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation." @@ -4584,7 +5917,7 @@ "type": "string" }, "type": { - "description": "Required. The monitored resource type. For example, the type cloudsql_database represents databases in Google Cloud SQL.All service defined monitored resource types must be prefixed with the service name, in the format of {service name}/{relative resource name}. The relative resource name must follow: Only upper and lower-case letters and digits are allowed. It must start with upper case character and is recommended to use Upper Camel Case style. The maximum number of characters allowed for the relative_resource_name is 100.Note there are legacy service monitored resources not following this rule.", + "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL.", "type": "string" } }, @@ -4801,6 +6134,76 @@ }, "type": "object" }, + "SuppressionInfo": { + "description": "Information about entries that were omitted from the session.", + "id": "SuppressionInfo", + "properties": { + "reason": { + "description": "The reason that entries were omitted from the session.", + "enum": [ + "REASON_UNSPECIFIED", + "RATE_LIMIT", + "NOT_CONSUMED" + ], + "enumDescriptions": [ + "Unexpected default.", + "Indicates suppression occurred due to relevant entries being received in excess of rate limits. For quotas and limits, see Logging API quotas and limits (https://cloud.google.com/logging/quotas#api-limits).", + "Indicates suppression occurred due to the client not consuming responses quickly enough." + ], + "type": "string" + }, + "suppressedCount": { + "description": "A lower bound on the count of entries omitted due to reason.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TailLogEntriesRequest": { + "description": "The parameters to TailLogEntries.", + "id": "TailLogEntriesRequest", + "properties": { + "bufferWindow": { + "description": "Optional. The amount of time to buffer log entries at the server before being returned to prevent out of order results due to late arriving log entries. Valid values are between 0-60000 milliseconds. Defaults to 2000 milliseconds.", + "format": "google-duration", + "type": "string" + }, + "filter": { + "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters (https://cloud.google.com/logging/docs/view/advanced_filters). Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.", + "type": "string" + }, + "resourceNames": { + "description": "Required. Name of a parent resource from which to retrieve log entries: \"projects/[PROJECT_ID]\" \"organizations/[ORGANIZATION_ID]\" \"billingAccounts/[BILLING_ACCOUNT_ID]\" \"folders/[FOLDER_ID]\" May alternatively be one or more views: \"projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\" \"organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\" \"billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\" \"folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/VIEW_ID\"", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TailLogEntriesResponse": { + "description": "Result returned from TailLogEntries.", + "id": "TailLogEntriesResponse", + "properties": { + "entries": { + "description": "A list of log entries. Each response in the stream will order entries with increasing values of LogEntry.timestamp. Ordering is not guaranteed between separate responses.", + "items": { + "$ref": "LogEntry" + }, + "type": "array" + }, + "suppressionInfo": { + "description": "If entries that otherwise would have been included in the session were not sent back to the client, counts of relevant entries omitted from the session with the reason that they were not included. There will be at most one of each reason per response. The counts represent the number of suppressed entries since the last streamed response.", + "items": { + "$ref": "SuppressionInfo" + }, + "type": "array" + } + }, + "type": "object" + }, "UndeleteBucketRequest": { "description": "The parameters to UndeleteBucket.", "id": "UndeleteBucketRequest",
diff --git a/discovery/googleapis/managedidentities__v1.json b/discovery/googleapis/managedidentities__v1.json index 9da519e..41742be 100644 --- a/discovery/googleapis/managedidentities__v1.json +++ b/discovery/googleapis/managedidentities__v1.json
@@ -144,11 +144,6 @@ "location": "query", "type": "string" }, - "includeUnrevealedLocations": { - "description": "If true, the returned list will include locations which are not yet revealed.", - "location": "query", - "type": "boolean" - }, "name": { "description": "The resource that owns the locations collection, if applicable.", "location": "path", @@ -687,7 +682,7 @@ } } }, - "revision": "20200925", + "revision": "20210112", "rootUrl": "https://managedidentities.googleapis.com/", "schemas": { "AttachTrustRequest": { @@ -705,10 +700,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -733,6 +724,63 @@ "properties": {}, "type": "object" }, + "DailyCycle": { + "description": "Time window specified for daily operations.", + "id": "DailyCycle", + "properties": { + "duration": { + "description": "Output only. Duration of the time window, set by service producer.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Time within the day to start the operations." + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "Date", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end." + }, + "startDate": { + "$ref": "Date", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start." + }, + "time": { + "$ref": "TimeOfDay", + "description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC" + } + }, + "type": "object" + }, "DetachTrustRequest": { "description": "Request message for DetachTrust", "id": "DetachTrustRequest", @@ -745,7 +793,7 @@ "type": "object" }, "Domain": { - "description": "Represents a managed Microsoft Active Directory domain.", + "description": "Represents a managed Microsoft Active Directory domain. If the domain is being changed, it will be placed into the UPDATING state, which indicates that the resource is being reconciled. At this point, Get will reflect an intermediate state.", "id": "Domain", "properties": { "admin": { @@ -1009,14 +1057,14 @@ "additionalProperties": { "type": "string" }, - "description": "The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", + "description": "Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", "type": "object" }, "maintenanceSchedules": { "additionalProperties": { "$ref": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule" }, - "description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule.", + "description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.", "type": "object" }, "maintenanceSettings": { @@ -1113,6 +1161,11 @@ "description": "The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.", "type": "string" }, + "scheduleDeadlineTime": { + "description": "schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus a week. If the reschedule type is next window, simply take this value as start time. If reschedule type is IMMEDIATELY or BY_TIME, current or selected time cannot go beyond this deadline.", + "format": "google-datetime", + "type": "string" + }, "startTime": { "description": "The scheduled start time for the maintenance.", "format": "google-datetime", @@ -1128,6 +1181,13 @@ "exclude": { "description": "Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.", "type": "boolean" + }, + "maintenancePolicies": { + "additionalProperties": { + "$ref": "MaintenancePolicy" + }, + "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.", + "type": "object" } }, "type": "object" @@ -1333,6 +1393,71 @@ }, "type": "object" }, + "MaintenancePolicy": { + "description": "Defines policies to service maintenance events.", + "id": "MaintenancePolicy", + "properties": { + "createTime": { + "description": "Output only. The time when the resource was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.", + "type": "object" + }, + "name": { + "description": "Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`.", + "type": "string" + }, + "state": { + "description": "Optional. The state of the policy.", + "enum": [ + "STATE_UNSPECIFIED", + "READY", + "DELETING" + ], + "enumDescriptions": [ + "Unspecified state.", + "Resource is ready to be used.", + "Resource is being deleted. It can no longer be attached to instances." + ], + "type": "string" + }, + "updatePolicy": { + "$ref": "UpdatePolicy", + "description": "Maintenance policy applicable to instance update." + }, + "updateTime": { + "description": "Output only. The time when the resource was updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "MaintenanceWindow definition.", + "id": "MaintenanceWindow", + "properties": { + "dailyCycle": { + "$ref": "DailyCycle", + "description": "Daily cycle." + }, + "weeklyCycle": { + "$ref": "WeeklyCycle", + "description": "Weekly cycle." + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -1464,6 +1589,46 @@ }, "type": "object" }, + "Schedule": { + "description": "Configure the schedule.", + "id": "Schedule", + "properties": { + "day": { + "description": "Allows to define schedule that runs specified day of the week.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "duration": { + "description": "Output only. Duration of the time window, set by service producer.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Time within the window to start the operations." + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -1530,8 +1695,35 @@ }, "type": "object" }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Trust": { - "description": "Represents a relationship between two domains. This allows a controller in one domain to authenticate a user in another domain.", + "description": "Represents a relationship between two domains. This allows a controller in one domain to authenticate a user in another domain. If the trust is being changed, it will be placed into the UPDATING state, which indicates that the resource is being reconciled. At this point, Get will reflect an intermediate state.", "id": "Trust", "properties": { "createTime": { @@ -1630,6 +1822,38 @@ }, "type": "object" }, + "UpdatePolicy": { + "description": "Maintenance policy applicable to instance updates.", + "id": "UpdatePolicy", + "properties": { + "channel": { + "description": "Optional. Relative scheduling channel applied to resource.", + "enum": [ + "UPDATE_CHANNEL_UNSPECIFIED", + "EARLIER", + "LATER" + ], + "enumDescriptions": [ + "Unspecified channel.", + "Early channel within a customer project.", + "Later channel within a customer project." + ], + "type": "string" + }, + "denyMaintenancePeriods": { + "description": "Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. User can specify zero or more non-overlapping deny periods. For V1, Maximum number of deny_maintenance_periods is expected to be one.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, + "window": { + "$ref": "MaintenanceWindow", + "description": "Optional. Maintenance window that is applied to resources covered by this policy." + } + }, + "type": "object" + }, "ValidateTrustRequest": { "description": "Request message for ValidateTrust", "id": "ValidateTrustRequest", @@ -1640,6 +1864,20 @@ } }, "type": "object" + }, + "WeeklyCycle": { + "description": "Time window specified for weekly operations.", + "id": "WeeklyCycle", + "properties": { + "schedule": { + "description": "User can specify multiple windows in a week. Minimum of 1 window.", + "items": { + "$ref": "Schedule" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/manufacturers__v1.json b/discovery/googleapis/manufacturers__v1.json index 2313ce0..e235c81 100644 --- a/discovery/googleapis/manufacturers__v1.json +++ b/discovery/googleapis/manufacturers__v1.json
@@ -282,7 +282,7 @@ } } }, - "revision": "20200930", + "revision": "20210127", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -391,6 +391,13 @@ }, "type": "array" }, + "productHighlight": { + "description": "The product highlights. For more information, see https://support.google.com/manufacturers/answer/10066942", + "items": { + "type": "string" + }, + "type": "array" + }, "productLine": { "description": "The name of the group of products related to the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productline.", "type": "string"
diff --git a/discovery/googleapis_beta/memcache__v1beta2.json b/discovery/googleapis/memcache__v1.json similarity index 80% rename from discovery/googleapis_beta/memcache__v1beta2.json rename to discovery/googleapis/memcache__v1.json index b8dec77..e9d8e4d 100644 --- a/discovery/googleapis_beta/memcache__v1beta2.json +++ b/discovery/googleapis/memcache__v1.json
@@ -19,7 +19,7 @@ "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "id": "memcache:v1beta2", + "id": "memcache:v1", "kind": "discovery#restDescription", "name": "memcache", "ownerDomain": "google.com", @@ -123,7 +123,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Location" }, @@ -163,7 +163,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}/locations", + "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, @@ -191,7 +191,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}:applyParameters", + "path": "v1/{+name}:applyParameters", "request": { "$ref": "ApplyParametersRequest" }, @@ -223,7 +223,7 @@ "type": "string" } }, - "path": "v1beta2/{+parent}/instances", + "path": "v1/{+parent}/instances", "request": { "$ref": "Instance" }, @@ -250,7 +250,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -274,7 +274,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Instance" }, @@ -319,7 +319,7 @@ "type": "string" } }, - "path": "v1beta2/{+parent}/instances", + "path": "v1/{+parent}/instances", "response": { "$ref": "ListInstancesResponse" }, @@ -349,7 +349,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}", + "path": "v1/{+name}", "request": { "$ref": "Instance" }, @@ -376,7 +376,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}:updateParameters", + "path": "v1/{+name}:updateParameters", "request": { "$ref": "UpdateParametersRequest" }, @@ -407,7 +407,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}:cancel", + "path": "v1/{+name}:cancel", "request": { "$ref": "CancelOperationRequest" }, @@ -434,7 +434,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Empty" }, @@ -458,7 +458,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -498,7 +498,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}/operations", + "path": "v1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, @@ -513,7 +513,7 @@ } } }, - "revision": "20200928", + "revision": "20210121", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -540,30 +540,72 @@ "properties": {}, "type": "object" }, + "DailyCycle": { + "description": "Time window specified for daily operations.", + "id": "DailyCycle", + "properties": { + "duration": { + "description": "Output only. Duration of the time window, set by service producer.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Time within the day to start the operations." + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DenyMaintenancePeriod": { + "description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "$ref": "Date", + "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end." + }, + "startDate": { + "$ref": "Date", + "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start." + }, + "time": { + "$ref": "TimeOfDay", + "description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC" + } + }, + "type": "object" + }, "Empty": { "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); } The JSON representation for `Empty` is empty JSON object `{}`.", "id": "Empty", "properties": {}, "type": "object" }, - "GoogleCloudMemcacheV1beta2LocationMetadata": { - "description": "Metadata for the given google.cloud.location.Location.", - "id": "GoogleCloudMemcacheV1beta2LocationMetadata", - "properties": { - "availableZones": { - "additionalProperties": { - "$ref": "ZoneMetadata" - }, - "description": "Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in the `zones` field when creating a Memcached instance.", - "readOnly": true, - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudMemcacheV1beta2OperationMetadata": { + "GoogleCloudMemcacheV1OperationMetadata": { "description": "Represents the metadata of a long-running operation.", - "id": "GoogleCloudMemcacheV1beta2OperationMetadata", + "id": "GoogleCloudMemcacheV1OperationMetadata", "properties": { "apiVersion": { "description": "Output only. API version used to start the operation.", @@ -629,14 +671,14 @@ "additionalProperties": { "type": "string" }, - "description": "The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", + "description": "Deprecated. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug.", "type": "object" }, "maintenanceSchedules": { "additionalProperties": { "$ref": "GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule" }, - "description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule.", + "description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.", "type": "object" }, "maintenanceSettings": { @@ -733,6 +775,11 @@ "description": "The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.", "type": "string" }, + "scheduleDeadlineTime": { + "description": "schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus a week. If the reschedule type is next window, simply take this value as start time. If reschedule type is IMMEDIATELY or BY_TIME, current or selected time cannot go beyond this deadline.", + "format": "google-datetime", + "type": "string" + }, "startTime": { "description": "The scheduled start time for the maintenance.", "format": "google-datetime", @@ -748,6 +795,13 @@ "exclude": { "description": "Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.", "type": "boolean" + }, + "maintenancePolicies": { + "additionalProperties": { + "$ref": "MaintenancePolicy" + }, + "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For complete details of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. If only the name is needed (like in the deprecated Instance.maintenance_policy_names field) then only populate MaintenancePolicy.name.", + "type": "object" } }, "type": "object" @@ -862,7 +916,7 @@ "id": "Instance", "properties": { "authorizedNetwork": { - "description": "The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.", + "description": "The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.", "type": "string" }, "createTime": { @@ -997,17 +1051,17 @@ "description": "Response for ListInstances.", "id": "ListInstancesResponse", "properties": { - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - }, - "resources": { + "instances": { "description": "A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is \"-\", all regions available to the project are queried, and the results aggregated.", "items": { "$ref": "Instance" }, "type": "array" }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, "unreachable": { "description": "Locations that could not be reached.", "items": { @@ -1088,6 +1142,86 @@ }, "type": "object" }, + "LocationMetadata": { + "description": "Metadata for the given google.cloud.location.Location.", + "id": "LocationMetadata", + "properties": { + "availableZones": { + "additionalProperties": { + "$ref": "ZoneMetadata" + }, + "description": "Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by GCE. These keys can be specified in the `zones` field when creating a Memcached instance.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "MaintenancePolicy": { + "description": "Defines policies to service maintenance events.", + "id": "MaintenancePolicy", + "properties": { + "createTime": { + "description": "Output only. The time when the resource was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.", + "type": "object" + }, + "name": { + "description": "Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`.", + "type": "string" + }, + "state": { + "description": "Optional. The state of the policy.", + "enum": [ + "STATE_UNSPECIFIED", + "READY", + "DELETING" + ], + "enumDescriptions": [ + "Unspecified state.", + "Resource is ready to be used.", + "Resource is being deleted. It can no longer be attached to instances." + ], + "type": "string" + }, + "updatePolicy": { + "$ref": "UpdatePolicy", + "description": "Maintenance policy applicable to instance update." + }, + "updateTime": { + "description": "Output only. The time when the resource was updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "MaintenanceWindow definition.", + "id": "MaintenanceWindow", + "properties": { + "dailyCycle": { + "$ref": "DailyCycle", + "description": "Daily cycle." + }, + "weeklyCycle": { + "$ref": "WeeklyCycle", + "description": "Weekly cycle." + } + }, + "type": "object" + }, "MemcacheParameters": { "id": "MemcacheParameters", "properties": { @@ -1208,6 +1342,90 @@ }, "type": "object" }, + "OperationMetadata": { + "description": "Represents the metadata of a long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "cancelRequested": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. Time when the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Time when the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "statusDetail": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Schedule": { + "description": "Configure the schedule.", + "id": "Schedule", + "properties": { + "day": { + "description": "Allows to define schedule that runs specified day of the week.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "duration": { + "description": "Output only. Duration of the time window, set by service producer.", + "format": "google-duration", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Time within the window to start the operations." + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1235,6 +1453,33 @@ }, "type": "object" }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "UpdateParametersRequest": { "description": "Request for UpdateParameters.", "id": "UpdateParametersRequest", @@ -1251,6 +1496,52 @@ }, "type": "object" }, + "UpdatePolicy": { + "description": "Maintenance policy applicable to instance updates.", + "id": "UpdatePolicy", + "properties": { + "channel": { + "description": "Optional. Relative scheduling channel applied to resource.", + "enum": [ + "UPDATE_CHANNEL_UNSPECIFIED", + "EARLIER", + "LATER" + ], + "enumDescriptions": [ + "Unspecified channel.", + "Early channel within a customer project.", + "Later channel within a customer project." + ], + "type": "string" + }, + "denyMaintenancePeriods": { + "description": "Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. User can specify zero or more non-overlapping deny periods. For V1, Maximum number of deny_maintenance_periods is expected to be one.", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, + "window": { + "$ref": "MaintenanceWindow", + "description": "Optional. Maintenance window that is applied to resources covered by this policy." + } + }, + "type": "object" + }, + "WeeklyCycle": { + "description": "Time window specified for weekly operations.", + "id": "WeeklyCycle", + "properties": { + "schedule": { + "description": "User can specify multiple windows in a week. Minimum of 1 window.", + "items": { + "$ref": "Schedule" + }, + "type": "array" + } + }, + "type": "object" + }, "ZoneMetadata": { "id": "ZoneMetadata", "properties": {}, @@ -1259,6 +1550,6 @@ }, "servicePath": "", "title": "Cloud Memorystore for Memcached API", - "version": "v1beta2", + "version": "v1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis/ml__v1.json b/discovery/googleapis/ml__v1.json index ca72c3a..e611326 100644 --- a/discovery/googleapis/ml__v1.json +++ b/discovery/googleapis/ml__v1.json
@@ -836,6 +836,33 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listOptimalTrials": { + "description": "Lists the pareto-optimal trials for multi-objective study or the optimal trials for single-objective study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "httpMethod": "POST", + "id": "ml.projects.locations.studies.trials.listOptimalTrials", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the study that the pareto-optimal trial belongs to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/trials:listOptimalTrials", + "request": { + "$ref": "GoogleCloudMlV1__ListOptimalTrialsRequest" + }, + "response": { + "$ref": "GoogleCloudMlV1__ListOptimalTrialsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "stop": { "description": "Stops a trial.", "httpMethod": "POST", @@ -1411,7 +1438,7 @@ } } }, - "revision": "20201005", + "revision": "20210122", "rootUrl": "https://ml.googleapis.com/", "schemas": { "GoogleApi__HttpBody": { @@ -1743,6 +1770,7 @@ "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", "TPU_V2", "TPU_V3" ], @@ -1753,6 +1781,7 @@ "Nvidia Tesla V100 GPU.", "Nvidia Tesla P4 GPU.", "Nvidia Tesla T4 GPU.", + "Nvidia Tesla A100 GPU.", "TPU v2.", "TPU v3." ], @@ -1776,8 +1805,20 @@ "description": "Options for automatically scaling a model.", "id": "GoogleCloudMlV1__AutoScaling", "properties": { + "maxNodes": { + "description": "The maximum number of nodes to scale this model under load. The actual value will depend on resource quota and availability.", + "format": "int32", + "type": "integer" + }, + "metrics": { + "description": "MetricSpec contains the specifications to use to calculate the desired nodes count.", + "items": { + "$ref": "GoogleCloudMlV1__MetricSpec" + }, + "type": "array" + }, "minNodes": { - "description": "Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If `min_nodes` is not specified and AutoScaling is used with a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. If `min_nodes` is not specified and AutoScaling is used with a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 1. `min_nodes` must be at least 1 for use with a Compute Engine machine type. Note that you cannot use AutoScaling if your version uses [GPUs](#Version.FIELDS.accelerator_config). Instead, you must use ManualScaling. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects/*/models/*/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json ", + "description": "Optional. The minimum number of nodes to allocate for this model. These nodes are always up, starting from the time the model is deployed. Therefore, the cost of operating this model will be at least `rate` * `min_nodes` * number of hours since last billing cycle, where `rate` is the cost per node-hour as documented in the [pricing guide](/ml-engine/docs/pricing), even if no predictions are performed. There is additional cost for each prediction performed. Unlike manual scaling, if the load gets too heavy for the nodes that are up, the service will automatically add nodes to handle the increased load as well as scale back as traffic drops, always maintaining at least `min_nodes`. You will be charged for the time in which additional nodes are used. If `min_nodes` is not specified and AutoScaling is used with a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 0, in which case, when traffic to a model stops (and after a cool-down period), nodes will be shut down and no charges will be incurred until traffic to the model resumes. If `min_nodes` is not specified and AutoScaling is used with a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction), `min_nodes` defaults to 1. `min_nodes` must be at least 1 for use with a Compute Engine machine type. You can set `min_nodes` when creating the model version, and you can also update `min_nodes` for an existing version: update_body.json: { 'autoScaling': { 'minNodes': 5 } } HTTP request: PATCH https://ml.googleapis.com/v1/{name=projects/*/models/*/versions/*}?update_mask=autoScaling.minNodes -d @./update_body.json ", "format": "int32", "type": "integer" } @@ -1839,6 +1880,7 @@ "NVIDIA_TESLA_V100", "NVIDIA_TESLA_P4", "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", "TPU_V2", "TPU_V3" ], @@ -1849,6 +1891,7 @@ "Nvidia Tesla V100 GPU.", "Nvidia Tesla P4 GPU.", "Nvidia Tesla T4 GPU.", + "Nvidia Tesla A100 GPU.", "TPU v2.", "TPU v3." ], @@ -1951,11 +1994,11 @@ "type": "object" }, "GoogleCloudMlV1__ContainerPort": { - "description": "ContainerPort represents a network port in a single container.", + "description": "Represents a network port in a single container. This message is a subset of the [Kubernetes ContainerPort v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#containerport-v1-core).", "id": "GoogleCloudMlV1__ContainerPort", "properties": { "containerPort": { - "description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.", + "description": "Number of the port to expose on the container. This must be a valid port number: 0 < PORT_NUMBER < 65536.", "format": "int32", "type": "integer" } @@ -1963,36 +2006,36 @@ "type": "object" }, "GoogleCloudMlV1__ContainerSpec": { - "description": "Specify a custom container to deploy. Our ContainerSpec is a subset of the Kubernetes Container specification. https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#container-v1-core", + "description": "Specification of a custom container for serving predictions. This message is a subset of the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).", "id": "GoogleCloudMlV1__ContainerSpec", "properties": { "args": { - "description": "Immutable. Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", + "description": "Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s \"default parameters\" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `commmand` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the [Docker documentation about how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).", "items": { "type": "string" }, "type": "array" }, "command": { - "description": "Immutable. Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", + "description": "Immutable. Specifies the command that runs when the container starts. This overrides the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s \"exec\" form, not its \"shell\" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the [Docker documentation about how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).", "items": { "type": "string" }, "type": "array" }, "env": { - "description": "Immutable. List of environment variables to set in the container.", + "description": "Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { \"name\": \"VAR_1\", \"value\": \"foo\" }, { \"name\": \"VAR_2\", \"value\": \"$(VAR_1) bar\" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).", "items": { "$ref": "GoogleCloudMlV1__EnvVar" }, "type": "array" }, "image": { - "description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images", + "description": "URI of the Docker image to be used as the custom container for serving predictions. This URI must identify [an image in Artifact Registry](/artifact-registry/docs/overview) and begin with the hostname `{REGION}-docker.pkg.dev`, where `{REGION}` is replaced by the region that matches AI Platform Prediction [regional endpoint](/ai-platform/prediction/docs/regional-endpoints) that you are using. For example, if you are using the `us-central1-ml.googleapis.com` endpoint, then this URI must begin with `us-central1-docker.pkg.dev`. To use a custom container, the [AI Platform Google-managed service account](/ai-platform/prediction/docs/custom-service-account#default) must have permission to pull (read) the Docker image at this URI. The AI Platform Google-managed service account has the following format: `service-{PROJECT_NUMBER}@cloud-ml.google.com.iam.gserviceaccount.com` {PROJECT_NUMBER} is replaced by your Google Cloud project number. By default, this service account has necessary permissions to pull an Artifact Registry image in the same Google Cloud project where you are using AI Platform Prediction. In this case, no configuration is necessary. If you want to use an image from a different Google Cloud project, learn how to [grant the Artifact Registry Reader (roles/artifactregistry.reader) role for a repository](/artifact-registry/docs/access-control#grant-repo) to your projet's AI Platform Google-managed service account. To learn about the requirements for the Docker image itself, read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements).", "type": "string" }, "ports": { - "description": "Immutable. List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network.", + "description": "Immutable. List of ports to expose from the container. AI Platform Prediction sends any prediction requests that it receives to the first port on this list. AI Platform Prediction also sends [liveness and health checks](/ai-platform/prediction/docs/custom-container-requirements#health) to this port. If you do not specify this field, it defaults to following value: ```json [ { \"containerPort\": 8080 } ] ``` AI Platform Prediction does not use ports other than the first one listed. This field corresponds to the `ports` field of the [Kubernetes Containers v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core).", "items": { "$ref": "GoogleCloudMlV1__ContainerPort" }, @@ -2001,6 +2044,22 @@ }, "type": "object" }, + "GoogleCloudMlV1__DiskConfig": { + "description": "Represents the config of disk options.", + "id": "GoogleCloudMlV1__DiskConfig", + "properties": { + "bootDiskSizeGb": { + "description": "Size in GB of the boot disk (default is 100GB).", + "format": "int32", + "type": "integer" + }, + "bootDiskType": { + "description": "Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudMlV1__EncryptionConfig": { "description": "Represents a custom encryption key configuration that can be applied to a resource.", "id": "GoogleCloudMlV1__EncryptionConfig", @@ -2013,15 +2072,15 @@ "type": "object" }, "GoogleCloudMlV1__EnvVar": { - "description": "EnvVar represents an environment variable present in a Container.", + "description": "Represents an environment variable to be made available in a container. This message is a subset of the [Kubernetes EnvVar v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#envvar-v1-core).", "id": "GoogleCloudMlV1__EnvVar", "properties": { "name": { - "description": "Name of the environment variable. Must be a C_IDENTIFIER.", + "description": "Name of the environment variable. Must be a [valid C identifier](https://github.com/kubernetes/kubernetes/blob/v1.18.8/staging/src/k8s.io/apimachinery/pkg/util/validation/validation.go#L258) and must not begin with the prefix `AIP_`.", "type": "string" }, "value": { - "description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to \"\".", + "description": "Value of the environment variable. Defaults to an empty string. In this field, you can reference [environment variables set by AI Platform Prediction](/ai-platform/prediction/docs/custom-container-requirements#aip-variables) and environment variables set earlier in the same env field as where this message occurs. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $(VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME)", "type": "string" } }, @@ -2363,6 +2422,26 @@ }, "type": "object" }, + "GoogleCloudMlV1__ListOptimalTrialsRequest": { + "description": "The request message for the ListTrials service method.", + "id": "GoogleCloudMlV1__ListOptimalTrialsRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudMlV1__ListOptimalTrialsResponse": { + "description": "The response message for the ListOptimalTrials method.", + "id": "GoogleCloudMlV1__ListOptimalTrialsResponse", + "properties": { + "trials": { + "description": "The pareto-optimal trials for multiple objective study or the optimal trial for single objective study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "items": { + "$ref": "GoogleCloudMlV1__Trial" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudMlV1__ListStudiesResponse": { "id": "GoogleCloudMlV1__ListStudiesResponse", "properties": { @@ -2460,6 +2539,32 @@ }, "type": "object" }, + "GoogleCloudMlV1__MetricSpec": { + "description": "MetricSpec contains the specifications to use to calculate the desired nodes count when autoscaling is enabled.", + "id": "GoogleCloudMlV1__MetricSpec", + "properties": { + "name": { + "description": "metric name.", + "enum": [ + "METRIC_NAME_UNSPECIFIED", + "CPU_USAGE", + "GPU_DUTY_CYCLE" + ], + "enumDescriptions": [ + "Unspecified MetricName.", + "CPU usage.", + "GPU duty cycle." + ], + "type": "string" + }, + "target": { + "description": "Target specifies the target value for the given metric; once real metric deviates from the threshold by a certain percentage, the node count changes.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudMlV1__Model": { "description": "Represents a machine learning solution. A model can have multiple versions, each of which is a deployed, trained model ready to receive prediction requests. The model itself is just a container.", "id": "GoogleCloudMlV1__Model", @@ -2489,11 +2594,11 @@ "type": "string" }, "onlinePredictionConsoleLogging": { - "description": "Optional. If true, online prediction nodes send `stderr` and `stdout` streams to Stackdriver Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false.", + "description": "Optional. If true, online prediction nodes send `stderr` and `stdout` streams to Cloud Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false.", "type": "boolean" }, "onlinePredictionLogging": { - "description": "Optional. If true, online prediction access logs are sent to StackDriver Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that [Stackdriver logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false.", + "description": "Optional. If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false.", "type": "boolean" }, "regions": { @@ -2795,6 +2900,10 @@ }, "type": "array" }, + "diskConfig": { + "$ref": "GoogleCloudMlV1__DiskConfig", + "description": "Represents the configuration of disk options." + }, "imageUri": { "description": "The Docker image to run on the replica. This image must be in Container Registry. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers).", "type": "string" @@ -2823,15 +2932,15 @@ "type": "object" }, "GoogleCloudMlV1__RouteMap": { - "description": "RouteMap is used to override HTTP paths sent to a Custom Container. If specified, the HTTP server implemented in the ContainerSpec must support the route. If unspecified, standard HTTP paths will be used.", + "description": "Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements.", "id": "GoogleCloudMlV1__RouteMap", "properties": { "health": { - "description": "HTTP path to send health check requests.", + "description": "HTTP path on the container to send health checkss to. AI Platform Prediction intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](/ai-platform/prediction/docs/custom-container-requirements#checks). For example, if you set this field to `/bar`, then AI Platform Prediction intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/ MODEL/versions/VERSION The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the \"projects/PROJECT_ID/models/\" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the \"projects/PROJECT_ID /models/MODEL/versions/\" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.", "type": "string" }, "predict": { - "description": "HTTP path to send prediction requests.", + "description": "HTTP path on the container to send prediction requests to. AI Platform Prediction forwards requests sent using projects.predict to this path on the container's IP address and port. AI Platform Prediction then returns the container's response in the API response. For example, if you set this field to `/foo`, then when AI Platform Prediction receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of Version.container.ports. If you don't specify this field, it defaults to the following value: /v1/models/MODEL/versions/VERSION:predict The placeholders in this value are replaced as follows: * MODEL: The name of the parent Model. This does not include the \"projects/PROJECT_ID/models/\" prefix that the API returns in output; it is the bare model name, as provided to projects.models.create. * VERSION: The name of the model version. This does not include the \"projects/PROJECT_ID/models/MODEL/versions/\" prefix that the API returns in output; it is the bare version name, as provided to projects.models.versions.create.", "type": "string" } }, @@ -2934,7 +3043,7 @@ "RANDOM_SEARCH" ], "enumDescriptions": [ - "The default algorithm used by the Cloud AI Platform Optimization service.", + "The default algorithm used by the Cloud AI Platform Vizier service.", "Gaussian Process Bandit.", "Simple grid search within the feasible space. To use grid search, all parameters must be `INTEGER`, `CATEGORICAL`, or `DISCRETE`.", "Simple random search within the feasible space." @@ -3300,10 +3409,11 @@ }, "autoScaling": { "$ref": "GoogleCloudMlV1__AutoScaling", - "description": "Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes. Note that you cannot use AutoScaling if your version uses [GPUs](#Version.FIELDS.accelerator_config). Instead, you must use specify `manual_scaling`." + "description": "Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes." }, "container": { - "$ref": "GoogleCloudMlV1__ContainerSpec" + "$ref": "GoogleCloudMlV1__ContainerSpec", + "description": "Optional. Specifies a custom container to use for serving predictions. If you specify this field, then `machineType` is required. If you specify this field, then `deploymentUri` is optional. If you specify this field, then you must not specify `runtimeVersion`, `packageUris`, `framework`, `pythonVersion`, or `predictionClass`." }, "createTime": { "description": "Output only. The time the version was created.", @@ -3311,7 +3421,7 @@ "type": "string" }, "deploymentUri": { - "description": "Required. The Cloud Storage location of the trained model used to create the version. See the [guide to model deployment](/ml-engine/docs/tensorflow/deploying-models) for more information. When passing Version to projects.models.versions.create the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000.", + "description": "The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying-models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts).", "type": "string" }, "description": { @@ -3332,7 +3442,7 @@ "description": "Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload." }, "framework": { - "description": "Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify a [Compute Engine (N1) machine type](/ml-engine/docs/machine-types-online-prediction) in the `machineType` field, you must specify `TENSORFLOW` for the framework.", + "description": "Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai-platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container](/ai-platform/prediction/docs/use-custom-container).", "enum": [ "FRAMEWORK_UNSPECIFIED", "TENSORFLOW", @@ -3358,13 +3468,24 @@ "description": "Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels.", "type": "object" }, + "lastMigrationModelId": { + "description": "Output only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform-unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified).", + "readOnly": true, + "type": "string" + }, + "lastMigrationTime": { + "description": "Output only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified).", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "lastUseTime": { "description": "Output only. The time the version was last used for prediction.", "format": "google-datetime", "type": "string" }, "machineType": { - "description": "Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. If this field is not specified, it defaults to `mls1-c1-m2`. Online prediction supports the following machine types: * `mls1-c1-m2` * `mls1-c4-m2` * `n1-standard-2` * `n1-standard-4` * `n1-standard-8` * `n1-standard-16` * `n1-standard-32` * `n1-highmem-2` * `n1-highmem-4` * `n1-highmem-8` * `n1-highmem-16` * `n1-highmem-32` * `n1-highcpu-2` * `n1-highcpu-4` * `n1-highcpu-8` * `n1-highcpu-16` * `n1-highcpu-32` `mls1-c1-m2` is generally available. All other machine types are available in beta. Learn more about the [differences between machine types](/ml-engine/docs/machine-types-online-prediction).", + "description": "Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs/regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`.", "type": "string" }, "manualScaling": { @@ -3395,14 +3516,15 @@ "description": "Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version." }, "routes": { - "$ref": "GoogleCloudMlV1__RouteMap" + "$ref": "GoogleCloudMlV1__RouteMap", + "description": "Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { \"predict\": \"/v1/models/MODEL/versions/VERSION:predict\", \"health\": \"/v1/models/MODEL/versions/VERSION\" } ``` See RouteMap for more details about these default values." }, "runtimeVersion": { "description": "Required. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning).", "type": "string" }, "serviceAccount": { - "description": "Optional. Specifies the service account for resource access control.", + "description": "Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service-account).", "type": "string" }, "state": { @@ -3492,10 +3614,6 @@ "description": "Associates `members` with a `role`.", "id": "GoogleIamV1__Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "GoogleType__Expr", "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 members 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)."
diff --git a/discovery/googleapis/monitoring__v3.json b/discovery/googleapis/monitoring__v3.json index 39012b5..ef97142 100644 --- a/discovery/googleapis/monitoring__v3.json +++ b/discovery/googleapis/monitoring__v3.json
@@ -112,6 +112,550 @@ }, "protocol": "rest", "resources": { + "folders": { + "resources": { + "timeSeries": { + "methods": { + "list": { + "description": "Lists time series that match a filter. This method does not require a Workspace.", + "httpMethod": "GET", + "id": "monitoring.folders.timeSeries.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "aggregation.alignmentPeriod": { + "description": "The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "aggregation.crossSeriesReducer": { + "description": "The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.", + "enum": [ + "REDUCE_NONE", + "REDUCE_MEAN", + "REDUCE_MIN", + "REDUCE_MAX", + "REDUCE_SUM", + "REDUCE_STDDEV", + "REDUCE_COUNT", + "REDUCE_COUNT_TRUE", + "REDUCE_COUNT_FALSE", + "REDUCE_FRACTION_TRUE", + "REDUCE_PERCENTILE_99", + "REDUCE_PERCENTILE_95", + "REDUCE_PERCENTILE_50", + "REDUCE_PERCENTILE_05" + ], + "enumDescriptions": [ + "No cross-time series reduction. The output of the Aligner is returned.", + "Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric and distribution values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of numeric, Boolean, distribution, and string value_type. The value_type of the output is INT64.", + "Reduce by computing the number of True-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the number of False-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the ratio of the number of True-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Reduce by computing the 99th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 95th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 50th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 5th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE." + ], + "location": "query", + "type": "string" + }, + "aggregation.groupByFields": { + "description": "The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.", + "location": "query", + "repeated": true, + "type": "string" + }, + "aggregation.perSeriesAligner": { + "description": "An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.", + "enum": [ + "ALIGN_NONE", + "ALIGN_DELTA", + "ALIGN_RATE", + "ALIGN_INTERPOLATE", + "ALIGN_NEXT_OLDER", + "ALIGN_MIN", + "ALIGN_MAX", + "ALIGN_MEAN", + "ALIGN_COUNT", + "ALIGN_SUM", + "ALIGN_STDDEV", + "ALIGN_COUNT_TRUE", + "ALIGN_COUNT_FALSE", + "ALIGN_FRACTION_TRUE", + "ALIGN_PERCENTILE_99", + "ALIGN_PERCENTILE_95", + "ALIGN_PERCENTILE_50", + "ALIGN_PERCENTILE_05", + "ALIGN_PERCENT_CHANGE" + ], + "enumDescriptions": [ + "No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type of the result is the same as the value_type of the input.", + "Align and convert to DELTA. The output is delta = y1 - y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The value_type of the aligned result is the same as the value_type of the input.", + "Align and convert to a rate. The result is computed as rate = (y1 - y0)/(t1 - t0), or \"delta over time\". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the alignment_period.This aligner is valid for CUMULATIVE and DELTA metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a GAUGE metric with value_type DOUBLE.If, by \"rate\", you mean \"percentage change\", see the ALIGN_PERCENT_CHANGE aligner instead.", + "Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE metrics. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is DOUBLE.", + "Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric or Boolean values. The value_type of the aligned result is INT64.", + "Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric and distribution values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the output is DOUBLE.", + "Align the time series by returning the number of True values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the number of False values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the ratio of the number of True values to the total number of values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align and convert to a percentage change. This aligner is valid for GAUGE and DELTA metrics with numeric values. This alignment returns ((current - previous)/previous) * 100, where the value of previous is determined based on the alignment_period.If the values of current and previous are both 0, then the returned value is 0. If only previous is 0, the returned value is infinity.A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are >= 0. Any values < 0 are treated as a missing datapoint, and are ignored. While DELTA metrics are accepted by this alignment, special care should be taken that the values for the metric will always be positive. The output is a GAUGE metric with value_type DOUBLE." + ], + "location": "query", + "type": "string" + }, + "filter": { + "description": "Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND metric.labels.instance_name = \"my-instance-name\" ", + "location": "query", + "type": "string" + }, + "interval.endTime": { + "description": "Required. The end of the time interval.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "interval.startTime": { + "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] ", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", + "location": "query", + "type": "string" + }, + "secondaryAggregation.alignmentPeriod": { + "description": "The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "secondaryAggregation.crossSeriesReducer": { + "description": "The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.", + "enum": [ + "REDUCE_NONE", + "REDUCE_MEAN", + "REDUCE_MIN", + "REDUCE_MAX", + "REDUCE_SUM", + "REDUCE_STDDEV", + "REDUCE_COUNT", + "REDUCE_COUNT_TRUE", + "REDUCE_COUNT_FALSE", + "REDUCE_FRACTION_TRUE", + "REDUCE_PERCENTILE_99", + "REDUCE_PERCENTILE_95", + "REDUCE_PERCENTILE_50", + "REDUCE_PERCENTILE_05" + ], + "enumDescriptions": [ + "No cross-time series reduction. The output of the Aligner is returned.", + "Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric and distribution values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of numeric, Boolean, distribution, and string value_type. The value_type of the output is INT64.", + "Reduce by computing the number of True-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the number of False-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the ratio of the number of True-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Reduce by computing the 99th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 95th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 50th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 5th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE." + ], + "location": "query", + "type": "string" + }, + "secondaryAggregation.groupByFields": { + "description": "The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.", + "location": "query", + "repeated": true, + "type": "string" + }, + "secondaryAggregation.perSeriesAligner": { + "description": "An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.", + "enum": [ + "ALIGN_NONE", + "ALIGN_DELTA", + "ALIGN_RATE", + "ALIGN_INTERPOLATE", + "ALIGN_NEXT_OLDER", + "ALIGN_MIN", + "ALIGN_MAX", + "ALIGN_MEAN", + "ALIGN_COUNT", + "ALIGN_SUM", + "ALIGN_STDDEV", + "ALIGN_COUNT_TRUE", + "ALIGN_COUNT_FALSE", + "ALIGN_FRACTION_TRUE", + "ALIGN_PERCENTILE_99", + "ALIGN_PERCENTILE_95", + "ALIGN_PERCENTILE_50", + "ALIGN_PERCENTILE_05", + "ALIGN_PERCENT_CHANGE" + ], + "enumDescriptions": [ + "No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type of the result is the same as the value_type of the input.", + "Align and convert to DELTA. The output is delta = y1 - y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The value_type of the aligned result is the same as the value_type of the input.", + "Align and convert to a rate. The result is computed as rate = (y1 - y0)/(t1 - t0), or \"delta over time\". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the alignment_period.This aligner is valid for CUMULATIVE and DELTA metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a GAUGE metric with value_type DOUBLE.If, by \"rate\", you mean \"percentage change\", see the ALIGN_PERCENT_CHANGE aligner instead.", + "Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE metrics. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is DOUBLE.", + "Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric or Boolean values. The value_type of the aligned result is INT64.", + "Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric and distribution values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the output is DOUBLE.", + "Align the time series by returning the number of True values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the number of False values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the ratio of the number of True values to the total number of values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align and convert to a percentage change. This aligner is valid for GAUGE and DELTA metrics with numeric values. This alignment returns ((current - previous)/previous) * 100, where the value of previous is determined based on the alignment_period.If the values of current and previous are both 0, then the returned value is 0. If only previous is 0, the returned value is infinity.A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are >= 0. Any values < 0 are treated as a missing datapoint, and are ignored. While DELTA metrics are accepted by this alignment, special care should be taken that the values for the metric will always be positive. The output is a GAUGE metric with value_type DOUBLE." + ], + "location": "query", + "type": "string" + }, + "view": { + "description": "Required. Specifies which information is returned about the time series.", + "enum": [ + "FULL", + "HEADERS" + ], + "enumDescriptions": [ + "Returns the identity of the metric(s), the time series, and the time series data.", + "Returns the identity of the metric and the time series resource, but not the time series data." + ], + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}/timeSeries", + "response": { + "$ref": "ListTimeSeriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ] + } + } + } + } + }, + "organizations": { + "resources": { + "timeSeries": { + "methods": { + "list": { + "description": "Lists time series that match a filter. This method does not require a Workspace.", + "httpMethod": "GET", + "id": "monitoring.organizations.timeSeries.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "aggregation.alignmentPeriod": { + "description": "The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "aggregation.crossSeriesReducer": { + "description": "The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.", + "enum": [ + "REDUCE_NONE", + "REDUCE_MEAN", + "REDUCE_MIN", + "REDUCE_MAX", + "REDUCE_SUM", + "REDUCE_STDDEV", + "REDUCE_COUNT", + "REDUCE_COUNT_TRUE", + "REDUCE_COUNT_FALSE", + "REDUCE_FRACTION_TRUE", + "REDUCE_PERCENTILE_99", + "REDUCE_PERCENTILE_95", + "REDUCE_PERCENTILE_50", + "REDUCE_PERCENTILE_05" + ], + "enumDescriptions": [ + "No cross-time series reduction. The output of the Aligner is returned.", + "Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric and distribution values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of numeric, Boolean, distribution, and string value_type. The value_type of the output is INT64.", + "Reduce by computing the number of True-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the number of False-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the ratio of the number of True-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Reduce by computing the 99th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 95th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 50th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 5th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE." + ], + "location": "query", + "type": "string" + }, + "aggregation.groupByFields": { + "description": "The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.", + "location": "query", + "repeated": true, + "type": "string" + }, + "aggregation.perSeriesAligner": { + "description": "An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.", + "enum": [ + "ALIGN_NONE", + "ALIGN_DELTA", + "ALIGN_RATE", + "ALIGN_INTERPOLATE", + "ALIGN_NEXT_OLDER", + "ALIGN_MIN", + "ALIGN_MAX", + "ALIGN_MEAN", + "ALIGN_COUNT", + "ALIGN_SUM", + "ALIGN_STDDEV", + "ALIGN_COUNT_TRUE", + "ALIGN_COUNT_FALSE", + "ALIGN_FRACTION_TRUE", + "ALIGN_PERCENTILE_99", + "ALIGN_PERCENTILE_95", + "ALIGN_PERCENTILE_50", + "ALIGN_PERCENTILE_05", + "ALIGN_PERCENT_CHANGE" + ], + "enumDescriptions": [ + "No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type of the result is the same as the value_type of the input.", + "Align and convert to DELTA. The output is delta = y1 - y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The value_type of the aligned result is the same as the value_type of the input.", + "Align and convert to a rate. The result is computed as rate = (y1 - y0)/(t1 - t0), or \"delta over time\". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the alignment_period.This aligner is valid for CUMULATIVE and DELTA metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a GAUGE metric with value_type DOUBLE.If, by \"rate\", you mean \"percentage change\", see the ALIGN_PERCENT_CHANGE aligner instead.", + "Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE metrics. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is DOUBLE.", + "Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric or Boolean values. The value_type of the aligned result is INT64.", + "Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric and distribution values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the output is DOUBLE.", + "Align the time series by returning the number of True values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the number of False values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the ratio of the number of True values to the total number of values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align and convert to a percentage change. This aligner is valid for GAUGE and DELTA metrics with numeric values. This alignment returns ((current - previous)/previous) * 100, where the value of previous is determined based on the alignment_period.If the values of current and previous are both 0, then the returned value is 0. If only previous is 0, the returned value is infinity.A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are >= 0. Any values < 0 are treated as a missing datapoint, and are ignored. While DELTA metrics are accepted by this alignment, special care should be taken that the values for the metric will always be positive. The output is a GAUGE metric with value_type DOUBLE." + ], + "location": "query", + "type": "string" + }, + "filter": { + "description": "Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND metric.labels.instance_name = \"my-instance-name\" ", + "location": "query", + "type": "string" + }, + "interval.endTime": { + "description": "Required. The end of the time interval.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "interval.startTime": { + "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] ", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", + "location": "query", + "type": "string" + }, + "secondaryAggregation.alignmentPeriod": { + "description": "The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "secondaryAggregation.crossSeriesReducer": { + "description": "The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.", + "enum": [ + "REDUCE_NONE", + "REDUCE_MEAN", + "REDUCE_MIN", + "REDUCE_MAX", + "REDUCE_SUM", + "REDUCE_STDDEV", + "REDUCE_COUNT", + "REDUCE_COUNT_TRUE", + "REDUCE_COUNT_FALSE", + "REDUCE_FRACTION_TRUE", + "REDUCE_PERCENTILE_99", + "REDUCE_PERCENTILE_95", + "REDUCE_PERCENTILE_50", + "REDUCE_PERCENTILE_05" + ], + "enumDescriptions": [ + "No cross-time series reduction. The output of the Aligner is returned.", + "Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric and distribution values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of numeric, Boolean, distribution, and string value_type. The value_type of the output is INT64.", + "Reduce by computing the number of True-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the number of False-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the ratio of the number of True-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Reduce by computing the 99th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 95th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 50th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 5th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE." + ], + "location": "query", + "type": "string" + }, + "secondaryAggregation.groupByFields": { + "description": "The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.", + "location": "query", + "repeated": true, + "type": "string" + }, + "secondaryAggregation.perSeriesAligner": { + "description": "An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.", + "enum": [ + "ALIGN_NONE", + "ALIGN_DELTA", + "ALIGN_RATE", + "ALIGN_INTERPOLATE", + "ALIGN_NEXT_OLDER", + "ALIGN_MIN", + "ALIGN_MAX", + "ALIGN_MEAN", + "ALIGN_COUNT", + "ALIGN_SUM", + "ALIGN_STDDEV", + "ALIGN_COUNT_TRUE", + "ALIGN_COUNT_FALSE", + "ALIGN_FRACTION_TRUE", + "ALIGN_PERCENTILE_99", + "ALIGN_PERCENTILE_95", + "ALIGN_PERCENTILE_50", + "ALIGN_PERCENTILE_05", + "ALIGN_PERCENT_CHANGE" + ], + "enumDescriptions": [ + "No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type of the result is the same as the value_type of the input.", + "Align and convert to DELTA. The output is delta = y1 - y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The value_type of the aligned result is the same as the value_type of the input.", + "Align and convert to a rate. The result is computed as rate = (y1 - y0)/(t1 - t0), or \"delta over time\". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the alignment_period.This aligner is valid for CUMULATIVE and DELTA metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a GAUGE metric with value_type DOUBLE.If, by \"rate\", you mean \"percentage change\", see the ALIGN_PERCENT_CHANGE aligner instead.", + "Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE metrics. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is DOUBLE.", + "Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric or Boolean values. The value_type of the aligned result is INT64.", + "Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric and distribution values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the output is DOUBLE.", + "Align the time series by returning the number of True values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the number of False values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the ratio of the number of True values to the total number of values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align and convert to a percentage change. This aligner is valid for GAUGE and DELTA metrics with numeric values. This alignment returns ((current - previous)/previous) * 100, where the value of previous is determined based on the alignment_period.If the values of current and previous are both 0, then the returned value is 0. If only previous is 0, the returned value is infinity.A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are >= 0. Any values < 0 are treated as a missing datapoint, and are ignored. While DELTA metrics are accepted by this alignment, special care should be taken that the values for the metric will always be positive. The output is a GAUGE metric with value_type DOUBLE." + ], + "location": "query", + "type": "string" + }, + "view": { + "description": "Required. Specifies which information is returned about the time series.", + "enum": [ + "FULL", + "HEADERS" + ], + "enumDescriptions": [ + "Returns the identity of the metric(s), the time series, and the time series data.", + "Returns the identity of the metric and the time series resource, but not the time series data." + ], + "location": "query", + "type": "string" + } + }, + "path": "v3/{+name}/timeSeries", + "response": { + "$ref": "ListTimeSeriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ] + } + } + } + } + }, "projects": { "resources": { "alertPolicies": { @@ -1224,7 +1768,7 @@ "type": "string" }, "name": { - "description": "Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] ", + "description": "Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] ", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1246,6 +1790,102 @@ "location": "query", "type": "string" }, + "secondaryAggregation.alignmentPeriod": { + "description": "The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 104 weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "secondaryAggregation.crossSeriesReducer": { + "description": "The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned.", + "enum": [ + "REDUCE_NONE", + "REDUCE_MEAN", + "REDUCE_MIN", + "REDUCE_MAX", + "REDUCE_SUM", + "REDUCE_STDDEV", + "REDUCE_COUNT", + "REDUCE_COUNT_TRUE", + "REDUCE_COUNT_FALSE", + "REDUCE_FRACTION_TRUE", + "REDUCE_PERCENTILE_99", + "REDUCE_PERCENTILE_95", + "REDUCE_PERCENTILE_50", + "REDUCE_PERCENTILE_05" + ], + "enumDescriptions": [ + "No cross-time series reduction. The output of the Aligner is returned.", + "Reduce by computing the mean value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the minimum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the maximum value across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the sum across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric and distribution values. The value_type of the output is the same as the value_type of the input.", + "Reduce by computing the standard deviation across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics with numeric or distribution values. The value_type of the output is DOUBLE.", + "Reduce by computing the number of data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of numeric, Boolean, distribution, and string value_type. The value_type of the output is INT64.", + "Reduce by computing the number of True-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the number of False-valued data points across time series for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The value_type of the output is INT64.", + "Reduce by computing the ratio of the number of True-valued data points to the total number of data points for each alignment period. This reducer is valid for DELTA and GAUGE metrics of Boolean value_type. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Reduce by computing the 99th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 95th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 50th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE.", + "Reduce by computing the 5th percentile (https://en.wikipedia.org/wiki/Percentile) of data points across time series for each alignment period. This reducer is valid for GAUGE and DELTA metrics of numeric and distribution type. The value of the output is DOUBLE." + ], + "location": "query", + "type": "string" + }, + "secondaryAggregation.groupByFields": { + "description": "The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.", + "location": "query", + "repeated": true, + "type": "string" + }, + "secondaryAggregation.perSeriesAligner": { + "description": "An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.", + "enum": [ + "ALIGN_NONE", + "ALIGN_DELTA", + "ALIGN_RATE", + "ALIGN_INTERPOLATE", + "ALIGN_NEXT_OLDER", + "ALIGN_MIN", + "ALIGN_MAX", + "ALIGN_MEAN", + "ALIGN_COUNT", + "ALIGN_SUM", + "ALIGN_STDDEV", + "ALIGN_COUNT_TRUE", + "ALIGN_COUNT_FALSE", + "ALIGN_FRACTION_TRUE", + "ALIGN_PERCENTILE_99", + "ALIGN_PERCENTILE_95", + "ALIGN_PERCENTILE_50", + "ALIGN_PERCENTILE_05", + "ALIGN_PERCENT_CHANGE" + ], + "enumDescriptions": [ + "No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The value_type of the result is the same as the value_type of the input.", + "Align and convert to DELTA. The output is delta = y1 - y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The value_type of the aligned result is the same as the value_type of the input.", + "Align and convert to a rate. The result is computed as rate = (y1 - y0)/(t1 - t0), or \"delta over time\". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the alignment_period.This aligner is valid for CUMULATIVE and DELTA metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a GAUGE metric with value_type DOUBLE.If, by \"rate\", you mean \"percentage change\", see the ALIGN_PERCENT_CHANGE aligner instead.", + "Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for GAUGE metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for GAUGE metrics. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the minimum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the maximum value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the mean value in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the aligned result is DOUBLE.", + "Align the time series by returning the number of values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric or Boolean values. The value_type of the aligned result is INT64.", + "Align the time series by returning the sum of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric and distribution values. The value_type of the aligned result is the same as the value_type of the input.", + "Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for GAUGE and DELTA metrics with numeric values. The value_type of the output is DOUBLE.", + "Align the time series by returning the number of True values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the number of False values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The value_type of the output is INT64.", + "Align the time series by returning the ratio of the number of True values to the total number of values in each alignment period. This aligner is valid for GAUGE metrics with Boolean values. The output value is in the range 0.0, 1.0 and has value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align the time series by using percentile aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for GAUGE and DELTA metrics with distribution values. The output is a GAUGE metric with value_type DOUBLE.", + "Align and convert to a percentage change. This aligner is valid for GAUGE and DELTA metrics with numeric values. This alignment returns ((current - previous)/previous) * 100, where the value of previous is determined based on the alignment_period.If the values of current and previous are both 0, then the returned value is 0. If only previous is 0, the returned value is infinity.A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are >= 0. Any values < 0 are treated as a missing datapoint, and are ignored. While DELTA metrics are accepted by this alignment, special care should be taken that the values for the metric will always be positive. The output is a GAUGE metric with value_type DOUBLE." + ], + "location": "query", + "type": "string" + }, "view": { "description": "Required. Specifies which information is returned about the time series.", "enum": [ @@ -1428,7 +2068,7 @@ ], "parameters": { "name": { - "description": "A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.", + "description": "A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.", "location": "path", "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$", "required": true, @@ -1850,7 +2490,7 @@ } } }, - "revision": "20201005", + "revision": "20210124", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2125,7 +2765,7 @@ "type": "object" }, "ClusterIstio": { - "description": "Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io.", + "description": "Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type.", "id": "ClusterIstio", "properties": { "clusterName": { @@ -2769,18 +3409,18 @@ "description": "The authentication information. Optional when creating an HTTP check; defaults to empty." }, "body": { - "description": "The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields JSON representations are base64 encoded. e.g.: \"foo=bar\" in URL-encoded form is \"foo%3Dbar\" and in base64 encoding is \"Zm9vJTI1M0RiYXI=\".", + "description": "The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: \"foo=bar\" in URL-encoded form is \"foo%3Dbar\" and in base64 encoding is \"Zm9vJTI1M0RiYXI=\".", "format": "byte", "type": "string" }, "contentType": { - "description": "The content type to use for the check.", + "description": "The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a \"Content-Type\" header is provided via headers field. The content_type field should be used instead.", "enum": [ "TYPE_UNSPECIFIED", "URL_ENCODED" ], "enumDescriptions": [ - "No content type specified. If the request method is POST, an unspecified content type results in a check creation rejection.", + "No content type specified.", "body is in URL-encoded form. Equivalent to setting the Content-Type to application/x-www-form-urlencoded in the HTTP request." ], "type": "string" @@ -2871,6 +3511,25 @@ }, "type": "object" }, + "IstioCanonicalService": { + "description": "Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.", + "id": "IstioCanonicalService", + "properties": { + "canonicalService": { + "description": "The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).", + "type": "string" + }, + "canonicalServiceNamespace": { + "description": "The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).", + "type": "string" + }, + "meshUid": { + "description": "Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics (https://cloud.google.com/monitoring/api/metrics_istio).", + "type": "string" + } + }, + "type": "object" + }, "LabelDescriptor": { "description": "A description of a label.", "id": "LabelDescriptor", @@ -3202,7 +3861,7 @@ "type": "object" }, "MeshIstio": { - "description": "Istio service scoped to an Istio mesh", + "description": "Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.", "id": "MeshIstio", "properties": { "meshUid": { @@ -3250,12 +3909,12 @@ "type": "array" }, "duration": { - "description": "The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute--e.g. 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. The Duration.nanos field is ignored.", + "description": "The amount of time that a time series must fail to report new data to be considered failing. The minimum value of this field is 120 seconds. Larger values that are a multiple of a minute--for example, 240 or 300 seconds--are supported. If an invalid value is given, an error will be returned. The Duration.nanos field is ignored.", "format": "google-duration", "type": "string" }, "filter": { - "description": "A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.", + "description": "A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.", "type": "string" }, "trigger": { @@ -3301,7 +3960,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation." @@ -3344,7 +4003,7 @@ "type": "string" }, "unit": { - "description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean \"5300 page views per day\"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means \"3 percent\"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means \"3 percent\").", + "description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean \"5300 page views per day\"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means \"3 percent\"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means \"3 percent\").", "type": "string" }, "valueType": { @@ -3398,7 +4057,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation." @@ -3478,7 +4137,7 @@ "type": "string" }, "filter": { - "description": "A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.", + "description": "A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.", "type": "string" }, "thresholdValue": { @@ -3547,7 +4206,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation." @@ -3588,7 +4247,7 @@ "type": "object" }, "MonitoringQueryLanguageCondition": { - "description": "A condition type that allows alert policies to be defined using Monitoring Query Language.", + "description": "A condition type that allows alert policies to be defined using Monitoring Query Language (https://cloud.google.com/monitoring/mql).", "id": "MonitoringQueryLanguageCondition", "properties": { "duration": { @@ -3597,7 +4256,7 @@ "type": "string" }, "query": { - "description": "Monitoring Query Language query that outputs a boolean stream.", + "description": "Monitoring Query Language (https://cloud.google.com/monitoring/mql) query that outputs a boolean stream.", "type": "string" }, "trigger": { @@ -3627,6 +4286,10 @@ "description": "A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.", "id": "NotificationChannel", "properties": { + "creationRecord": { + "$ref": "MutationRecord", + "description": "Record of the creation of this channel." + }, "description": { "description": "An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.", "type": "string" @@ -3646,6 +4309,13 @@ "description": "Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.", "type": "object" }, + "mutationRecords": { + "description": "Records of the modification of this channel.", + "items": { + "$ref": "MutationRecord" + }, + "type": "array" + }, "name": { "description": "The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", "type": "string" @@ -3714,7 +4384,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation." @@ -3940,6 +4610,10 @@ "description": "Name used for UI elements listing this Service.", "type": "string" }, + "istioCanonicalService": { + "$ref": "IstioCanonicalService", + "description": "Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/)" + }, "meshIstio": { "$ref": "MeshIstio", "description": "Type used for Istio services scoped to an Istio mesh." @@ -4374,7 +5048,7 @@ "description": "The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for Uptime checks: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer" }, "name": { - "description": "A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.", + "description": "A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.", "type": "string" }, "period": {
diff --git a/discovery/googleapis/networkmanagement__v1.json b/discovery/googleapis/networkmanagement__v1.json index 78f7df7..c65e2e9 100644 --- a/discovery/googleapis/networkmanagement__v1.json +++ b/discovery/googleapis/networkmanagement__v1.json
@@ -574,7 +574,7 @@ } } }, - "revision": "20201001", + "revision": "20201105", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -670,6 +670,9 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { + "bindingId": { + "type": "string" + }, "condition": { "$ref": "Expr", "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 members 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)."
diff --git a/discovery/googleapis/notebooks__v1.json b/discovery/googleapis/notebooks__v1.json new file mode 100644 index 0000000..dc58e2c --- /dev/null +++ b/discovery/googleapis/notebooks__v1.json
@@ -0,0 +1,2541 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://notebooks.googleapis.com/", + "batchPath": "batch", + "canonicalName": "AI Platform Notebooks", + "description": "AI Platform Notebooks API is used to manage notebook resources in Google Cloud.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/ai-platform/notebooks/docs/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "notebooks:v1", + "kind": "discovery#restDescription", + "name": "notebooks", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "environments": { + "methods": { + "create": { + "description": "Creates a new Environment.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.environments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "environmentId": { + "description": "Required. User-defined unique ID of this environment. The `environment_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/environments", + "request": { + "$ref": "Environment" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Environment.", + "httpMethod": "DELETE", + "id": "notebooks.projects.locations.environments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Environment.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.environments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Environment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists environments in a project.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.environments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum return size of the list call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A previous returned page token that can be used to continue listing from the last result.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/environments", + "response": { + "$ref": "ListEnvironmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "executions": { + "methods": { + "create": { + "description": "Creates a new Scheduled Notebook in a given project and location.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.executions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "executionId": { + "description": "Required. User-defined unique ID of this execution.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/executions", + "request": { + "$ref": "Execution" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes execution", + "httpMethod": "DELETE", + "id": "notebooks.projects.locations.executions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of executions", + "httpMethod": "GET", + "id": "notebooks.projects.locations.executions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/schedules/{execution_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Execution" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists executions in a given project and location", + "httpMethod": "GET", + "id": "notebooks.projects.locations.executions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter applied to resulting executions.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sort by field.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum return size of the list call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A previous returned page token that can be used to continue listing from the last result.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/executions", + "response": { + "$ref": "ListExecutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "instances": { + "methods": { + "create": { + "description": "Creates a new Instance in a given project and location.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "instanceId": { + "description": "Required. User-defined unique ID of this instance.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instances", + "request": { + "$ref": "Instance" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Instance.", + "httpMethod": "DELETE", + "id": "notebooks.projects.locations.instances.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Instance.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.instances.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Instance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.instances.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getInstanceHealth": { + "description": "Check if a notebook instance is healthy.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.instances.getInstanceHealth", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:getInstanceHealth", + "response": { + "$ref": "GetInstanceHealthResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "isUpgradeable": { + "description": "Check if a notebook instance is upgradable.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.instances.isUpgradeable", + "parameterOrder": [ + "notebookInstance" + ], + "parameters": { + "notebookInstance": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+notebookInstance}:isUpgradeable", + "response": { + "$ref": "IsInstanceUpgradeableResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists instances in a given project and location.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.instances.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum return size of the list call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A previous returned page token that can be used to continue listing from the last result.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instances", + "response": { + "$ref": "ListInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "register": { + "description": "Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.register", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/instances:register", + "request": { + "$ref": "RegisterInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "report": { + "description": "Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.report", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:report", + "request": { + "$ref": "ReportInstanceInfoRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reset": { + "description": "Resets a notebook instance.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.reset", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reset", + "request": { + "$ref": "ResetInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setAccelerator": { + "description": "Updates the guest accelerators of a single Instance.", + "httpMethod": "PATCH", + "id": "notebooks.projects.locations.instances.setAccelerator", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:setAccelerator", + "request": { + "$ref": "SetInstanceAcceleratorRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setLabels": { + "description": "Replaces all the labels of an Instance.", + "httpMethod": "PATCH", + "id": "notebooks.projects.locations.instances.setLabels", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:setLabels", + "request": { + "$ref": "SetInstanceLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setMachineType": { + "description": "Updates the machine type of a single Instance.", + "httpMethod": "PATCH", + "id": "notebooks.projects.locations.instances.setMachineType", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:setMachineType", + "request": { + "$ref": "SetInstanceMachineTypeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "start": { + "description": "Starts a notebook instance.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.start", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:start", + "request": { + "$ref": "StartInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stop": { + "description": "Stops a notebook instance.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.stop", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:stop", + "request": { + "$ref": "StopInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upgrade": { + "description": "Upgrades a notebook instance to the latest version.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.upgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:upgrade", + "request": { + "$ref": "UpgradeInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upgradeInternal": { + "description": "Allows notebook instances to call this endpoint to upgrade themselves. Do not use this method directly.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.upgradeInternal", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:upgradeInternal", + "request": { + "$ref": "UpgradeInstanceInternalRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "notebooks.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "schedules": { + "methods": { + "create": { + "description": "Creates a new Scheduled Notebook in a given project and location.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.schedules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "scheduleId": { + "description": "Required. User-defined unique ID of this schedule.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/schedules", + "request": { + "$ref": "Schedule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes schedule and all underlying jobs", + "httpMethod": "DELETE", + "id": "notebooks.projects.locations.schedules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of schedule", + "httpMethod": "GET", + "id": "notebooks.projects.locations.schedules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Schedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists schedules in a given project and location.", + "httpMethod": "GET", + "id": "notebooks.projects.locations.schedules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter applied to resulting schedules.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to order results by.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum return size of the list call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A previous returned page token that can be used to continue listing from the last result.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schedules", + "response": { + "$ref": "ListSchedulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "trigger": { + "description": "Triggers execution of an existing schedule.", + "httpMethod": "POST", + "id": "notebooks.projects.locations.schedules.trigger", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `parent=projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:trigger", + "request": { + "$ref": "TriggerScheduleRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210122", + "rootUrl": "https://notebooks.googleapis.com/", + "schemas": { + "AcceleratorConfig": { + "description": "Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.", + "id": "AcceleratorConfig", + "properties": { + "coreCount": { + "description": "Count of cores of this accelerator.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Type of this accelerator.", + "enum": [ + "ACCELERATOR_TYPE_UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_V100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", + "NVIDIA_TESLA_T4_VWS", + "NVIDIA_TESLA_P100_VWS", + "NVIDIA_TESLA_P4_VWS", + "TPU_V2", + "TPU_V3" + ], + "enumDescriptions": [ + "Accelerator type is not specified.", + "Accelerator type is Nvidia Tesla K80.", + "Accelerator type is Nvidia Tesla P100.", + "Accelerator type is Nvidia Tesla V100.", + "Accelerator type is Nvidia Tesla P4.", + "Accelerator type is Nvidia Tesla T4.", + "Accelerator type is Nvidia Tesla A100.", + "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", + "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", + "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", + "(Coming soon) Accelerator type is TPU V2.", + "(Coming soon) Accelerator type is TPU V3." + ], + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "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 members 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)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "ContainerImage": { + "description": "Definition of a container image for starting a notebook instance with the environment installed in a container.", + "id": "ContainerImage", + "properties": { + "repository": { + "description": "Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`", + "type": "string" + }, + "tag": { + "description": "The tag of the container image. If not specified, this defaults to the latest tag.", + "type": "string" + } + }, + "type": "object" + }, + "Disk": { + "description": "An instance-attached disk resource.", + "id": "Disk", + "properties": { + "autoDelete": { + "description": "Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", + "type": "boolean" + }, + "boot": { + "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", + "type": "boolean" + }, + "deviceName": { + "description": "Indicates a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.", + "type": "string" + }, + "diskSizeGb": { + "description": "Indicates the size of the disk in base-2 GB.", + "format": "int64", + "type": "string" + }, + "guestOsFeatures": { + "description": "Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, + "index": { + "description": "A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.", + "format": "int64", + "type": "string" + }, + "interface": { + "description": "Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values: NVME SCSI", + "type": "string" + }, + "kind": { + "description": "Type of the resource. Always compute#attachedDisk for attached disks.", + "type": "string" + }, + "licenses": { + "description": "A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mode": { + "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values: READ_ONLY READ_WRITE", + "type": "string" + }, + "source": { + "description": "Indicates a valid partial or full URL to an existing Persistent Disk resource.", + "type": "string" + }, + "type": { + "description": "Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: PERSISTENT SCRATCH", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Environment": { + "description": "Definition of a software environment that is used to start a notebook instance.", + "id": "Environment", + "properties": { + "containerImage": { + "$ref": "ContainerImage", + "description": "Use a container image to start the notebook instance." + }, + "createTime": { + "description": "Output only. The time at which this environment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "A brief description of this environment.", + "type": "string" + }, + "displayName": { + "description": "Display name of this environment for the UI.", + "type": "string" + }, + "name": { + "description": "Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`", + "readOnly": true, + "type": "string" + }, + "postStartupScript": { + "description": "Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `\"gs://path-to-file/file-name\"`", + "type": "string" + }, + "vmImage": { + "$ref": "VmImage", + "description": "Use a Compute Engine VM image to start the notebook instance." + } + }, + "type": "object" + }, + "Execution": { + "description": "The definition of a single executed notebook.", + "id": "Execution", + "properties": { + "createTime": { + "description": "Output only. Time the Execution was instantiated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "A brief description of this execution.", + "type": "string" + }, + "displayName": { + "description": "Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.", + "readOnly": true, + "type": "string" + }, + "executionTemplate": { + "$ref": "ExecutionTemplate", + "description": "execute metadata including name, hardware spec, region, labels, etc." + }, + "name": { + "description": "Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/execution/{execution_id}", + "readOnly": true, + "type": "string" + }, + "outputNotebookFile": { + "description": "Output notebook file generated by this execution", + "type": "string" + }, + "state": { + "description": "Output only. State of the underlying AI Platform job.", + "enum": [ + "STATE_UNSPECIFIED", + "QUEUED", + "PREPARING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLING", + "CANCELLED" + ], + "enumDescriptions": [ + "The job state is unspecified.", + "The job has been just created and processing has not yet begun.", + "The service is preparing to execution the job.", + "The job is in progress.", + "The job completed successfully.", + "The job failed. `error_message` should contain the details of the failure.", + "The job is being cancelled. `error_message` should describe the reason for the cancellation.", + "The job has been cancelled. `error_message` should describe the reason for the cancellation." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time the Execution was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ExecutionTemplate": { + "description": "The description a notebook execution workload.", + "id": "ExecutionTemplate", + "properties": { + "acceleratorConfig": { + "$ref": "SchedulerAcceleratorConfig", + "description": "Configuration (count and accelerator type) for hardware running notebook execution." + }, + "containerImageUri": { + "description": "Container Image URI to a DLVM Example: 'gcr.io/deeplearning-platform-release/base-cu100' More examples can be found at: https://cloud.google.com/ai-platform/deep-learning-containers/docs/choosing-container", + "type": "string" + }, + "inputNotebookFile": { + "description": "Path to the notebook file to execute. Must be in a Google Cloud Storage bucket. Format: gs://{project_id}/{folder}/{notebook_file_name} Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook.ipynb", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels for execution. If execution is scheduled, a field included will be 'nbs-scheduled'. Otherwise, it is an immediate execution, and an included field will be 'nbs-immediate'. Use fields to efficiently index between various types of executions.", + "type": "object" + }, + "masterType": { + "description": "Specifies the type of virtual machine to use for your training job's master worker. You must specify this field when `scaleTier` is set to `CUSTOM`. You can use certain Compute Engine machine types directly in this field. The following types are supported: - `n1-standard-4` - `n1-standard-8` - `n1-standard-16` - `n1-standard-32` - `n1-standard-64` - `n1-standard-96` - `n1-highmem-2` - `n1-highmem-4` - `n1-highmem-8` - `n1-highmem-16` - `n1-highmem-32` - `n1-highmem-64` - `n1-highmem-96` - `n1-highcpu-16` - `n1-highcpu-32` - `n1-highcpu-64` - `n1-highcpu-96` Alternatively, you can use the following legacy machine types: - `standard` - `large_model` - `complex_model_s` - `complex_model_m` - `complex_model_l` - `standard_gpu` - `complex_model_m_gpu` - `complex_model_l_gpu` - `standard_p100` - `complex_model_m_p100` - `standard_v100` - `large_model_v100` - `complex_model_m_v100` - `complex_model_l_v100` Finally, if you want to use a TPU for training, specify `cloud_tpu` in this field. Learn more about the [special configuration options for training with TPU.", + "type": "string" + }, + "outputNotebookFolder": { + "description": "Path to the notebook folder to write to. Must be in a Google Cloud Storage bucket path. Format: gs://{project_id}/{folder} Ex: gs://notebook_user/scheduled_notebooks", + "type": "string" + }, + "paramsYamlFile": { + "description": "Parameters to be overridden in the notebook during execution. Ref https://papermill.readthedocs.io/en/latest/usage-parameterize.html on how to specifying parameters in the input notebook and pass them here in an YAML file. Ex: gs://notebook_user/scheduled_notebooks/sentiment_notebook_params.yaml", + "type": "string" + }, + "scaleTier": { + "description": "Required. Scale tier of the hardware used for notebook execution.", + "enum": [ + "SCALE_TIER_UNSPECIFIED", + "BASIC", + "STANDARD_1", + "PREMIUM_1", + "BASIC_GPU", + "BASIC_TPU", + "CUSTOM" + ], + "enumDescriptions": [ + "Unspecified Scale Tier.", + "A single worker instance. This tier is suitable for learning how to use Cloud ML, and for experimenting with new models using small datasets.", + "Many workers and a few parameter servers.", + "A large number of workers with many parameter servers.", + "A single worker instance with a K80 GPU.", + "A single worker instance with a Cloud TPU.", + "The CUSTOM tier is not a set tier, but rather enables you to use your own cluster specification. When you use this tier, set values to configure your processing cluster according to these guidelines: * You _must_ set `TrainingInput.masterType` to specify the type of machine to use for your master node. This is the only required setting. * You _may_ set `TrainingInput.workerCount` to specify the number of workers to use. If you specify one or more workers, you _must_ also set `TrainingInput.workerType` to specify the type of machine to use for your worker nodes. * You _may_ set `TrainingInput.parameterServerCount` to specify the number of parameter servers to use. If you specify one or more parameter servers, you _must_ also set `TrainingInput.parameterServerType` to specify the type of machine to use for your parameter servers. Note that all of your workers must use the same machine type, which can be different from your parameter server type and master type. Your parameter servers must likewise use the same machine type, which can be different from your worker type and master type." + ], + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "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() < 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", + "properties": { + "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" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "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" + }, + "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" + }, + "GetInstanceHealthResponse": { + "description": "Response for checking if a notebook instance is healthy.", + "id": "GetInstanceHealthResponse", + "properties": { + "healthInfo": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. Additional information about instance health. Example: healthInfo\": { \"docker_proxy_agent_status\": \"1\", \"docker_status\": \"1\", \"jupyterlab_api_status\": \"-1\", \"jupyterlab_status\": \"-1\", \"updated\": \"2020-10-18 09:40:03.573409\" }", + "readOnly": true, + "type": "object" + }, + "healthState": { + "description": "Output only. Runtime health_state.", + "enum": [ + "HEALTH_STATE_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "AGENT_NOT_INSTALLED", + "AGENT_NOT_RUNNING" + ], + "enumDescriptions": [ + "The instance substate is unknown.", + "The instance is known to be in an healthy state (for example, critical daemons are running) Applies to ACTIVE state.", + "The instance is known to be in an unhealthy state (for example, critical daemons are not running) Applies to ACTIVE state.", + "The instance has not installed health monitoring agent. Applies to ACTIVE state.", + "The instance health monitoring agent is not running. Applies to ACTIVE state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GuestOsFeature": { + "description": "Guest OS features for boot disk.", + "id": "GuestOsFeature", + "properties": { + "type": { + "description": "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values: FEATURE_TYPE_UNSPECIFIED MULTI_IP_SUBNET SECURE_BOOT UEFI_COMPATIBLE VIRTIO_SCSI_MULTIQUEUE WINDOWS", + "type": "string" + } + }, + "type": "object" + }, + "Instance": { + "description": "The definition of a notebook instance.", + "id": "Instance", + "properties": { + "acceleratorConfig": { + "$ref": "AcceleratorConfig", + "description": "The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](/compute/docs/gpus/#gpus-list)." + }, + "bootDiskSizeGb": { + "description": "Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.", + "format": "int64", + "type": "string" + }, + "bootDiskType": { + "description": "Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).", + "enum": [ + "DISK_TYPE_UNSPECIFIED", + "PD_STANDARD", + "PD_SSD", + "PD_BALANCED" + ], + "enumDescriptions": [ + "Disk type not set.", + "Standard persistent disk type.", + "SSD persistent disk type.", + "Balanced persistent disk type." + ], + "type": "string" + }, + "containerImage": { + "$ref": "ContainerImage", + "description": "Use a container image to start the notebook instance." + }, + "createTime": { + "description": "Output only. Instance creation time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customGpuDriverPath": { + "description": "Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.", + "type": "string" + }, + "dataDiskSizeGb": { + "description": "Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.", + "format": "int64", + "type": "string" + }, + "dataDiskType": { + "description": "Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).", + "enum": [ + "DISK_TYPE_UNSPECIFIED", + "PD_STANDARD", + "PD_SSD", + "PD_BALANCED" + ], + "enumDescriptions": [ + "Disk type not set.", + "Standard persistent disk type.", + "SSD persistent disk type.", + "Balanced persistent disk type." + ], + "type": "string" + }, + "diskEncryption": { + "description": "Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.", + "enum": [ + "DISK_ENCRYPTION_UNSPECIFIED", + "GMEK", + "CMEK" + ], + "enumDescriptions": [ + "Disk encryption is not specified.", + "Use Google managed encryption keys to encrypt the boot disk.", + "Use customer managed encryption keys to encrypt the boot disk." + ], + "type": "string" + }, + "disks": { + "description": "Output only. Attached disks to notebook instance.", + "items": { + "$ref": "Disk" + }, + "readOnly": true, + "type": "array" + }, + "installGpuDriver": { + "description": "Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.", + "type": "boolean" + }, + "instanceOwners": { + "description": "Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.", + "items": { + "type": "string" + }, + "type": "array" + }, + "kmsKey": { + "description": "Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: `projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}` Learn more about [using your own encryption keys](/kms/docs/quickstart).", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this instance. These can be later modified by the setLabels method.", + "type": "object" + }, + "machineType": { + "description": "Required. The [Compute Engine machine type](/compute/docs/machine-types) of this instance.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Custom metadata to apply to this instance.", + "type": "object" + }, + "name": { + "description": "Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "readOnly": true, + "type": "string" + }, + "network": { + "description": "The name of the VPC that this instance is in. Format: `projects/{project_id}/global/networks/{network_id}`", + "type": "string" + }, + "noProxyAccess": { + "description": "If true, the notebook instance will not register with the proxy.", + "type": "boolean" + }, + "noPublicIp": { + "description": "If true, no public IP will be assigned to this instance.", + "type": "boolean" + }, + "noRemoveDataDisk": { + "description": "Input only. If true, the data disk will not be auto deleted when deleting the instance.", + "type": "boolean" + }, + "postStartupScript": { + "description": "Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).", + "type": "string" + }, + "proxyUri": { + "description": "Output only. The proxy endpoint that is used to access the Jupyter notebook.", + "readOnly": true, + "type": "string" + }, + "serviceAccount": { + "description": "The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", + "type": "string" + }, + "serviceAccountScopes": { + "description": "Optional. The URIs of service account scopes to be included in Compute Engine instances. If not specified, the following [scopes](https://cloud.google.com/compute/docs/access/service-accounts#accesscopesiam) are defined: - https://www.googleapis.com/auth/cloud-platform - https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least: https://www.googleapis.com/auth/compute", + "items": { + "type": "string" + }, + "type": "array" + }, + "shieldedInstanceConfig": { + "$ref": "ShieldedInstanceConfig", + "description": "Optional. Shielded VM configuration. [Images using supported Shielded VM features] (https://cloud.google.com/compute/docs/instances/modifying-shielded-vm)." + }, + "state": { + "description": "Output only. The state of this instance.", + "enum": [ + "STATE_UNSPECIFIED", + "STARTING", + "PROVISIONING", + "ACTIVE", + "STOPPING", + "STOPPED", + "DELETED", + "UPGRADING", + "INITIALIZING", + "REGISTERING" + ], + "enumDescriptions": [ + "State is not specified.", + "The control logic is starting the instance.", + "The control logic is installing required frameworks and registering the instance with notebook proxy", + "The instance is running.", + "The control logic is stopping the instance.", + "The instance is stopped.", + "The instance is deleted.", + "The instance is upgrading.", + "The instance is being created.", + "The instance is getting registered." + ], + "readOnly": true, + "type": "string" + }, + "subnet": { + "description": "The name of the subnet that this instance is in. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", + "type": "string" + }, + "tags": { + "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. Instance update time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "upgradeHistory": { + "description": "The upgrade history of this instance.", + "items": { + "$ref": "UpgradeHistoryEntry" + }, + "type": "array" + }, + "vmImage": { + "$ref": "VmImage", + "description": "Use a Compute Engine VM image to start the notebook instance." + } + }, + "type": "object" + }, + "IsInstanceUpgradeableResponse": { + "description": "Response for checking if a notebook instance is upgradeable.", + "id": "IsInstanceUpgradeableResponse", + "properties": { + "upgradeInfo": { + "description": "Additional information about upgrade.", + "type": "string" + }, + "upgradeVersion": { + "description": "The version this instance will be upgraded to if calling the upgrade endpoint. This field will only be populated if field upgradeable is true.", + "type": "string" + }, + "upgradeable": { + "description": "If an instance is upgradeable.", + "type": "boolean" + } + }, + "type": "object" + }, + "ListEnvironmentsResponse": { + "description": "Response for listing environments.", + "id": "ListEnvironmentsResponse", + "properties": { + "environments": { + "description": "A list of returned environments.", + "items": { + "$ref": "Environment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A page token that can be used to continue listing from the last result in the next list call.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListExecutionsResponse": { + "description": "Response for listing scheduled notebook executions", + "id": "ListExecutionsResponse", + "properties": { + "executions": { + "description": "A list of returned instances.", + "items": { + "$ref": "Execution" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Page token that can be used to continue listing from the last result in the next list call.", + "type": "string" + }, + "unreachable": { + "description": "Executions IDs that could not be reached. For example, ['projects/{project_id}/location/{location}/executions/imagenet_test1', 'projects/{project_id}/location/{location}/executions/classifier_train1'].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListInstancesResponse": { + "description": "Response for listing notebook instances.", + "id": "ListInstancesResponse", + "properties": { + "instances": { + "description": "A list of returned instances.", + "items": { + "$ref": "Instance" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Page token that can be used to continue listing from the last result in the next list call.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached. For example, ['us-west1-a', 'us-central1-b']. A ListInstancesResponse will only contain either instances or unreachables,", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSchedulesResponse": { + "description": "Response for listing scheduled notebook job.", + "id": "ListSchedulesResponse", + "properties": { + "nextPageToken": { + "description": "Page token that can be used to continue listing from the last result in the next list call.", + "type": "string" + }, + "schedules": { + "description": "A list of returned instances.", + "items": { + "$ref": "Schedule" + }, + "type": "array" + }, + "unreachable": { + "description": "Schedules that could not be reached. For example, ['projects/{project_id}/location/{location}/schedules/monthly_digest', 'projects/{project_id}/location/{location}/schedules/weekly_sentiment'].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "API version used to start the operation.", + "type": "string" + }, + "createTime": { + "description": "The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "endpoint": { + "description": "API endpoint name of this operation.", + "type": "string" + }, + "requestedCancellation": { + "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "type": "boolean" + }, + "statusMessage": { + "description": "Human-readable status of the operation, if any.", + "type": "string" + }, + "target": { + "description": "Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "Policy": { + "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` to a single `role`. Members 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 < 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 < 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/).", + "id": "Policy", + "properties": { + "bindings": { + "description": "Associates a list of `members` to 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 member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "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" + }, + "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "RegisterInstanceRequest": { + "description": "Request for registering a notebook instance.", + "id": "RegisterInstanceRequest", + "properties": { + "instanceId": { + "description": "Required. User defined unique ID of this instance. The `instance_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.", + "type": "string" + } + }, + "type": "object" + }, + "ReportInstanceInfoRequest": { + "description": "Request for notebook instances to report information to Notebooks API.", + "id": "ReportInstanceInfoRequest", + "properties": { + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "The metadata reported to Notebooks API. This will be merged to the instance metadata store", + "type": "object" + }, + "vmId": { + "description": "Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity", + "type": "string" + } + }, + "type": "object" + }, + "ResetInstanceRequest": { + "description": "Request for reseting a notebook instance", + "id": "ResetInstanceRequest", + "properties": {}, + "type": "object" + }, + "Schedule": { + "description": "The definition of a schedule.", + "id": "Schedule", + "properties": { + "createTime": { + "description": "Output only. Time the schedule was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "cronSchedule": { + "description": "Cron-tab formatted schedule by which the job will execute Format: minute, hour, day of month, month, day of week e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html", + "type": "string" + }, + "description": { + "description": "A brief description of this environment.", + "type": "string" + }, + "displayName": { + "description": "Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens ‘-’, and underscores ‘_’.", + "readOnly": true, + "type": "string" + }, + "executionTemplate": { + "$ref": "ExecutionTemplate", + "description": "Notebook Execution Template corresponding to this schedule." + }, + "name": { + "description": "Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "readOnly": true, + "type": "string" + }, + "state": { + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "PAUSED", + "DISABLED", + "UPDATE_FAILED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The job is executing normally.", + "The job is paused by the user. It will not execute. A user can intentionally pause the job using PauseJobRequest.", + "The job is disabled by the system due to error. The user cannot directly set a job to be disabled.", + "The job state resulting from a failed CloudScheduler.UpdateJob operation. To recover a job from this state, retry CloudScheduler.UpdateJob until a successful response is received." + ], + "type": "string" + }, + "timeZone": { + "description": "Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string \"utc\". If a time zone is not specified, the default will be in UTC (also known as GMT).", + "type": "string" + }, + "updateTime": { + "description": "Output only. TIme the schedule was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SchedulerAcceleratorConfig": { + "description": "Definition of a hardware accelerator. Note that not all combinations of `type` and `core_count` are valid. Check GPUs on Compute Engine to find a valid combination. TPUs are not supported.", + "id": "SchedulerAcceleratorConfig", + "properties": { + "coreCount": { + "description": "Count of cores of this accelerator.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Type of this accelerator.", + "enum": [ + "SCHEDULER_ACCELERATOR_TYPE_UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_V100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "TPU_V2", + "TPU_V3" + ], + "enumDescriptions": [ + "Unspecified accelerator type. Default to no GPU.", + "Nvidia Tesla K80 GPU.", + "Nvidia Tesla P100 GPU.", + "Nvidia Tesla V100 GPU.", + "Nvidia Tesla P4 GPU.", + "Nvidia Tesla T4 GPU.", + "TPU v2.", + "TPU v3." + ], + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "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 Cloud Platform services (such as Projects) might reject them." + } + }, + "type": "object" + }, + "SetInstanceAcceleratorRequest": { + "description": "Request for setting instance accelerator.", + "id": "SetInstanceAcceleratorRequest", + "properties": { + "coreCount": { + "description": "Required. Count of cores of this accelerator. Note that not all combinations of `type` and `core_count` are valid. Check [GPUs on Compute Engine](https://cloud.google.com/compute/docs/gpus/#gpus-list) to find a valid combination. TPUs are not supported.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "Required. Type of this accelerator.", + "enum": [ + "ACCELERATOR_TYPE_UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100", + "NVIDIA_TESLA_V100", + "NVIDIA_TESLA_P4", + "NVIDIA_TESLA_T4", + "NVIDIA_TESLA_A100", + "NVIDIA_TESLA_T4_VWS", + "NVIDIA_TESLA_P100_VWS", + "NVIDIA_TESLA_P4_VWS", + "TPU_V2", + "TPU_V3" + ], + "enumDescriptions": [ + "Accelerator type is not specified.", + "Accelerator type is Nvidia Tesla K80.", + "Accelerator type is Nvidia Tesla P100.", + "Accelerator type is Nvidia Tesla V100.", + "Accelerator type is Nvidia Tesla P4.", + "Accelerator type is Nvidia Tesla T4.", + "Accelerator type is Nvidia Tesla A100.", + "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", + "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", + "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", + "(Coming soon) Accelerator type is TPU V2.", + "(Coming soon) Accelerator type is TPU V3." + ], + "type": "string" + } + }, + "type": "object" + }, + "SetInstanceLabelsRequest": { + "description": "Request for setting instance labels.", + "id": "SetInstanceLabelsRequest", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to this instance. These can be later modified by the setLabels method", + "type": "object" + } + }, + "type": "object" + }, + "SetInstanceMachineTypeRequest": { + "description": "Request for setting instance machine type.", + "id": "SetInstanceMachineTypeRequest", + "properties": { + "machineType": { + "description": "Required. The [Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types).", + "type": "string" + } + }, + "type": "object" + }, + "ShieldedInstanceConfig": { + "description": "A set of Shielded Instance options. Check [Images using supported Shielded VM features] Not all combinations are valid.", + "id": "ShieldedInstanceConfig", + "properties": { + "enableIntegrityMonitoring": { + "description": "Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.", + "type": "boolean" + }, + "enableSecureBoot": { + "description": "Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.", + "type": "boolean" + }, + "enableVtpm": { + "description": "Defines whether the instance has the vTPM enabled. Enabled by default.", + "type": "boolean" + } + }, + "type": "object" + }, + "StartInstanceRequest": { + "description": "Request for starting a notebook instance", + "id": "StartInstanceRequest", + "properties": {}, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "StopInstanceRequest": { + "description": "Request for stopping a notebook instance", + "id": "StopInstanceRequest", + "properties": {}, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "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": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TriggerScheduleRequest": { + "description": "Request for created scheduled notebooks", + "id": "TriggerScheduleRequest", + "properties": {}, + "type": "object" + }, + "UpgradeHistoryEntry": { + "description": "The entry of VM image upgrade history.", + "id": "UpgradeHistoryEntry", + "properties": { + "action": { + "description": "Action. Rolloback or Upgrade.", + "enum": [ + "ACTION_UNSPECIFIED", + "UPGRADE", + "ROLLBACK" + ], + "enumDescriptions": [ + "Operation is not specified.", + "Upgrade.", + "Rollback." + ], + "type": "string" + }, + "containerImage": { + "description": "The container image before this instance upgrade.", + "type": "string" + }, + "createTime": { + "description": "The time that this instance upgrade history entry is created.", + "format": "google-datetime", + "type": "string" + }, + "framework": { + "description": "The framework of this notebook instance.", + "type": "string" + }, + "snapshot": { + "description": "The snapshot of the boot disk of this notebook instance before upgrade.", + "type": "string" + }, + "state": { + "description": "The state of this instance upgrade history entry.", + "enum": [ + "STATE_UNSPECIFIED", + "STARTED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "State is not specified.", + "The instance upgrade is started.", + "The instance upgrade is succeeded.", + "The instance upgrade is failed." + ], + "type": "string" + }, + "targetImage": { + "description": "Target VM Image. Format: ainotebooks-vm/project/image-name/name.", + "type": "string" + }, + "version": { + "description": "The version of the notebook instance before this upgrade.", + "type": "string" + }, + "vmImage": { + "description": "The VM image before this instance upgrade.", + "type": "string" + } + }, + "type": "object" + }, + "UpgradeInstanceInternalRequest": { + "description": "Request for upgrading a notebook instance from within the VM", + "id": "UpgradeInstanceInternalRequest", + "properties": { + "vmId": { + "description": "Required. The VM hardware token for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity", + "type": "string" + } + }, + "type": "object" + }, + "UpgradeInstanceRequest": { + "description": "Request for upgrading a notebook instance", + "id": "UpgradeInstanceRequest", + "properties": {}, + "type": "object" + }, + "VmImage": { + "description": "Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM.", + "id": "VmImage", + "properties": { + "imageFamily": { + "description": "Use this VM image family to find the image; the newest image in this family will be used.", + "type": "string" + }, + "imageName": { + "description": "Use VM image name to find the image.", + "type": "string" + }, + "project": { + "description": "Required. The name of the Google Cloud project that this VM image belongs to. Format: `projects/{project_id}`", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Notebooks API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/osconfig__v1.json b/discovery/googleapis/osconfig__v1.json index 7f66287..74f5f23 100644 --- a/discovery/googleapis/osconfig__v1.json +++ b/discovery/googleapis/osconfig__v1.json
@@ -395,7 +395,7 @@ } } }, - "revision": "20200930", + "revision": "20210122", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -576,6 +576,292 @@ "properties": {}, "type": "object" }, + "Inventory": { + "description": "The inventory details of a VM.", + "id": "Inventory", + "properties": { + "items": { + "additionalProperties": { + "$ref": "InventoryItem" + }, + "description": "Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version.", + "type": "object" + }, + "osInfo": { + "$ref": "InventoryOsInfo", + "description": "Base level operating system information for the VM." + } + }, + "type": "object" + }, + "InventoryItem": { + "description": "A single piece of inventory on a VM.", + "id": "InventoryItem", + "properties": { + "availablePackage": { + "$ref": "InventorySoftwarePackage", + "description": "Software package available to be installed on the VM instance." + }, + "createTime": { + "description": "When this inventory item was first detected.", + "format": "google-datetime", + "type": "string" + }, + "id": { + "description": "Identifier for this item, unique across items for this VM.", + "type": "string" + }, + "installedPackage": { + "$ref": "InventorySoftwarePackage", + "description": "Software package present on the VM instance." + }, + "originType": { + "description": "The origin of this inventory item.", + "enum": [ + "ORIGIN_TYPE_UNSPECIFIED", + "INVENTORY_REPORT" + ], + "enumDescriptions": [ + "Invalid. An origin type must be specified.", + "This inventory item was discovered as the result of the agent reporting inventory via the reporting API." + ], + "type": "string" + }, + "type": { + "description": "The specific type of inventory, correlating to its specific details.", + "enum": [ + "TYPE_UNSPECIFIED", + "INSTALLED_PACKAGE", + "AVAILABLE_PACKAGE" + ], + "enumDescriptions": [ + "Invalid. An type must be specified.", + "This represents a package that is installed on the VM.", + "This represents an update that is available for a package." + ], + "type": "string" + }, + "updateTime": { + "description": "When this inventory item was last modified.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "InventoryOsInfo": { + "description": "Operating system information for the VM.", + "id": "InventoryOsInfo", + "properties": { + "architecture": { + "description": "The system architecture of the operating system.", + "type": "string" + }, + "hostname": { + "description": "The VM hostname.", + "type": "string" + }, + "kernelRelease": { + "description": "The kernel release of the operating system.", + "type": "string" + }, + "kernelVersion": { + "description": "The kernel version of the operating system.", + "type": "string" + }, + "longName": { + "description": "The operating system long name. For example 'Debian GNU/Linux 9' or 'Microsoft Window Server 2019 Datacenter'.", + "type": "string" + }, + "osconfigAgentVersion": { + "description": "The current version of the OS Config agent running on the VM.", + "type": "string" + }, + "shortName": { + "description": "The operating system short name. For example, 'windows' or 'debian'.", + "type": "string" + }, + "version": { + "description": "The version of the operating system.", + "type": "string" + } + }, + "type": "object" + }, + "InventorySoftwarePackage": { + "description": "Software package information of the operating system.", + "id": "InventorySoftwarePackage", + "properties": { + "aptPackage": { + "$ref": "InventoryVersionedPackage", + "description": "Details of an APT package. For details about the apt package manager, see https://wiki.debian.org/Apt." + }, + "cosPackage": { + "$ref": "InventoryVersionedPackage", + "description": "Details of a COS package." + }, + "googetPackage": { + "$ref": "InventoryVersionedPackage", + "description": "Details of a Googet package. For details about the googet package manager, see https://github.com/google/googet." + }, + "qfePackage": { + "$ref": "InventoryWindowsQuickFixEngineeringPackage", + "description": "Details of a Windows Quick Fix engineering package. See https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering for info in Windows Quick Fix Engineering." + }, + "wuaPackage": { + "$ref": "InventoryWindowsUpdatePackage", + "description": "Details of a Windows Update package. See https://docs.microsoft.com/en-us/windows/win32/api/_wua/ for information about Windows Update." + }, + "yumPackage": { + "$ref": "InventoryVersionedPackage", + "description": "Yum package info. For details about the yum package manager, see https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/deployment_guide/ch-yum." + }, + "zypperPackage": { + "$ref": "InventoryVersionedPackage", + "description": "Details of a Zypper package. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual." + }, + "zypperPatch": { + "$ref": "InventoryZypperPatch", + "description": "Details of a Zypper patch. For details about the Zypper package manager, see https://en.opensuse.org/SDB:Zypper_manual." + } + }, + "type": "object" + }, + "InventoryVersionedPackage": { + "description": "Information related to the a standard versioned package. This includes package info for APT, Yum, Zypper, and Googet package managers.", + "id": "InventoryVersionedPackage", + "properties": { + "architecture": { + "description": "The system architecture this package is intended for.", + "type": "string" + }, + "packageName": { + "description": "The name of the package.", + "type": "string" + }, + "version": { + "description": "The version of the package.", + "type": "string" + } + }, + "type": "object" + }, + "InventoryWindowsQuickFixEngineeringPackage": { + "description": "Information related to a Quick Fix Engineering package. Fields are taken from Windows QuickFixEngineering Interface and match the source names: https://docs.microsoft.com/en-us/windows/win32/cimwin32prov/win32-quickfixengineering", + "id": "InventoryWindowsQuickFixEngineeringPackage", + "properties": { + "caption": { + "description": "A short textual description of the QFE update.", + "type": "string" + }, + "description": { + "description": "A textual description of the QFE update.", + "type": "string" + }, + "hotFixId": { + "description": "Unique identifier associated with a particular QFE update.", + "type": "string" + }, + "installTime": { + "description": "Date that the QFE update was installed. Mapped from installed_on field.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "InventoryWindowsUpdatePackage": { + "description": "Details related to a Windows Update package. Field data and names are taken from Windows Update API IUpdate Interface: https://docs.microsoft.com/en-us/windows/win32/api/_wua/ Descriptive fields like title, and description are localized based on the locale of the VM being updated.", + "id": "InventoryWindowsUpdatePackage", + "properties": { + "categories": { + "description": "The categories that are associated with this update package.", + "items": { + "$ref": "InventoryWindowsUpdatePackageWindowsUpdateCategory" + }, + "type": "array" + }, + "description": { + "description": "The localized description of the update package.", + "type": "string" + }, + "kbArticleIds": { + "description": "A collection of Microsoft Knowledge Base article IDs that are associated with the update package.", + "items": { + "type": "string" + }, + "type": "array" + }, + "lastDeploymentChangeTime": { + "description": "The last published date of the update, in (UTC) date and time.", + "format": "google-datetime", + "type": "string" + }, + "moreInfoUrls": { + "description": "A collection of URLs that provide more information about the update package.", + "items": { + "type": "string" + }, + "type": "array" + }, + "revisionNumber": { + "description": "The revision number of this update package.", + "format": "int32", + "type": "integer" + }, + "supportUrl": { + "description": "A hyperlink to the language-specific support information for the update.", + "type": "string" + }, + "title": { + "description": "The localized title of the update package.", + "type": "string" + }, + "updateId": { + "description": "Gets the identifier of an update package. Stays the same across revisions.", + "type": "string" + } + }, + "type": "object" + }, + "InventoryWindowsUpdatePackageWindowsUpdateCategory": { + "description": "Categories specified by the Windows Update.", + "id": "InventoryWindowsUpdatePackageWindowsUpdateCategory", + "properties": { + "id": { + "description": "The identifier of the windows update category.", + "type": "string" + }, + "name": { + "description": "The name of the windows update category.", + "type": "string" + } + }, + "type": "object" + }, + "InventoryZypperPatch": { + "description": "Details related to a Zypper Patch.", + "id": "InventoryZypperPatch", + "properties": { + "category": { + "description": "The category of the patch.", + "type": "string" + }, + "patchName": { + "description": "The name of the patch.", + "type": "string" + }, + "severity": { + "description": "The severity specified for this patch", + "type": "string" + }, + "summary": { + "description": "Any summary information provided about this patch.", + "type": "string" + } + }, + "type": "object" + }, "ListPatchDeploymentsResponse": { "description": "A response message for listing patch deployments.", "id": "ListPatchDeploymentsResponse",
diff --git a/discovery/googleapis/oslogin__v1.json b/discovery/googleapis/oslogin__v1.json index b500215..f99c052 100644 --- a/discovery/googleapis/oslogin__v1.json +++ b/discovery/googleapis/oslogin__v1.json
@@ -298,7 +298,7 @@ } } }, - "revision": "20200925", + "revision": "20210131", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": {
diff --git a/discovery/googleapis/pagespeedonline__v5.json b/discovery/googleapis/pagespeedonline__v5.json index 7ed9c18..c0e2cc0 100644 --- a/discovery/googleapis/pagespeedonline__v5.json +++ b/discovery/googleapis/pagespeedonline__v5.json
@@ -109,7 +109,9 @@ "description": "Runs PageSpeed analysis on the page at the specified URL, and returns PageSpeed scores, a list of suggestions to make that page faster, and other information.", "httpMethod": "GET", "id": "pagespeedonline.pagespeedapi.runpagespeed", - "parameterOrder": [], + "parameterOrder": [ + "url" + ], "parameters": { "captchaToken": { "description": "The captcha token passed when filling out a captcha.", @@ -141,6 +143,7 @@ "locale": { "description": "The locale used to localize formatted results", "location": "query", + "pattern": "[a-zA-Z]+((_|-)[a-zA-Z]+)?", "type": "string" }, "strategy": { @@ -161,6 +164,8 @@ "url": { "description": "Required. The URL to fetch and analyze", "location": "query", + "pattern": "(?i)(url:|origin:)?http(s)?://.*", + "required": true, "type": "string" }, "utm_campaign": { @@ -185,7 +190,7 @@ } } }, - "revision": "20201001", + "revision": "20210119", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { @@ -281,7 +286,11 @@ "type": "string" }, "emulatedFormFactor": { - "description": "The form factor the emulation should use.", + "description": "The form factor the emulation should use. This field is deprecated, form_factor should be used instead.", + "type": "string" + }, + "formFactor": { + "description": "How Lighthouse should interpret this run in regards to scoring performance metrics and skipping mobile-only tests in desktop.", "type": "string" }, "locale": {
diff --git a/discovery/googleapis/people__v1.json b/discovery/googleapis/people__v1.json index dc100f1..7b9fd32 100644 --- a/discovery/googleapis/people__v1.json +++ b/discovery/googleapis/people__v1.json
@@ -18,7 +18,7 @@ "description": "View your street addresses" }, "https://www.googleapis.com/auth/user.birthday.read": { - "description": "View your complete date of birth" + "description": "See and download your exact date of birth" }, "https://www.googleapis.com/auth/user.emails.read": { "description": "View your email addresses" @@ -30,7 +30,7 @@ "description": "See your education, work history and org info" }, "https://www.googleapis.com/auth/user.phonenumbers.read": { - "description": "View your phone numbers" + "description": "See and download your personal phone numbers" }, "https://www.googleapis.com/auth/userinfo.email": { "description": "View your email address" @@ -144,6 +144,12 @@ "id": "people.contactGroups.batchGet", "parameterOrder": [], "parameters": { + "groupFields": { + "description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, "maxMembers": { "description": "Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.", "format": "int32", @@ -220,6 +226,12 @@ "resourceName" ], "parameters": { + "groupFields": { + "description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, "maxMembers": { "description": "Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.", "format": "int32", @@ -249,6 +261,12 @@ "id": "people.contactGroups.list", "parameterOrder": [], "parameters": { + "groupFields": { + "description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.", "format": "int32", @@ -414,7 +432,7 @@ "people": { "methods": { "createContact": { - "description": "Create a new contact and return the person resource for that contact. The request throws a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names", + "description": "Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names", "httpMethod": "POST", "id": "people.people.createContact", "parameterOrder": [], @@ -426,7 +444,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.", "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", @@ -501,7 +519,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.", "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", @@ -528,7 +546,7 @@ ] }, "get": { - "description": "Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified.", + "description": "Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.", "httpMethod": "GET", "id": "people.people.get", "parameterOrder": [ @@ -555,7 +573,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.PROFILE and ReadSourceType.CONTACT if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.", "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", @@ -592,7 +610,7 @@ ] }, "getBatchGet": { - "description": "Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified.", + "description": "Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.", "httpMethod": "GET", "id": "people.people.getBatchGet", "parameterOrder": [], @@ -616,7 +634,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.", "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", @@ -813,7 +831,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.", "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", @@ -880,7 +898,7 @@ "connections": { "methods": { "list": { - "description": "Provides a list of the authenticated user's contacts. The request throws a 400 error if 'personFields' is not specified.", + "description": "Provides a list of the authenticated user's contacts. The request returns a 400 error if `personFields` is not specified. The request returns a 410 error if `sync_token` is specified and is expired. Sync tokens expire after 7 days to prevent data drift between clients and the server. To handle a sync token expired error, a request should be sent without `sync_token` to get all contacts.", "httpMethod": "GET", "id": "people.people.connections.list", "parameterOrder": [ @@ -911,7 +929,7 @@ "type": "string" }, "requestSyncToken": { - "description": "Optional. Whether the response should include `next_sync_token` on the last page, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit.", + "description": "Optional. Whether the response should include `next_sync_token` on the last page, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial full sync requests that specify `request_sync_token` and do not specify `sync_token` have an additional rate limit per user. Each client should generally only be doing a full sync once every few days per user and so should not hit this limit.", "location": "query", "type": "boolean" }, @@ -940,7 +958,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.", "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED", "READ_SOURCE_TYPE_PROFILE", @@ -958,7 +976,7 @@ "type": "string" }, "syncToken": { - "description": "Optional. A sync token, received from a previous `ListConnections` call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify `sync_token` have an additional rate limit. When syncing, all other parameters provided to `ListConnections` must match the call that provided the sync token.", + "description": "Optional. A sync token, received from a previous `ListConnections` call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to `ListConnections` except `page_size` and `page_token` must match the initial call that provided the sync token. Sync tokens expire after seven days, after which a full sync request without a `sync_token` should be made.", "location": "query", "type": "string" } @@ -977,7 +995,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { @@ -1187,6 +1205,13 @@ "description": "A contact group.", "id": "ContactGroup", "properties": { + "clientData": { + "description": "The group's client data.", + "items": { + "$ref": "GroupClientData" + }, + "type": "array" + }, "etag": { "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.", "type": "string" @@ -1218,7 +1243,7 @@ "type": "integer" }, "memberResourceNames": { - "description": "Output only. The list of contact person resource names that are members of the contact group. The field is not populated for LIST requests and can only be updated through the [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).", + "description": "Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as `maxMembers` in the get request.", "items": { "type": "string" }, @@ -1309,7 +1334,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.", "items": { "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED", @@ -1356,26 +1381,31 @@ "contactGroup": { "$ref": "ContactGroup", "description": "Required. The contact group to create." + }, + "readGroupFields": { + "description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * metadata * name", + "format": "google-fieldmask", + "type": "string" } }, "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -1559,6 +1589,21 @@ }, "type": "object" }, + "GroupClientData": { + "description": "Arbitrary client data that is populated by clients. Duplicate keys and values are allowed. LINT.IfChange(GroupClientData)", + "id": "GroupClientData", + "properties": { + "key": { + "description": "The client specified key of the client data.", + "type": "string" + }, + "value": { + "description": "The client specified value of the client data.", + "type": "string" + } + }, + "type": "object" + }, "ImClient": { "description": "A person's instant messaging client.", "id": "ImClient", @@ -1841,14 +1886,14 @@ "id": "ModifyContactGroupMembersRequest", "properties": { "resourceNamesToAdd": { - "description": "Optional. The resource names of the contact people to add in the form of `people/{person_id}`.", + "description": "Optional. The resource names of the contact people to add in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.", "items": { "type": "string" }, "type": "array" }, "resourceNamesToRemove": { - "description": "Optional. The resource names of the contact people to remove in the form of `people/{person_id}`.", + "description": "Optional. The resource names of the contact people to remove in the form of `people/{person_id}`. The total number of resource names in `resource_names_to_add` and `resource_names_to_remove` must be less than or equal to 1000.", "items": { "type": "string" }, @@ -2750,6 +2795,16 @@ "contactGroup": { "$ref": "ContactGroup", "description": "Required. The contact group to update." + }, + "readGroupFields": { + "description": "Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`, `groupType`, and `name` if not set or set to empty. Valid fields are: * clientData * groupType * memberCount * metadata * name", + "format": "google-fieldmask", + "type": "string" + }, + "updateGroupFields": { + "description": "Optional. A field mask to restrict which fields on the group are updated. Multiple fields can be specified by separating them with commas. Defaults to `name` if not set or set to empty. Updated fields are replaced. Valid values are: * clientData * name", + "format": "google-fieldmask", + "type": "string" } }, "type": "object" @@ -2769,7 +2824,7 @@ "type": "string" }, "sources": { - "description": "Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.", + "description": "Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.", "items": { "enum": [ "READ_SOURCE_TYPE_UNSPECIFIED",
diff --git a/discovery/googleapis/playablelocations__v3.json b/discovery/googleapis/playablelocations__v3.json new file mode 100644 index 0000000..364baa9 --- /dev/null +++ b/discovery/googleapis/playablelocations__v3.json
@@ -0,0 +1,523 @@ +{ + "basePath": "", + "baseUrl": "https://playablelocations.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Playable Locations", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/maps/contact-sales/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "playablelocations:v3", + "kind": "discovery#restDescription", + "name": "playablelocations", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "v3": { + "methods": { + "logImpressions": { + "description": "Logs new events when playable locations are displayed, and when they are interacted with. Impressions are not partially saved; either all impressions are saved and this request succeeds, or no impressions are saved, and this request fails.", + "httpMethod": "POST", + "id": "playablelocations.logImpressions", + "parameterOrder": [], + "parameters": {}, + "path": "v3:logImpressions", + "request": { + "$ref": "GoogleMapsPlayablelocationsV3LogImpressionsRequest" + }, + "response": { + "$ref": "GoogleMapsPlayablelocationsV3LogImpressionsResponse" + } + }, + "logPlayerReports": { + "description": "Logs bad playable location reports submitted by players. Reports are not partially saved; either all reports are saved and this request succeeds, or no reports are saved, and this request fails.", + "httpMethod": "POST", + "id": "playablelocations.logPlayerReports", + "parameterOrder": [], + "parameters": {}, + "path": "v3:logPlayerReports", + "request": { + "$ref": "GoogleMapsPlayablelocationsV3LogPlayerReportsRequest" + }, + "response": { + "$ref": "GoogleMapsPlayablelocationsV3LogPlayerReportsResponse" + } + }, + "samplePlayableLocations": { + "description": "Returns a set of playable locations that lie within a specified area, that satisfy optional filter criteria. Note: Identical `SamplePlayableLocations` requests can return different results as the state of the world changes over time.", + "httpMethod": "POST", + "id": "playablelocations.samplePlayableLocations", + "parameterOrder": [], + "parameters": {}, + "path": "v3:samplePlayableLocations", + "request": { + "$ref": "GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest" + }, + "response": { + "$ref": "GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse" + } + } + } + } + }, + "revision": "20210203", + "rootUrl": "https://playablelocations.googleapis.com/", + "schemas": { + "GoogleMapsPlayablelocationsV3Impression": { + "description": "Encapsulates impression event details.", + "id": "GoogleMapsPlayablelocationsV3Impression", + "properties": { + "gameObjectType": { + "description": "An arbitrary, developer-defined type identifier for each type of game object used in your game. Since players interact with differ types of game objects in different ways, this field allows you to segregate impression data by type for analysis. You should assign a unique `game_object_type` ID to represent a distinct type of game object in your game. For example, 1=monster location, 2=powerup location.", + "format": "int32", + "type": "integer" + }, + "impressionType": { + "description": "Required. The type of impression event.", + "enum": [ + "IMPRESSION_TYPE_UNSPECIFIED", + "PRESENTED", + "INTERACTED" + ], + "enumDescriptions": [ + "Unspecified type. Do not use.", + "The playable location was presented to a player.", + "A player interacted with the playable location." + ], + "type": "string" + }, + "locationName": { + "description": "Required. The name of the playable location.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3LogImpressionsRequest": { + "description": "A request for logging impressions.", + "id": "GoogleMapsPlayablelocationsV3LogImpressionsRequest", + "properties": { + "clientInfo": { + "$ref": "GoogleMapsUnityClientInfo", + "description": "Required. Information about the client device. For example, device model and operating system." + }, + "impressions": { + "description": "Required. Impression event details. The maximum number of impression reports that you can log at once is 50.", + "items": { + "$ref": "GoogleMapsPlayablelocationsV3Impression" + }, + "type": "array" + }, + "requestId": { + "description": "Required. A string that uniquely identifies the log impressions request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in case of failure. In this case, the request must be identical to the one that failed.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3LogImpressionsResponse": { + "description": "A response for the LogImpressions method. This method returns no data upon success.", + "id": "GoogleMapsPlayablelocationsV3LogImpressionsResponse", + "properties": {}, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3LogPlayerReportsRequest": { + "description": "A request for logging your player's bad location reports.", + "id": "GoogleMapsPlayablelocationsV3LogPlayerReportsRequest", + "properties": { + "clientInfo": { + "$ref": "GoogleMapsUnityClientInfo", + "description": "Required. Information about the client device (for example, device model and operating system)." + }, + "playerReports": { + "description": "Required. Player reports. The maximum number of player reports that you can log at once is 50.", + "items": { + "$ref": "GoogleMapsPlayablelocationsV3PlayerReport" + }, + "type": "array" + }, + "requestId": { + "description": "Required. A string that uniquely identifies the log player reports request. This allows you to detect duplicate requests. We recommend that you use UUIDs for this value. The value must not exceed 50 characters. You should reuse the `request_id` only when retrying a request in the case of a failure. In that case, the request must be identical to the one that failed.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3LogPlayerReportsResponse": { + "description": "A response for the LogPlayerReports method. This method returns no data upon success.", + "id": "GoogleMapsPlayablelocationsV3LogPlayerReportsResponse", + "properties": {}, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3PlayerReport": { + "description": "A report submitted by a player about a playable location that is considered inappropriate for use in the game.", + "id": "GoogleMapsPlayablelocationsV3PlayerReport", + "properties": { + "languageCode": { + "description": "Language code (in BCP-47 format) indicating the language of the freeform description provided in `reason_details`. Examples are \"en\", \"en-US\" or \"ja-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "type": "string" + }, + "locationName": { + "description": "Required. The name of the playable location.", + "type": "string" + }, + "reasonDetails": { + "description": "Required. A free-form description detailing why the playable location is considered bad.", + "type": "string" + }, + "reasons": { + "description": "Required. One or more reasons why this playable location is considered bad.", + "items": { + "enum": [ + "BAD_LOCATION_REASON_UNSPECIFIED", + "OTHER", + "NOT_PEDESTRIAN_ACCESSIBLE", + "NOT_OPEN_TO_PUBLIC", + "PERMANENTLY_CLOSED", + "TEMPORARILY_INACCESSIBLE" + ], + "enumDescriptions": [ + "Unspecified reason. Do not use.", + "The reason isn't one of the reasons in this enumeration.", + "The playable location isn't accessible to pedestrians. For example, if it's in the middle of a highway.", + "The playable location isn't open to the public. For example, a private office building.", + "The playable location is permanently closed. For example, when a business has been shut down.", + "The playable location is temporarily inaccessible. For example, when a business has closed for renovations." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SampleAreaFilter": { + "description": "Specifies the area to search for playable locations.", + "id": "GoogleMapsPlayablelocationsV3SampleAreaFilter", + "properties": { + "s2CellId": { + "description": "Required. The S2 cell ID of the area you want. This must be between cell level 11 and 14 (inclusive). S2 cells are 64-bit integers that identify areas on the Earth. They are hierarchical, and can therefore be used for spatial indexing. The S2 geometry library is available in a number of languages: * [C++](https://github.com/google/s2geometry) * [Java](https://github.com/google/s2-geometry-library-java) * [Go](https://github.com/golang/geo) * [Python](https://github.com/google/s2geometry/tree/master/src/python)", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SampleCriterion": { + "description": "Encapsulates a filter criterion for searching for a set of playable locations.", + "id": "GoogleMapsPlayablelocationsV3SampleCriterion", + "properties": { + "fieldsToReturn": { + "description": "Specifies which `PlayableLocation` fields are returned. `name` (which is used for logging impressions), `center_point` and `place_id` (or `plus_code`) are always returned. The following fields are omitted unless you specify them here: * snapped_point * types Note: The more fields you include, the more expensive in terms of data and associated latency your query will be.", + "format": "google-fieldmask", + "type": "string" + }, + "filter": { + "$ref": "GoogleMapsPlayablelocationsV3SampleFilter", + "description": "Specifies filtering options, and specifies what will be included in the result set." + }, + "gameObjectType": { + "description": "Required. An arbitrary, developer-defined identifier of the type of game object that the playable location is used for. This field allows you to specify criteria per game object type when searching for playable locations. You should assign a unique `game_object_type` ID across all `request_criteria` to represent a distinct type of game object. For example, 1=monster location, 2=powerup location. The response contains a map.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SampleFilter": { + "description": "Specifies the filters to use when searching for playable locations.", + "id": "GoogleMapsPlayablelocationsV3SampleFilter", + "properties": { + "includedTypes": { + "description": "Restricts the set of playable locations to just the [types](/maps/documentation/gaming/tt/types) that you want.", + "items": { + "type": "string" + }, + "type": "array" + }, + "maxLocationCount": { + "description": "Specifies the maximum number of playable locations to return. This value must not be greater than 1000. The default value is 100. Only the top-ranking playable locations are returned.", + "format": "int32", + "type": "integer" + }, + "spacing": { + "$ref": "GoogleMapsPlayablelocationsV3SampleSpacingOptions", + "description": "A set of options that control the spacing between playable locations. By default the minimum distance between locations is 200m." + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SamplePlayableLocation": { + "description": "A geographical point suitable for placing game objects in location-based games.", + "id": "GoogleMapsPlayablelocationsV3SamplePlayableLocation", + "properties": { + "centerPoint": { + "$ref": "GoogleTypeLatLng", + "description": "Required. The latitude and longitude associated with the center of the playable location. By default, the set of playable locations returned from SamplePlayableLocations use center-point coordinates." + }, + "name": { + "description": "Required. The name of this playable location.", + "type": "string" + }, + "placeId": { + "description": "A [place ID] (https://developers.google.com/places/place-id)", + "type": "string" + }, + "plusCode": { + "description": "A [plus code] (http://openlocationcode.com)", + "type": "string" + }, + "snappedPoint": { + "$ref": "GoogleTypeLatLng", + "description": "The playable location's coordinates, snapped to the sidewalk of the nearest road, if a nearby road exists." + }, + "types": { + "description": "A collection of [Playable Location Types](/maps/documentation/gaming/tt/types) for this playable location. The first type in the collection is the primary type. Type information might not be available for all playable locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SamplePlayableLocationList": { + "description": "A list of PlayableLocation objects that satisfies a single Criterion.", + "id": "GoogleMapsPlayablelocationsV3SamplePlayableLocationList", + "properties": { + "locations": { + "description": "A list of playable locations for this game object type.", + "items": { + "$ref": "GoogleMapsPlayablelocationsV3SamplePlayableLocation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest": { + "description": " Life of a query: - When a game starts in a new location, your game server issues a SamplePlayableLocations request. The request specifies the S2 cell, and contains one or more \"criteria\" for filtering: - Criterion 0: i locations for long-lived bases, or level 0 monsters, or... - Criterion 1: j locations for short-lived bases, or level 1 monsters, ... - Criterion 2: k locations for random objects. - etc (up to 5 criterion may be specified). `PlayableLocationList` will then contain mutually exclusive lists of `PlayableLocation` objects that satisfy each of the criteria. Think of it as a collection of real-world locations that you can then associate with your game state. Note: These points are impermanent in nature. E.g, parks can close, and places can be removed. The response specifies how long you can expect the playable locations to last. Once they expire, you should query the `samplePlayableLocations` API again to get a fresh view of the real world.", + "id": "GoogleMapsPlayablelocationsV3SamplePlayableLocationsRequest", + "properties": { + "areaFilter": { + "$ref": "GoogleMapsPlayablelocationsV3SampleAreaFilter", + "description": "Required. Specifies the area to search within for playable locations." + }, + "criteria": { + "description": "Required. Specifies one or more (up to 5) criteria for filtering the returned playable locations.", + "items": { + "$ref": "GoogleMapsPlayablelocationsV3SampleCriterion" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse": { + "description": " Response for the SamplePlayableLocations method.", + "id": "GoogleMapsPlayablelocationsV3SamplePlayableLocationsResponse", + "properties": { + "locationsPerGameObjectType": { + "additionalProperties": { + "$ref": "GoogleMapsPlayablelocationsV3SamplePlayableLocationList" + }, + "description": "Each PlayableLocation object corresponds to a game_object_type specified in the request.", + "type": "object" + }, + "ttl": { + "description": "Required. Specifies the \"time-to-live\" for the set of playable locations. You can use this value to determine how long to cache the set of playable locations. After this length of time, your back-end game server should issue a new SamplePlayableLocations request to get a fresh set of playable locations (because for example, they might have been removed, a park might have closed for the day, a business might have closed permanently).", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlayablelocationsV3SampleSpacingOptions": { + "description": "A set of options that specifies the separation between playable locations.", + "id": "GoogleMapsPlayablelocationsV3SampleSpacingOptions", + "properties": { + "minSpacingMeters": { + "description": "Required. The minimum spacing between any two playable locations, measured in meters. The minimum value is 30. The maximum value is 1000. Inputs will be rounded up to the next 10 meter interval. The default value is 200m. Set this field to remove tight clusters of playable locations. Note: The spacing is a greedy algorithm. It optimizes for selecting the highest ranking locations first, not to maximize the number of locations selected. Consider the following scenario: * Rank: A: 2, B: 1, C: 3. * Distance: A--200m--B--200m--C If spacing=250, it will pick the highest ranked location [B], not [A, C]. Note: Spacing works within the game object type itself, as well as the previous ones. Suppose three game object types, each with the following spacing: * X: 400m, Y: undefined, Z: 200m. 1. Add locations for X, within 400m of each other. 2. Add locations for Y, without any spacing. 3. Finally, add locations for Z within 200m of each other as well X and Y. The distance diagram between those locations end up as: * From->To. * X->X: 400m * Y->X, Y->Y: unspecified. * Z->X, Z->Y, Z->Z: 200m.", + "format": "double", + "type": "number" + }, + "pointType": { + "description": "Specifies whether the minimum spacing constraint applies to the center-point or to the snapped point of playable locations. The default value is `CENTER_POINT`. If a snapped point is not available for a playable location, its center-point is used instead. Set this to the point type used in your game.", + "enum": [ + "POINT_TYPE_UNSPECIFIED", + "CENTER_POINT", + "SNAPPED_POINT" + ], + "enumDescriptions": [ + "Unspecified point type. Do not use this value.", + "The geographic coordinates correspond to the center of the location.", + "The geographic coordinates correspond to the location snapped to the sidewalk of the nearest road (when a nearby road exists)." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsUnityClientInfo": { + "description": "Client information.", + "id": "GoogleMapsUnityClientInfo", + "properties": { + "apiClient": { + "description": "API client name and version. For example, the SDK calling the API. The exact format is up to the client.", + "type": "string" + }, + "applicationId": { + "description": "Application ID, such as the package name on Android and the bundle identifier on iOS platforms.", + "type": "string" + }, + "applicationVersion": { + "description": "Application version number, such as \"1.2.3\". The exact format is application-dependent.", + "type": "string" + }, + "deviceModel": { + "description": "Device model as reported by the device. The exact format is platform-dependent.", + "type": "string" + }, + "languageCode": { + "description": "Language code (in BCP-47 format) indicating the UI language of the client. Examples are \"en\", \"en-US\" or \"ja-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "type": "string" + }, + "operatingSystem": { + "description": "Operating system name and version as reported by the OS. For example, \"Mac OS X 10.10.4\". The exact format is platform-dependent.", + "type": "string" + }, + "operatingSystemBuild": { + "description": "Build number/version of the operating system. e.g., the contents of android.os.Build.ID in Android, or the contents of sysctl \"kern.osversion\" in iOS.", + "type": "string" + }, + "platform": { + "description": "Platform where the application is running.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "EDITOR", + "MAC_OS", + "WINDOWS", + "LINUX", + "ANDROID", + "IOS", + "WEB_GL" + ], + "enumDescriptions": [ + "Unspecified or unknown OS.", + "Development environment.", + "macOS.", + "Windows.", + "Linux", + "Android", + "iOS", + "WebGL." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleTypeLatLng": { + "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", + "id": "GoogleTypeLatLng", + "properties": { + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "format": "double", + "type": "number" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Playable Locations API", + "version": "v3", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/playcustomapp__v1.json b/discovery/googleapis/playcustomapp__v1.json index d889f0b..5e520cd 100644 --- a/discovery/googleapis/playcustomapp__v1.json +++ b/discovery/googleapis/playcustomapp__v1.json
@@ -116,6 +116,10 @@ ], "maxSize": "10737418240", "protocols": { + "resumable": { + "multipart": true, + "path": "/resumable/upload/playcustomapp/v1/accounts/{account}/customApps" + }, "simple": { "multipart": true, "path": "/upload/playcustomapp/v1/accounts/{account}/customApps" @@ -151,7 +155,7 @@ } } }, - "revision": "20201007", + "revision": "20210203", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": {
diff --git a/discovery/googleapis/policytroubleshooter__v1.json b/discovery/googleapis/policytroubleshooter__v1.json index 777d9ec..df4b99d 100644 --- a/discovery/googleapis/policytroubleshooter__v1.json +++ b/discovery/googleapis/policytroubleshooter__v1.json
@@ -125,7 +125,7 @@ } } }, - "revision": "20201003", + "revision": "20210201", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1AccessTuple": {
diff --git a/discovery/googleapis/poly__v1.json b/discovery/googleapis/poly__v1.json index b389e51..04e0d27 100644 --- a/discovery/googleapis/poly__v1.json +++ b/discovery/googleapis/poly__v1.json
@@ -3,7 +3,7 @@ "baseUrl": "https://poly.googleapis.com/", "batchPath": "batch", "canonicalName": "Poly Service", - "description": "The Poly API provides read access to assets hosted on <a href=\"https://poly.google.com\">poly.google.com</a> to all, and upload access to <a href=\"https://poly.google.com\">poly.google.com</a> for whitelisted accounts.\n", + "description": "The Poly API provides read access to assets hosted on poly.google.com to all, and upload access to poly.google.com for whitelisted accounts. ", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/poly/", "icons": { @@ -97,7 +97,7 @@ "assets": { "methods": { "get": { - "description": "Returns detailed information about an asset given its name.\nPRIVATE assets are returned only if\n the currently authenticated user (via OAuth token) is the author of the\n asset.", + "description": "Returns detailed information about an asset given its name. PRIVATE assets are returned only if the currently authenticated user (via OAuth token) is the author of the asset.", "httpMethod": "GET", "id": "poly.assets.get", "parameterOrder": [ @@ -118,13 +118,13 @@ } }, "list": { - "description": "Lists all public, remixable assets. These are assets with an access level\nof PUBLIC and published under the\nCC-By license.", + "description": "Lists all public, remixable assets. These are assets with an access level of PUBLIC and published under the CC-By license.", "httpMethod": "GET", "id": "poly.assets.list", "parameterOrder": [], "parameters": { "category": { - "description": "Filter assets based on the specified category. Supported values are:\n`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`,\n`scenes`, `technology`, and `transport`.", + "description": "Filter assets based on the specified category. Supported values are: `animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`, `technology`, and `transport`.", "location": "query", "type": "string" }, @@ -134,39 +134,45 @@ "type": "boolean" }, "format": { - "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.", + "description": "Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.", "location": "query", "type": "string" }, "keywords": { - "description": "One or more search terms to be matched against all text that Poly has\nindexed for assets, which includes display_name,\ndescription, and tags. Multiple keywords should be\nseparated by spaces.", + "description": "One or more search terms to be matched against all text that Poly has indexed for assets, which includes display_name, description, and tags. Multiple keywords should be separated by spaces.", "location": "query", "type": "string" }, "maxComplexity": { - "description": "Returns assets that are of the specified complexity or less. Defaults to\nCOMPLEX. For example, a request for\nMEDIUM assets also includes\nSIMPLE assets.", + "description": "Returns assets that are of the specified complexity or less. Defaults to COMPLEX. For example, a request for MEDIUM assets also includes SIMPLE assets.", "enum": [ "COMPLEXITY_UNSPECIFIED", "COMPLEX", "MEDIUM", "SIMPLE" ], + "enumDescriptions": [ + "No complexity specified. This is equivalent to omitting the filter.", + "Highly-complex.", + "Averagely-complex.", + "Simple." + ], "location": "query", "type": "string" }, "orderBy": { - "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.", + "description": "Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.", + "description": "The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\nnext_page_token.", + "description": "Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.", "location": "query", "type": "string" } @@ -183,7 +189,7 @@ "assets": { "methods": { "list": { - "description": "Lists assets authored by the given user. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of PRIVATE or\nUNLISTED and assets which are\nAll Rights Reserved for the\ncurrently-authenticated user.", + "description": "Lists assets authored by the given user. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of PRIVATE or UNLISTED and assets which are All Rights Reserved for the currently-authenticated user.", "httpMethod": "GET", "id": "poly.users.assets.list", "parameterOrder": [ @@ -191,40 +197,45 @@ ], "parameters": { "format": { - "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.", + "description": "Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.", "location": "query", "type": "string" }, "name": { - "description": "A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.", + "description": "A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.", "location": "path", "pattern": "^users/[^/]+$", "required": true, "type": "string" }, "orderBy": { - "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.", + "description": "Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets based on a combination of popularity and other features.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.", + "description": "The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\nnext_page_token.", + "description": "Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.", "location": "query", "type": "string" }, "visibility": { - "description": "The visibility of the assets to be returned.\nDefaults to\nVISIBILITY_UNSPECIFIED\nwhich returns all assets.", + "description": "The visibility of the assets to be returned. Defaults to VISIBILITY_UNSPECIFIED which returns all assets.", "enum": [ "VISIBILITY_UNSPECIFIED", "PUBLISHED", "PRIVATE" ], + "enumDescriptions": [ + "No visibility specified. Returns all assets.", + "Returns only published assets.", + "Returns only private assets." + ], "location": "query", "type": "string" } @@ -239,7 +250,7 @@ "likedassets": { "methods": { "list": { - "description": "Lists assets that the user has liked. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of UNLISTED.", + "description": "Lists assets that the user has liked. Only the value 'me', representing the currently-authenticated user, is supported. May include assets with an access level of UNLISTED.", "httpMethod": "GET", "id": "poly.users.likedassets.list", "parameterOrder": [ @@ -247,30 +258,30 @@ ], "parameters": { "format": { - "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.", + "description": "Return only assets with the matching format. Acceptable values are: `BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.", "location": "query", "type": "string" }, "name": { - "description": "A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.", + "description": "A valid user id. Currently, only the special value 'me', representing the currently-authenticated user is supported. To use 'me', you must pass an OAuth token with the request.", "location": "path", "pattern": "^users/[^/]+$", "required": true, "type": "string" }, "orderBy": { - "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which\nranks assets based on how recently they were liked.", + "description": "Specifies an ordering for assets. Acceptable values are: `BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which ranks assets based on how recently they were liked.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.", + "description": "The maximum number of assets to be returned. This value must be between `1` and `100`. Defaults to `20`.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from\nnext_page_token.", + "description": "Specifies a continuation token from a previous search whose results were split into multiple pages. To get the next page, submit the same request specifying the value from next_page_token.", "location": "query", "type": "string" } @@ -285,19 +296,19 @@ } } }, - "revision": "20200527", + "revision": "20201208", "rootUrl": "https://poly.googleapis.com/", "schemas": { "Asset": { - "description": "Represents and describes an asset in the Poly library. An asset is a 3D model\nor scene created using [Tilt Brush](//www.tiltbrush.com),\n[Blocks](//vr.google.com/blocks/), or any 3D program that produces a file\nthat can be upload to Poly.", + "description": "Represents and describes an asset in the Poly library. An asset is a 3D model or scene created using [Tilt Brush](//www.tiltbrush.com), [Blocks](//vr.google.com/blocks/), or any 3D program that produces a file that can be upload to Poly.", "id": "Asset", "properties": { "authorName": { - "description": "The author's publicly visible name. Use this name when giving credit to the\nauthor. For more information, see [Licensing](/poly/discover/licensing).", + "description": "The author's publicly visible name. Use this name when giving credit to the author. For more information, see [Licensing](/poly/discover/licensing).", "type": "string" }, "createTime": { - "description": "For published assets, the time when the asset was published.\nFor unpublished assets, the time when the asset was created.", + "description": "For published assets, the time when the asset was published. For unpublished assets, the time when the asset was created.", "format": "google-datetime", "type": "string" }, @@ -310,7 +321,7 @@ "type": "string" }, "formats": { - "description": "A list of Formats where each\nformat describes one representation of the asset.", + "description": "A list of Formats where each format describes one representation of the asset.", "items": { "$ref": "Format" }, @@ -321,7 +332,7 @@ "type": "boolean" }, "license": { - "description": "The license under which the author has made the asset available\nfor use, if any.", + "description": "The license under which the author has made the asset available for use, if any.", "enum": [ "UNKNOWN", "CREATIVE_COMMONS_BY", @@ -330,21 +341,21 @@ "enumDescriptions": [ "Unknown license value.", "Creative Commons CC-BY 3.0. https://creativecommons.org/licenses/by/3.0/", - "Unlicensed: All Rights Reserved by the author. Unlicensed assets are\n**not** returned by List Assets." + "Unlicensed: All Rights Reserved by the author. Unlicensed assets are **not** returned by List Assets." ], "type": "string" }, "metadata": { - "description": "Application-defined opaque metadata for this asset. This field is only\nreturned when querying for the signed-in user's own assets, not for public\nassets. This string is limited to 1K chars. It is up to the creator of\nthe asset to define the format for this string (for example, JSON).", + "description": "Application-defined opaque metadata for this asset. This field is only returned when querying for the signed-in user's own assets, not for public assets. This string is limited to 1K chars. It is up to the creator of the asset to define the format for this string (for example, JSON).", "type": "string" }, "name": { - "description": "The unique identifier for the asset in the form:\n`assets/{ASSET_ID}`.", + "description": "The unique identifier for the asset in the form: `assets/{ASSET_ID}`.", "type": "string" }, "presentationParams": { "$ref": "PresentationParams", - "description": "Hints for displaying the asset. Note that these parameters are not\nimmutable; the author of an asset may change them post-publication." + "description": "Hints for displaying the asset. Note that these parameters are not immutable; the author of an asset may change them post-publication." }, "remixInfo": { "$ref": "RemixInfo", @@ -355,7 +366,7 @@ "description": "The thumbnail image for the asset." }, "updateTime": { - "description": "The time when the asset was last modified. For published assets, whose\ncontents are immutable, the update time changes only when metadata\nproperties, such as visibility, are updated.", + "description": "The time when the asset was last modified. For published assets, whose contents are immutable, the update time changes only when metadata properties, such as visibility, are updated.", "format": "google-datetime", "type": "string" }, @@ -369,9 +380,9 @@ ], "enumDescriptions": [ "Unknown (and invalid) visibility.", - "Access to the asset and its underlying files and resources is restricted to\nthe author.\n**Authentication:** You must supply an OAuth token that corresponds to the\nauthor's account.", - "Access to the asset and its underlying files and resources is available to\nanyone with the asset's name. Unlisted assets are **not**\nreturned by List Assets.", - "Access to the asset and its underlying files and resources is available\nto anyone." + "Access to the asset and its underlying files and resources is restricted to the author. **Authentication:** You must supply an OAuth token that corresponds to the author's account.", + "Access to the asset and its underlying files and resources is available to anyone with the asset's name. Unlisted assets are **not** returned by List Assets.", + "Access to the asset and its underlying files and resources is available to anyone." ], "type": "string" } @@ -398,15 +409,15 @@ ], "enumDescriptions": [ "Unknown error code.", - "The asset import did not include any file that we can import (i.e. an OBJ\nfile).", + "The asset import did not include any file that we can import (i.e. an OBJ file).", "When generating the preview for the import, no geometry was found.", - "A problem was encountered while parsing the OBJ file. The converter makes\na 'best effort' attempt to continue when encountering such issues. In\nsome cases the resulting preview model may still be acceptable. The\ndetails can be found in the parse error message.", + "A problem was encountered while parsing the OBJ file. The converter makes a 'best effort' attempt to continue when encountering such issues. In some cases the resulting preview model may still be acceptable. The details can be found in the parse error message.", "The importer was not able to import the model before the expiration time.", "The importer encountered a problem reading an image file.", - "Multiple files were encountered in addition to a ZIP archive. When\nuploading an archive only one file is permitted.", - "Default materials are used in the model. This means that one or more\nfaces is using default materials either because no usemtl statement was\nspecified or because the requested material was not found due to a\nmissing material file or bad material name. This does not cover the case\nof missing textures.", - "The importer encountered a fatal error and was unable to import the\nmodel.", - "The import includes a file of an unsupported element type. The file path\nis specified." + "Multiple files were encountered in addition to a ZIP archive. When uploading an archive only one file is permitted.", + "Default materials are used in the model. This means that one or more faces is using default materials either because no usemtl statement was specified or because the requested material was not found due to a missing material file or bad material name. This does not cover the case of missing textures.", + "The importer encountered a fatal error and was unable to import the model.", + "The import includes a file of an unsupported element type. The file path is specified." ], "type": "string" }, @@ -426,15 +437,15 @@ "type": "object" }, "File": { - "description": "Represents a file in Poly, which can be a root,\nresource, or thumbnail file.", + "description": "Represents a file in Poly, which can be a root, resource, or thumbnail file.", "id": "File", "properties": { "contentType": { - "description": "The MIME content-type, such as `image/png`.\nFor more information, see\n[MIME\ntypes](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).", + "description": "The MIME content-type, such as `image/png`. For more information, see [MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).", "type": "string" }, "relativePath": { - "description": "The path of the resource file relative to the\nroot file. For root or thumbnail files,\nthis is just the filename.", + "description": "The path of the resource file relative to the root file. For root or thumbnail files, this is just the filename.", "type": "string" }, "url": { @@ -445,7 +456,7 @@ "type": "object" }, "Format": { - "description": "The same asset can be represented in different formats, for example,\na [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its\ncorresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file\nwith its corresponding .glb binary data. A format refers to a specific\nrepresentation of an asset and contains all information needed to\nretrieve and describe this representation.", + "description": "The same asset can be represented in different formats, for example, a [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its corresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file with its corresponding .glb binary data. A format refers to a specific representation of an asset and contains all information needed to retrieve and describe this representation.", "id": "Format", "properties": { "formatComplexity": { @@ -453,11 +464,11 @@ "description": "Complexity stats about this representation of the asset." }, "formatType": { - "description": "A short string that identifies the format type of this representation.\nPossible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.", + "description": "A short string that identifies the format type of this representation. Possible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.", "type": "string" }, "resources": { - "description": "A list of dependencies of the root element. May include, but is not\nlimited to, materials, textures, and shader programs.", + "description": "A list of dependencies of the root element. May include, but is not limited to, materials, textures, and shader programs.", "items": { "$ref": "File" }, @@ -465,7 +476,7 @@ }, "root": { "$ref": "File", - "description": "The root of the file hierarchy. This will always be populated.\nFor some format_types - such as `TILT`, which are\nself-contained - this is all of the data.\n\nOther types - such as `OBJ` - often reference other data elements.\nThese are contained in the resources field." + "description": "The root of the file hierarchy. This will always be populated. For some format_types - such as `TILT`, which are self-contained - this is all of the data. Other types - such as `OBJ` - often reference other data elements. These are contained in the resources field." } }, "type": "object" @@ -475,7 +486,7 @@ "id": "FormatComplexity", "properties": { "lodHint": { - "description": "A non-negative integer that represents the level of detail (LOD) of this\nformat relative to other formats of the same asset with the same\nformat_type.\nThis hint allows you to sort formats from the most-detailed (0) to\nleast-detailed (integers greater than 0).", + "description": "A non-negative integer that represents the level of detail (LOD) of this format relative to other formats of the same asset with the same format_type. This hint allows you to sort formats from the most-detailed (0) to least-detailed (integers greater than 0).", "format": "int32", "type": "integer" }, @@ -526,7 +537,7 @@ "type": "array" }, "nextPageToken": { - "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.", + "description": "The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token.", "type": "string" }, "totalSize": { @@ -549,7 +560,7 @@ "type": "array" }, "nextPageToken": { - "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.", + "description": "The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token.", "type": "string" }, "totalSize": { @@ -565,7 +576,7 @@ "id": "ListUserAssetsResponse", "properties": { "nextPageToken": { - "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.", + "description": "The continuation token for retrieving the next page. If empty, indicates that there are no more pages. To get the next page, submit the same request specifying this value as the page_token.", "type": "string" }, "totalSize": { @@ -619,7 +630,7 @@ ], "enumDescriptions": [ "Unknown error code.", - "Vertex references are specified in an inconsistent style for a face (e.g.\nsome vertices specify texture vertices but some don't).", + "Vertex references are specified in an inconsistent style for a face (e.g. some vertices specify texture vertices but some don't).", "The command is invalid.", "A invalid number was specified.", "An invalid vertex reference was specified.", @@ -628,16 +639,16 @@ "The vertex specified too few dimensions for its usage.", "The face specified too few vertices.", "The vertex specified too many dimensions for its usage.", - "This command is a valid OBJ command but is not supported. This error is\nonly generated for the first instance of such a command.", + "This command is a valid OBJ command but is not supported. This error is only generated for the first instance of such a command.", "This line ended with unparsed token characters.", "The specified vertex was not found.", "The specified number was too large or small for its usage.", "The specified parameter value was not recognized.", "The specified texture option is not valid.", - "The maximum number of problems to report was reached. Parsing continues,\nbut further problems will be ignored.", + "The maximum number of problems to report was reached. Parsing continues, but further problems will be ignored.", "An expected file name was not specified.", "The specified file was not found in the import.", - "The specified material was not found in any material definition in the\nimport.", + "The specified material was not found in any material definition in the import.", "Material parameters were specified before the first material definition.", "The smoothing group is not valid.", "Vertex colors were specified for only some vertices of a face.", @@ -657,7 +668,7 @@ "type": "string" }, "line": { - "description": "The text of the line. Note that this may be truncated if the line was very\nlong. This may not include the error if it occurs after line truncation.", + "description": "The text of the line. Note that this may be truncated if the line was very long. This may not include the error if it occurs after line truncation.", "type": "string" }, "lineNumber": { @@ -674,15 +685,15 @@ "type": "object" }, "PresentationParams": { - "description": "Hints for displaying the asset, based on information available when the asset\nwas uploaded.", + "description": "Hints for displaying the asset, based on information available when the asset was uploaded.", "id": "PresentationParams", "properties": { "backgroundColor": { - "description": "A background color which could be used for displaying the 3D asset in a\n'thumbnail' or 'palette' style view. Authors have the option to set this\nbackground color when publishing or editing their asset.\n\nThis is represented as a six-digit hexademical triplet specifying the\nRGB components of the background color, e.g. #FF0000 for Red.", + "description": "A background color which could be used for displaying the 3D asset in a 'thumbnail' or 'palette' style view. Authors have the option to set this background color when publishing or editing their asset. This is represented as a six-digit hexademical triplet specifying the RGB components of the background color, e.g. #FF0000 for Red.", "type": "string" }, "colorSpace": { - "description": "The materials' diffuse/albedo color. This does not apply to vertex colors\nor texture maps.", + "description": "The materials' diffuse/albedo color. This does not apply to vertex colors or texture maps.", "enum": [ "UNKNOWN", "LINEAR", @@ -697,13 +708,13 @@ }, "orientingRotation": { "$ref": "Quaternion", - "description": "A rotation that should be applied to the object root to make it upright.\nMore precisely, this quaternion transforms from \"object space\" (the space\nin which the object is defined) to \"presentation space\", a coordinate\nsystem where +Y is up, +X is right, -Z is forward. For example, if\nthe object is the Eiffel Tower, in its local coordinate system the\nobject might be laid out such that the base of the tower is on the\nYZ plane and the tip of the tower is towards positive X. In this case\nthis quaternion would specify a rotation (of 90 degrees about the Z\naxis) such that in the presentation space the base of the tower is\naligned with the XZ plane, and the tip of the tower lies towards +Y.\n\nThis rotation is unrelated to the object's pose in the web preview,\nwhich is just a camera position setting and is *not* reflected in this\nrotation.\n\nPlease note: this is applicable only to the gLTF." + "description": "A rotation that should be applied to the object root to make it upright. More precisely, this quaternion transforms from \"object space\" (the space in which the object is defined) to \"presentation space\", a coordinate system where +Y is up, +X is right, -Z is forward. For example, if the object is the Eiffel Tower, in its local coordinate system the object might be laid out such that the base of the tower is on the YZ plane and the tip of the tower is towards positive X. In this case this quaternion would specify a rotation (of 90 degrees about the Z axis) such that in the presentation space the base of the tower is aligned with the XZ plane, and the tip of the tower lies towards +Y. This rotation is unrelated to the object's pose in the web preview, which is just a camera position setting and is *not* reflected in this rotation. Please note: this is applicable only to the gLTF." } }, "type": "object" }, "Quaternion": { - "description": "A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the\nresponse you see \"w: 1\" and nothing else this is the default value of\n[0, 0, 0, 1] where x,y, and z are 0.", + "description": "A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the response you see \"w: 1\" and nothing else this is the default value of [0, 0, 0, 1] where x,y, and z are 0.", "id": "Quaternion", "properties": { "w": { @@ -730,11 +741,11 @@ "type": "object" }, "RemixInfo": { - "description": "Info about the sources of this asset (i.e. assets that were remixed to\ncreate this asset).", + "description": "Info about the sources of this asset (i.e. assets that were remixed to create this asset).", "id": "RemixInfo", "properties": { "sourceAsset": { - "description": "Resource ids for the sources of this remix, of the form:\n`assets/{ASSET_ID}`", + "description": "Resource ids for the sources of this remix, of the form: `assets/{ASSET_ID}`", "items": { "type": "string" }, @@ -744,11 +755,11 @@ "type": "object" }, "StartAssetImportResponse": { - "description": "A response message from a request to\nstartImport. This is returned in the response\nfield of the Operation.", + "description": "A response message from a request to startImport. This is returned in the response field of the Operation.", "id": "StartAssetImportResponse", "properties": { "assetId": { - "description": "The id of newly created asset. If this is empty when the operation is\ncomplete it means the import failed. Please refer to the\nassetImportMessages field to understand what went wrong.", + "description": "The id of newly created asset. If this is empty when the operation is complete it means the import failed. Please refer to the assetImportMessages field to understand what went wrong.", "type": "string" }, "assetImportId": { @@ -756,7 +767,7 @@ "type": "string" }, "assetImportMessages": { - "description": "The message from the asset import. This will contain any warnings\n(or - in the case of failure - errors) that occurred during import.", + "description": "The message from the asset import. This will contain any warnings (or - in the case of failure - errors) that occurred during import.", "items": { "$ref": "AssetImportMessage" },
diff --git a/discovery/googleapis/pubsub__v1.json b/discovery/googleapis/pubsub__v1.json index e223301..a33a5f9 100644 --- a/discovery/googleapis/pubsub__v1.json +++ b/discovery/googleapis/pubsub__v1.json
@@ -654,7 +654,7 @@ ] }, "seek": { - "description": "Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.", + "description": "Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.", "httpMethod": "POST", "id": "pubsub.projects.subscriptions.seek", "parameterOrder": [ @@ -742,7 +742,7 @@ "topics": { "methods": { "create": { - "description": "Creates the given topic with the given name. See the [resource name rules]( https://cloud.google.com/pubsub/docs/admin#resource_names).", + "description": "Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).", "httpMethod": "PUT", "id": "pubsub.projects.topics.create", "parameterOrder": [ @@ -1085,7 +1085,7 @@ } } }, - "revision": "20200929", + "revision": "20210125", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1106,10 +1106,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -1705,6 +1701,10 @@ "name": { "description": "Required. The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", "type": "string" + }, + "satisfiesPzs": { + "description": "Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.", + "type": "boolean" } }, "type": "object"
diff --git a/discovery/googleapis/pubsublite__v1.json b/discovery/googleapis/pubsublite__v1.json new file mode 100644 index 0000000..def3c59 --- /dev/null +++ b/discovery/googleapis/pubsublite__v1.json
@@ -0,0 +1,873 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://pubsublite.googleapis.com/", + "batchPath": "batch", + "canonicalName": "PubsubLite", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/pubsub/lite/docs", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "pubsublite:v1", + "kind": "discovery#restDescription", + "name": "pubsublite", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "admin": { + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "subscriptions": { + "methods": { + "create": { + "description": "Creates a new subscription.", + "httpMethod": "POST", + "id": "pubsublite.admin.projects.locations.subscriptions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "subscriptionId": { + "description": "Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/admin/{+parent}/subscriptions", + "request": { + "$ref": "Subscription" + }, + "response": { + "$ref": "Subscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified subscription.", + "httpMethod": "DELETE", + "id": "pubsublite.admin.projects.locations.subscriptions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subscription to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/admin/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the subscription configuration.", + "httpMethod": "GET", + "id": "pubsublite.admin.projects.locations.subscriptions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the subscription whose configuration to return.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/admin/{+name}", + "response": { + "$ref": "Subscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of subscriptions for the given project.", + "httpMethod": "GET", + "id": "pubsublite.admin.projects.locations.subscriptions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/admin/{+parent}/subscriptions", + "response": { + "$ref": "ListSubscriptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates properties of the specified subscription.", + "httpMethod": "PATCH", + "id": "pubsublite.admin.projects.locations.subscriptions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. A mask specifying the subscription fields to change.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/admin/{+name}", + "request": { + "$ref": "Subscription" + }, + "response": { + "$ref": "Subscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "topics": { + "methods": { + "create": { + "description": "Creates a new topic.", + "httpMethod": "POST", + "id": "pubsublite.admin.projects.locations.topics.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "topicId": { + "description": "Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/admin/{+parent}/topics", + "request": { + "$ref": "Topic" + }, + "response": { + "$ref": "Topic" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified topic.", + "httpMethod": "DELETE", + "id": "pubsublite.admin.projects.locations.topics.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the topic to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/admin/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the topic configuration.", + "httpMethod": "GET", + "id": "pubsublite.admin.projects.locations.topics.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the topic whose configuration to return.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/admin/{+name}", + "response": { + "$ref": "Topic" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getPartitions": { + "description": "Returns the partition information for the requested topic.", + "httpMethod": "GET", + "id": "pubsublite.admin.projects.locations.topics.getPartitions", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The topic whose partition information to return.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/admin/{+name}/partitions", + "response": { + "$ref": "TopicPartitions" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of topics for the given project.", + "httpMethod": "GET", + "id": "pubsublite.admin.projects.locations.topics.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent whose topics are to be listed. Structured like `projects/{project_number}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/admin/{+parent}/topics", + "response": { + "$ref": "ListTopicsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates properties of the specified topic.", + "httpMethod": "PATCH", + "id": "pubsublite.admin.projects.locations.topics.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. A mask specifying the topic fields to change.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/admin/{+name}", + "request": { + "$ref": "Topic" + }, + "response": { + "$ref": "Topic" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "subscriptions": { + "methods": { + "list": { + "description": "Lists the subscriptions attached to the specified topic.", + "httpMethod": "GET", + "id": "pubsublite.admin.projects.locations.topics.subscriptions.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the topic whose subscriptions to list.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopicSubscriptions` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/admin/{+name}/subscriptions", + "response": { + "$ref": "ListTopicSubscriptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + } + }, + "cursor": { + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "subscriptions": { + "resources": { + "cursors": { + "methods": { + "list": { + "description": "Returns all committed cursor information for a subscription.", + "httpMethod": "GET", + "id": "pubsublite.cursor.projects.locations.subscriptions.cursors.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListPartitionCursors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitionCursors` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/subscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/cursor/{+parent}/cursors", + "response": { + "$ref": "ListPartitionCursorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + } + }, + "topicStats": { + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "topics": { + "methods": { + "computeMessageStats": { + "description": "Compute statistics about a range of messages in a given topic and partition.", + "httpMethod": "POST", + "id": "pubsublite.topicStats.projects.locations.topics.computeMessageStats", + "parameterOrder": [ + "topic" + ], + "parameters": { + "topic": { + "description": "Required. The topic for which we should compute message stats.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/topics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/topicStats/{+topic}:computeMessageStats", + "request": { + "$ref": "ComputeMessageStatsRequest" + }, + "response": { + "$ref": "ComputeMessageStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20210126", + "rootUrl": "https://pubsublite.googleapis.com/", + "schemas": { + "Capacity": { + "description": "The throughput capacity configuration for each partition.", + "id": "Capacity", + "properties": { + "publishMibPerSec": { + "description": "Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16.", + "format": "int32", + "type": "integer" + }, + "subscribeMibPerSec": { + "description": "Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ComputeMessageStatsRequest": { + "description": "Compute statistics about a range of messages in a given topic and partition.", + "id": "ComputeMessageStatsRequest", + "properties": { + "endCursor": { + "$ref": "Cursor", + "description": "The exclusive end of the range. The range is empty if end_cursor <= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will retrieve all messages." + }, + "partition": { + "description": "Required. The partition for which we should compute message stats.", + "format": "int64", + "type": "string" + }, + "startCursor": { + "$ref": "Cursor", + "description": "The inclusive start of the range." + } + }, + "type": "object" + }, + "ComputeMessageStatsResponse": { + "description": "Response containing stats for messages in the requested topic and partition.", + "id": "ComputeMessageStatsResponse", + "properties": { + "messageBytes": { + "description": "The number of quota bytes accounted to these messages.", + "format": "int64", + "type": "string" + }, + "messageCount": { + "description": "The count of messages.", + "format": "int64", + "type": "string" + }, + "minimumEventTime": { + "description": "The minimum event timestamp across these messages. For the purposes of this computation, if a message does not have an event time, we use the publish time. The timestamp will be unset if there are no messages.", + "format": "google-datetime", + "type": "string" + }, + "minimumPublishTime": { + "description": "The minimum publish timestamp across these messages. Note that publish timestamps within a partition are not guaranteed to be non-decreasing. The timestamp will be unset if there are no messages.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "Cursor": { + "description": "A cursor that describes the position of a message within a topic partition.", + "id": "Cursor", + "properties": { + "offset": { + "description": "The offset of a message within a topic partition. Must be greater than or equal 0.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DeliveryConfig": { + "description": "The settings for a subscription's message delivery.", + "id": "DeliveryConfig", + "properties": { + "deliveryRequirement": { + "description": "The DeliveryRequirement for this subscription.", + "enum": [ + "DELIVERY_REQUIREMENT_UNSPECIFIED", + "DELIVER_IMMEDIATELY", + "DELIVER_AFTER_STORED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The server does not wait for a published message to be successfully written to storage before delivering it to subscribers.", + "The server will not deliver a published message to subscribers until the message has been successfully written to storage. This will result in higher end-to-end latency, but consistent delivery." + ], + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ListPartitionCursorsResponse": { + "description": "Response for ListPartitionCursors", + "id": "ListPartitionCursorsResponse", + "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" + }, + "partitionCursors": { + "description": "The partition cursors from this request.", + "items": { + "$ref": "PartitionCursor" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSubscriptionsResponse": { + "description": "Response for ListSubscriptions.", + "id": "ListSubscriptionsResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.", + "type": "string" + }, + "subscriptions": { + "description": "The list of subscriptions in the requested parent. The order of the subscriptions is unspecified.", + "items": { + "$ref": "Subscription" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListTopicSubscriptionsResponse": { + "description": "Response for ListTopicSubscriptions.", + "id": "ListTopicSubscriptionsResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.", + "type": "string" + }, + "subscriptions": { + "description": "The names of subscriptions attached to the topic. The order of the subscriptions is unspecified.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListTopicsResponse": { + "description": "Response for ListTopics.", + "id": "ListTopicsResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.", + "type": "string" + }, + "topics": { + "description": "The list of topic in the requested parent. The order of the topics is unspecified.", + "items": { + "$ref": "Topic" + }, + "type": "array" + } + }, + "type": "object" + }, + "PartitionConfig": { + "description": "The settings for a topic's partitions.", + "id": "PartitionConfig", + "properties": { + "capacity": { + "$ref": "Capacity", + "description": "The capacity configuration." + }, + "count": { + "description": "The number of partitions in the topic. Must be at least 1.", + "format": "int64", + "type": "string" + }, + "scale": { + "description": "DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4].", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PartitionCursor": { + "description": "A pair of a Cursor and the partition it is for.", + "id": "PartitionCursor", + "properties": { + "cursor": { + "$ref": "Cursor", + "description": "The value of the cursor." + }, + "partition": { + "description": "The partition this is for.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RetentionConfig": { + "description": "The settings for a topic's message retention.", + "id": "RetentionConfig", + "properties": { + "perPartitionBytes": { + "description": "The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`.", + "format": "int64", + "type": "string" + }, + "period": { + "description": "How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "Subscription": { + "description": "Metadata about a subscription resource.", + "id": "Subscription", + "properties": { + "deliveryConfig": { + "$ref": "DeliveryConfig", + "description": "The settings for this subscription's message delivery." + }, + "name": { + "description": "The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}", + "type": "string" + }, + "topic": { + "description": "The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}", + "type": "string" + } + }, + "type": "object" + }, + "Topic": { + "description": "Metadata about a topic resource.", + "id": "Topic", + "properties": { + "name": { + "description": "The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}", + "type": "string" + }, + "partitionConfig": { + "$ref": "PartitionConfig", + "description": "The settings for this topic's partitions." + }, + "retentionConfig": { + "$ref": "RetentionConfig", + "description": "The settings for this topic's message retention." + } + }, + "type": "object" + }, + "TopicPartitions": { + "description": "Response for GetTopicPartitions.", + "id": "TopicPartitions", + "properties": { + "partitionCount": { + "description": "The number of partitions in the topic.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Pub/Sub Lite API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/realtimebidding__v1.json b/discovery/googleapis/realtimebidding__v1.json new file mode 100644 index 0000000..04a419e --- /dev/null +++ b/discovery/googleapis/realtimebidding__v1.json
@@ -0,0 +1,2584 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/realtime-bidding": { + "description": "See, create, edit, and delete your Authorized Buyers and Open Bidding account entities" + } + } + } + }, + "basePath": "", + "baseUrl": "https://realtimebidding.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Real-time Bidding", + "description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "realtimebidding:v1", + "kind": "discovery#restDescription", + "name": "realtimebidding", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "bidders": { + "resources": { + "creatives": { + "methods": { + "list": { + "description": "Lists creatives.", + "httpMethod": "GET", + "id": "realtimebidding.bidders.creatives.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.", + "location": "path", + "pattern": "^bidders/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as \"FULL\".", + "enum": [ + "CREATIVE_VIEW_UNSPECIFIED", + "SERVING_DECISION_ONLY", + "FULL" + ], + "enumDescriptions": [ + "Not specified, equivalent to SERVING_DECISION_ONLY.", + "Only creativeServingDecision is included in the response.", + "The entire creative resource (including the declared fields and the creative content) is included in the response." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/creatives", + "response": { + "$ref": "ListCreativesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "watch": { + "description": "Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.creatives.watch", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern `bidders/{bidderAccountId}`.", + "location": "path", + "pattern": "^bidders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/creatives:watch", + "request": { + "$ref": "WatchCreativesRequest" + }, + "response": { + "$ref": "WatchCreativesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + } + } + }, + "pretargetingConfigs": { + "methods": { + "activate": { + "description": "Activates a pretargeting configuration.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:activate", + "request": { + "$ref": "ActivatePretargetingConfigRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "addTargetedApps": { + "description": "Adds targeted apps to the pretargeting configuration.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.addTargetedApps", + "parameterOrder": [ + "pretargetingConfig" + ], + "parameters": { + "pretargetingConfig": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+pretargetingConfig}:addTargetedApps", + "request": { + "$ref": "AddTargetedAppsRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "addTargetedPublishers": { + "description": "Adds targeted publishers to the pretargeting config.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.addTargetedPublishers", + "parameterOrder": [ + "pretargetingConfig" + ], + "parameters": { + "pretargetingConfig": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+pretargetingConfig}:addTargetedPublishers", + "request": { + "$ref": "AddTargetedPublishersRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "addTargetedSites": { + "description": "Adds targeted sites to the pretargeting configuration.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.addTargetedSites", + "parameterOrder": [ + "pretargetingConfig" + ], + "parameters": { + "pretargetingConfig": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+pretargetingConfig}:addTargetedSites", + "request": { + "$ref": "AddTargetedSitesRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "create": { + "description": "Creates a pretargeting configuration. A pretargeting configuration's state (PretargetingConfig.state) is active upon creation, and it will start to affect traffic shortly after. A bidder may create a maximum of 10 pretargeting configurations. Attempts to exceed this maximum results in a 400 bad request error.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the bidder to create the pretargeting configuration for. Format: bidders/{bidderAccountId}", + "location": "path", + "pattern": "^bidders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pretargetingConfigs", + "request": { + "$ref": "PretargetingConfig" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "delete": { + "description": "Deletes a pretargeting configuration.", + "httpMethod": "DELETE", + "id": "realtimebidding.bidders.pretargetingConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the pretargeting configuration to delete. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "get": { + "description": "Gets a pretargeting configuration.", + "httpMethod": "GET", + "id": "realtimebidding.bidders.pretargetingConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the pretargeting configuration to get. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "list": { + "description": "Lists all pretargeting configurations for a single bidder.", + "httpMethod": "GET", + "id": "realtimebidding.bidders.pretargetingConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of pretargeting configurations to return. If unspecified, at most 10 pretargeting configurations will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. This value is received from a previous `ListPretargetingConfigs` call in ListPretargetingConfigsResponse.nextPageToken.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the bidder whose pretargeting configurations will be listed. Format: bidders/{bidderAccountId}", + "location": "path", + "pattern": "^bidders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/pretargetingConfigs", + "response": { + "$ref": "ListPretargetingConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "patch": { + "description": "Updates a pretargeting configuration.", + "httpMethod": "PATCH", + "id": "realtimebidding.bidders.pretargetingConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask to use for partial in-place updates.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "PretargetingConfig" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "removeTargetedApps": { + "description": "Removes targeted apps from the pretargeting configuration.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.removeTargetedApps", + "parameterOrder": [ + "pretargetingConfig" + ], + "parameters": { + "pretargetingConfig": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+pretargetingConfig}:removeTargetedApps", + "request": { + "$ref": "RemoveTargetedAppsRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "removeTargetedPublishers": { + "description": "Removes targeted publishers from the pretargeting config.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.removeTargetedPublishers", + "parameterOrder": [ + "pretargetingConfig" + ], + "parameters": { + "pretargetingConfig": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+pretargetingConfig}:removeTargetedPublishers", + "request": { + "$ref": "RemoveTargetedPublishersRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "removeTargetedSites": { + "description": "Removes targeted sites from the pretargeting configuration.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.removeTargetedSites", + "parameterOrder": [ + "pretargetingConfig" + ], + "parameters": { + "pretargetingConfig": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+pretargetingConfig}:removeTargetedSites", + "request": { + "$ref": "RemoveTargetedSitesRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "suspend": { + "description": "Suspends a pretargeting configuration.", + "httpMethod": "POST", + "id": "realtimebidding.bidders.pretargetingConfigs.suspend", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the pretargeting configuration. Format: bidders/{bidderAccountId}/pretargetingConfig/{configId}", + "location": "path", + "pattern": "^bidders/[^/]+/pretargetingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:suspend", + "request": { + "$ref": "SuspendPretargetingConfigRequest" + }, + "response": { + "$ref": "PretargetingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + } + } + } + } + }, + "buyers": { + "methods": { + "getRemarketingTag": { + "description": "Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.", + "httpMethod": "GET", + "id": "realtimebidding.buyers.getRemarketingTag", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId}` where `{accountId}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId}/userLists/{userListId}`. See UserList.name.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:getRemarketingTag", + "response": { + "$ref": "GetRemarketingTagResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + } + }, + "resources": { + "creatives": { + "methods": { + "create": { + "description": "Creates a creative.", + "httpMethod": "POST", + "id": "realtimebidding.buyers.creatives.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent buyer that the new creative belongs to that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, `{buyerAccountId}` should represent the account ID of the child seat buyer.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/creatives", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "get": { + "description": "Gets a creative.", + "httpMethod": "GET", + "id": "realtimebidding.buyers.creatives.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the creative to retrieve. See creative.name.", + "location": "path", + "pattern": "^buyers/[^/]+/creatives/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as \"FULL\".", + "enum": [ + "CREATIVE_VIEW_UNSPECIFIED", + "SERVING_DECISION_ONLY", + "FULL" + ], + "enumDescriptions": [ + "Not specified, equivalent to SERVING_DECISION_ONLY.", + "Only creativeServingDecision is included in the response.", + "The entire creative resource (including the declared fields and the creative content) is included in the response." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "list": { + "description": "Lists creatives.", + "httpMethod": "GET", + "id": "realtimebidding.buyers.creatives.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as \"FULL\".", + "enum": [ + "CREATIVE_VIEW_UNSPECIFIED", + "SERVING_DECISION_ONLY", + "FULL" + ], + "enumDescriptions": [ + "Not specified, equivalent to SERVING_DECISION_ONLY.", + "Only creativeServingDecision is included in the response.", + "The entire creative resource (including the declared fields and the creative content) is included in the response." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/creatives", + "response": { + "$ref": "ListCreativesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "patch": { + "description": "Updates a creative.", + "httpMethod": "PATCH", + "id": "realtimebidding.buyers.creatives.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.", + "location": "path", + "pattern": "^buyers/[^/]+/creatives/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask to use for partial in-place updates.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + } + } + }, + "userLists": { + "methods": { + "close": { + "description": "Change the status of a user list to CLOSED. This prevents new users from being added to the user list.", + "httpMethod": "POST", + "id": "realtimebidding.buyers.userLists.close", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the user list to close. See UserList.name", + "location": "path", + "pattern": "^buyers/[^/]+/userLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:close", + "request": { + "$ref": "CloseUserListRequest" + }, + "response": { + "$ref": "UserList" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "create": { + "description": "Create a new user list.", + "httpMethod": "POST", + "id": "realtimebidding.buyers.userLists.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent buyer of the user list to be retrieved that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId}` should represent the account ID of the child seat buyer.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userLists", + "request": { + "$ref": "UserList" + }, + "response": { + "$ref": "UserList" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "get": { + "description": "Gets a user list by its name.", + "httpMethod": "GET", + "id": "realtimebidding.buyers.userLists.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the user list to be retrieved. See UserList.name.", + "location": "path", + "pattern": "^buyers/[^/]+/userLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "UserList" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "getRemarketingTag": { + "description": "Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.", + "httpMethod": "GET", + "id": "realtimebidding.buyers.userLists.getRemarketingTag", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. To fetch remarketing tag for an account, name must follow the pattern `buyers/{accountId}` where `{accountId}` represents ID of a buyer that owns the remarketing tag. For a bidder accessing remarketing tag on behalf of a child seat buyer, `{accountId}` should represent the ID of the child seat buyer. To fetch remarketing tag for a specific user list, name must follow the pattern `buyers/{accountId}/userLists/{userListId}`. See UserList.name.", + "location": "path", + "pattern": "^buyers/[^/]+/userLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:getRemarketingTag", + "response": { + "$ref": "GetRemarketingTagResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "list": { + "description": "Lists the user lists visible to the current user.", + "httpMethod": "GET", + "id": "realtimebidding.buyers.userLists.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The number of results to return per page.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Continuation page token (as received from a previous response).", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent buyer for the user lists to be returned that must follow the pattern `buyers/{buyerAccountId}`, where `{buyerAccountId}` represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , `{buyerAccountId}` should represent the account ID of the child seat buyer.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userLists", + "response": { + "$ref": "ListUserListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "open": { + "description": "Change the status of a user list to OPEN. This allows new users to be added to the user list.", + "httpMethod": "POST", + "id": "realtimebidding.buyers.userLists.open", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the user list to open. See UserList.name", + "location": "path", + "pattern": "^buyers/[^/]+/userLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:open", + "request": { + "$ref": "OpenUserListRequest" + }, + "response": { + "$ref": "UserList" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + }, + "update": { + "description": "Update the given user list. Only user lists with URLRestrictions can be updated.", + "httpMethod": "PUT", + "id": "realtimebidding.buyers.userLists.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list.", + "location": "path", + "pattern": "^buyers/[^/]+/userLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "UserList" + }, + "response": { + "$ref": "UserList" + }, + "scopes": [ + "https://www.googleapis.com/auth/realtime-bidding" + ] + } + } + } + } + } + }, + "revision": "20210203", + "rootUrl": "https://realtimebidding.googleapis.com/", + "schemas": { + "ActivatePretargetingConfigRequest": { + "description": "A request to activate a pretargeting configuration. Sets the configuration's state to ACTIVE.", + "id": "ActivatePretargetingConfigRequest", + "properties": {}, + "type": "object" + }, + "AddTargetedAppsRequest": { + "description": "A request to start targeting the provided app IDs in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.", + "id": "AddTargetedAppsRequest", + "properties": { + "appIds": { + "description": "A list of app IDs to target in the pretargeting configuration. These values will be added to the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetingMode": { + "description": "Required. The targeting mode that should be applied to the list of app IDs. If there are existing targeted app IDs, must be equal to the existing PretargetingConfig.appTargeting.mobileAppTargeting.targetingMode or a 400 bad request error will be returned.", + "enum": [ + "TARGETING_MODE_UNSPECIFIED", + "INCLUSIVE", + "EXCLUSIVE" + ], + "enumDescriptions": [ + "Placeholder for undefined targeting mode.", + "The inclusive list type. Inventory must match an item in this list to be targeted.", + "The exclusive list type. Inventory must not match any item in this list to be targeted." + ], + "type": "string" + } + }, + "type": "object" + }, + "AddTargetedPublishersRequest": { + "description": "A request to start targeting the provided publishers in a specific pretargeting configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.", + "id": "AddTargetedPublishersRequest", + "properties": { + "publisherIds": { + "description": "A list of publisher IDs to target in the pretargeting configuration. These values will be added to the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetingMode": { + "description": "Required. The targeting mode that should be applied to the list of publisher IDs. If are existing publisher IDs, must be equal to the existing PretargetingConfig.publisherTargeting.targetingMode or a 400 bad request error will be returned.", + "enum": [ + "TARGETING_MODE_UNSPECIFIED", + "INCLUSIVE", + "EXCLUSIVE" + ], + "enumDescriptions": [ + "Placeholder for undefined targeting mode.", + "The inclusive list type. Inventory must match an item in this list to be targeted.", + "The exclusive list type. Inventory must not match any item in this list to be targeted." + ], + "type": "string" + } + }, + "type": "object" + }, + "AddTargetedSitesRequest": { + "description": "A request to start targeting the provided sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.", + "id": "AddTargetedSitesRequest", + "properties": { + "sites": { + "description": "A list of site URLs to target in the pretargeting configuration. These values will be added to the list of targeted URLs in PretargetingConfig.webTargeting.values.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetingMode": { + "description": "Required. The targeting mode that should be applied to the list of site URLs. If there are existing targeted sites, must be equal to the existing PretargetingConfig.webTargeting.targetingMode or a 400 bad request error will be returned.", + "enum": [ + "TARGETING_MODE_UNSPECIFIED", + "INCLUSIVE", + "EXCLUSIVE" + ], + "enumDescriptions": [ + "Placeholder for undefined targeting mode.", + "The inclusive list type. Inventory must match an item in this list to be targeted.", + "The exclusive list type. Inventory must not match any item in this list to be targeted." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserAndBrand": { + "description": "Detected advertiser and brand information.", + "id": "AdvertiserAndBrand", + "properties": { + "advertiserId": { + "description": "See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for the list of possible values. Can be used to filter the response of the creatives.list method.", + "format": "int64", + "type": "string" + }, + "advertiserName": { + "description": "Advertiser name. Can be used to filter the response of the creatives.list method.", + "type": "string" + }, + "brandId": { + "description": "Detected brand ID or zero if no brand has been detected. See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for the list of possible values. Can be used to filter the response of the creatives.list method.", + "format": "int64", + "type": "string" + }, + "brandName": { + "description": "Brand name. Can be used to filter the response of the creatives.list method.", + "type": "string" + } + }, + "type": "object" + }, + "AppTargeting": { + "description": "A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent.", + "id": "AppTargeting", + "properties": { + "mobileAppCategoryTargeting": { + "$ref": "NumericTargetingDimension", + "description": "Lists of included and excluded mobile app categories as defined in https://developers.google.com/adwords/api/docs/appendix/mobileappcategories.csv." + }, + "mobileAppTargeting": { + "$ref": "StringTargetingDimension", + "description": "Targeted app IDs. App IDs can refer to those found in an app store or ones that are not published in an app store. A maximum of 30,000 app IDs can be targeted." + } + }, + "type": "object" + }, + "CloseUserListRequest": { + "description": "A request to close a specified user list.", + "id": "CloseUserListRequest", + "properties": {}, + "type": "object" + }, + "Creative": { + "description": "A creative and its classification data.", + "id": "Creative", + "properties": { + "accountId": { + "description": "Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "adChoicesDestinationUrl": { + "description": "The link to AdChoices destination page. This is only supported for native ads.", + "type": "string" + }, + "advertiserName": { + "description": "The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.", + "type": "string" + }, + "agencyId": { + "description": "The agency ID for this creative.", + "format": "int64", + "type": "string" + }, + "apiUpdateTime": { + "description": "Output only. The last update timestamp of the creative via API.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creativeFormat": { + "description": "Output only. The format of this creative. Can be used to filter the response of the creatives.list method.", + "enum": [ + "CREATIVE_FORMAT_UNSPECIFIED", + "HTML", + "VIDEO", + "NATIVE" + ], + "enumDescriptions": [ + "The format is unknown.", + "HTML creative.", + "Video creative.", + "Native creative." + ], + "readOnly": true, + "type": "string" + }, + "creativeId": { + "description": "Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.", + "type": "string" + }, + "creativeServingDecision": { + "$ref": "CreativeServingDecision", + "description": "Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.", + "readOnly": true + }, + "dealIds": { + "description": "Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "declaredAttributes": { + "description": "All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto\") contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.", + "items": { + "enum": [ + "ATTRIBUTE_UNSPECIFIED", + "IMAGE_RICH_MEDIA", + "ADOBE_FLASH_FLV", + "IS_TAGGED", + "IS_COOKIE_TARGETED", + "IS_USER_INTEREST_TARGETED", + "EXPANDING_DIRECTION_NONE", + "EXPANDING_DIRECTION_UP", + "EXPANDING_DIRECTION_DOWN", + "EXPANDING_DIRECTION_LEFT", + "EXPANDING_DIRECTION_RIGHT", + "EXPANDING_DIRECTION_UP_LEFT", + "EXPANDING_DIRECTION_UP_RIGHT", + "EXPANDING_DIRECTION_DOWN_LEFT", + "EXPANDING_DIRECTION_DOWN_RIGHT", + "CREATIVE_TYPE_HTML", + "CREATIVE_TYPE_VAST_VIDEO", + "EXPANDING_DIRECTION_UP_OR_DOWN", + "EXPANDING_DIRECTION_LEFT_OR_RIGHT", + "EXPANDING_DIRECTION_ANY_DIAGONAL", + "EXPANDING_ACTION_ROLLOVER_TO_EXPAND", + "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH", + "RICH_MEDIA_CAPABILITY_TYPE_MRAID", + "RICH_MEDIA_CAPABILITY_TYPE_FLASH", + "RICH_MEDIA_CAPABILITY_TYPE_HTML5", + "SKIPPABLE_INSTREAM_VIDEO", + "RICH_MEDIA_CAPABILITY_TYPE_SSL", + "RICH_MEDIA_CAPABILITY_TYPE_NON_SSL", + "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL", + "NON_SKIPPABLE_INSTREAM_VIDEO", + "NATIVE_ELIGIBILITY_ELIGIBLE", + "NON_VPAID", + "NATIVE_ELIGIBILITY_NOT_ELIGIBLE", + "ANY_INTERSTITIAL", + "NON_INTERSTITIAL", + "IN_BANNER_VIDEO", + "RENDERING_SIZELESS_ADX", + "OMSDK_1_0" + ], + "enumDescriptions": [ + "Do not use. This is a placeholder value only.", + "The creative is of type image/rich media. For pretargeting.", + "The creative is of video type Adobe Flash FLV. For pretargeting.", + "The creative is tagged.", + "The creative is cookie targeted.", + "The creative is user interest targeted.", + "The creative does not expand.", + "The creative expands up.", + "The creative expands down.", + "The creative expands left.", + "The creative expands right.", + "The creative expands up and left.", + "The creative expands up and right.", + "The creative expands down and left.", + "The creative expands down and right.", + "The creative type is HTML.", + "The creative type is VAST video.", + "The creative expands up or down.", + "The creative expands left or right.", + "The creative expands on any diagonal.", + "The creative expands when rolled over.", + "The instream vast video type is vpaid flash.", + "The creative is MRAID.", + "The creative is Flash.", + "The creative is HTML5.", + "The creative has an instream VAST video type of skippable instream video. For pretargeting.", + "The creative is SSL.", + "The creative is non-SSL.", + "The creative is an interstitial.", + "The creative has an instream VAST video type of non-skippable instream video. For pretargeting.", + "The creative is eligible for native.", + "The creative has an instream VAST video type of non-VPAID. For pretargeting.", + "The creative is not eligible for native.", + "The creative has an interstitial size of any interstitial. For pretargeting.", + "The creative has an interstitial size of non interstitial. For pretargeting.", + "The video type is in-banner video.", + "The creative can dynamically resize to fill a variety of slot sizes.", + "The open measurement SDK is supported." + ], + "type": "string" + }, + "type": "array" + }, + "declaredClickThroughUrls": { + "description": "The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.", + "items": { + "type": "string" + }, + "type": "array" + }, + "declaredRestrictedCategories": { + "description": "All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.", + "items": { + "enum": [ + "RESTRICTED_CATEGORY_UNSPECIFIED", + "ALCOHOL" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "The alcohol restricted category." + ], + "type": "string" + }, + "type": "array" + }, + "declaredVendorIds": { + "description": "IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "html": { + "$ref": "HtmlContent", + "description": "An HTML creative." + }, + "impressionTrackingUrls": { + "description": "The set of URLs to be called to record an impression.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.", + "readOnly": true, + "type": "string" + }, + "native": { + "$ref": "NativeContent", + "description": "A native creative." + }, + "restrictedCategories": { + "description": "All restricted categories for the ads that may be shown from this creative.", + "items": { + "enum": [ + "RESTRICTED_CATEGORY_UNSPECIFIED", + "ALCOHOL" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "The alcohol restricted category." + ], + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "Output only. The version of this creative. Version for a new creative is 1 and it increments during subsequent creative updates.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "video": { + "$ref": "VideoContent", + "description": "A video creative." + } + }, + "type": "object" + }, + "CreativeDimensions": { + "description": "The dimensions of a creative. This applies to only HTML and Native creatives.", + "id": "CreativeDimensions", + "properties": { + "height": { + "description": "The height of the creative in pixels.", + "format": "int64", + "type": "string" + }, + "width": { + "description": "The width of the creative in pixels.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CreativeServingDecision": { + "description": "Top level status and detected attributes of a creative.", + "id": "CreativeServingDecision", + "properties": { + "chinaPolicyCompliance": { + "$ref": "PolicyCompliance", + "description": "The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction." + }, + "dealsPolicyCompliance": { + "$ref": "PolicyCompliance", + "description": "Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China)." + }, + "detectedAdvertisers": { + "description": "Detected advertisers and brands.", + "items": { + "$ref": "AdvertiserAndBrand" + }, + "type": "array" + }, + "detectedAttributes": { + "description": "Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.", + "items": { + "enum": [ + "ATTRIBUTE_UNSPECIFIED", + "IMAGE_RICH_MEDIA", + "ADOBE_FLASH_FLV", + "IS_TAGGED", + "IS_COOKIE_TARGETED", + "IS_USER_INTEREST_TARGETED", + "EXPANDING_DIRECTION_NONE", + "EXPANDING_DIRECTION_UP", + "EXPANDING_DIRECTION_DOWN", + "EXPANDING_DIRECTION_LEFT", + "EXPANDING_DIRECTION_RIGHT", + "EXPANDING_DIRECTION_UP_LEFT", + "EXPANDING_DIRECTION_UP_RIGHT", + "EXPANDING_DIRECTION_DOWN_LEFT", + "EXPANDING_DIRECTION_DOWN_RIGHT", + "CREATIVE_TYPE_HTML", + "CREATIVE_TYPE_VAST_VIDEO", + "EXPANDING_DIRECTION_UP_OR_DOWN", + "EXPANDING_DIRECTION_LEFT_OR_RIGHT", + "EXPANDING_DIRECTION_ANY_DIAGONAL", + "EXPANDING_ACTION_ROLLOVER_TO_EXPAND", + "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH", + "RICH_MEDIA_CAPABILITY_TYPE_MRAID", + "RICH_MEDIA_CAPABILITY_TYPE_FLASH", + "RICH_MEDIA_CAPABILITY_TYPE_HTML5", + "SKIPPABLE_INSTREAM_VIDEO", + "RICH_MEDIA_CAPABILITY_TYPE_SSL", + "RICH_MEDIA_CAPABILITY_TYPE_NON_SSL", + "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL", + "NON_SKIPPABLE_INSTREAM_VIDEO", + "NATIVE_ELIGIBILITY_ELIGIBLE", + "NON_VPAID", + "NATIVE_ELIGIBILITY_NOT_ELIGIBLE", + "ANY_INTERSTITIAL", + "NON_INTERSTITIAL", + "IN_BANNER_VIDEO", + "RENDERING_SIZELESS_ADX", + "OMSDK_1_0" + ], + "enumDescriptions": [ + "Do not use. This is a placeholder value only.", + "The creative is of type image/rich media. For pretargeting.", + "The creative is of video type Adobe Flash FLV. For pretargeting.", + "The creative is tagged.", + "The creative is cookie targeted.", + "The creative is user interest targeted.", + "The creative does not expand.", + "The creative expands up.", + "The creative expands down.", + "The creative expands left.", + "The creative expands right.", + "The creative expands up and left.", + "The creative expands up and right.", + "The creative expands down and left.", + "The creative expands down and right.", + "The creative type is HTML.", + "The creative type is VAST video.", + "The creative expands up or down.", + "The creative expands left or right.", + "The creative expands on any diagonal.", + "The creative expands when rolled over.", + "The instream vast video type is vpaid flash.", + "The creative is MRAID.", + "The creative is Flash.", + "The creative is HTML5.", + "The creative has an instream VAST video type of skippable instream video. For pretargeting.", + "The creative is SSL.", + "The creative is non-SSL.", + "The creative is an interstitial.", + "The creative has an instream VAST video type of non-skippable instream video. For pretargeting.", + "The creative is eligible for native.", + "The creative has an instream VAST video type of non-VPAID. For pretargeting.", + "The creative is not eligible for native.", + "The creative has an interstitial size of any interstitial. For pretargeting.", + "The creative has an interstitial size of non interstitial. For pretargeting.", + "The video type is in-banner video.", + "The creative can dynamically resize to fill a variety of slot sizes.", + "The open measurement SDK is supported." + ], + "type": "string" + }, + "type": "array" + }, + "detectedClickThroughUrls": { + "description": "The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.", + "items": { + "type": "string" + }, + "type": "array" + }, + "detectedDomains": { + "description": "The detected domains for this creative.", + "items": { + "type": "string" + }, + "type": "array" + }, + "detectedLanguages": { + "description": "The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. Can be used to filter the response of the creatives.list method.", + "items": { + "type": "string" + }, + "type": "array" + }, + "detectedProductCategories": { + "description": "Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. Can be used to filter the response of the creatives.list method.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "detectedSensitiveCategories": { + "description": "Detected sensitive categories, if any. Can be used to filter the response of the creatives.list method. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "detectedVendorIds": { + "description": "IDs of the ad technology vendors that were detected to be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. If the `allowed_vendor_type` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the vendor type IDs that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "lastStatusUpdate": { + "description": "The last time the creative status was updated. Can be used to filter the response of the creatives.list method.", + "format": "google-datetime", + "type": "string" + }, + "networkPolicyCompliance": { + "$ref": "PolicyCompliance", + "description": "Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China)." + }, + "platformPolicyCompliance": { + "$ref": "PolicyCompliance", + "description": "Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851." + }, + "russiaPolicyCompliance": { + "$ref": "PolicyCompliance", + "description": "The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction." + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DestinationNotCrawlableEvidence": { + "description": "Evidence that the creative's destination URL was not crawlable by Google.", + "id": "DestinationNotCrawlableEvidence", + "properties": { + "crawlTime": { + "description": "Approximate time of the crawl.", + "format": "google-datetime", + "type": "string" + }, + "crawledUrl": { + "description": "Destination URL that was attempted to be crawled.", + "type": "string" + }, + "reason": { + "description": "Reason of destination not crawlable.", + "enum": [ + "REASON_UNSPECIFIED", + "UNREACHABLE_ROBOTS", + "TIMEOUT_ROBOTS", + "ROBOTED_DENIED", + "UNKNOWN" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "Site's robots exclusion file (e.g., robots.txt) was unreachable.", + "Timed out reading site's robots exclusion file (e.g., robots.txt).", + "Crawler was disallowed by the site's robots exclusion file (e.g., robots.txt).", + "Unknown reason." + ], + "type": "string" + } + }, + "type": "object" + }, + "DestinationNotWorkingEvidence": { + "description": "Evidence of the creative's destination URL not functioning properly or having been incorrectly set up.", + "id": "DestinationNotWorkingEvidence", + "properties": { + "dnsError": { + "description": "DNS lookup errors.", + "enum": [ + "DNS_ERROR_UNSPECIFIED", + "ERROR_DNS", + "GOOGLE_CRAWLER_DNS_ISSUE" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "DNS name was not found.", + "An internal issue occurred when Google's crawler tried to resolve the DNS entry. This is a Google-internal issue and may not be the result of an issue with the landing page." + ], + "type": "string" + }, + "expandedUrl": { + "description": "The full non-working URL.", + "type": "string" + }, + "httpError": { + "description": "HTTP error code (e.g. 404 or 5xx)", + "format": "int32", + "type": "integer" + }, + "invalidPage": { + "description": "Page was crawled successfully, but was detected as either a page with no content or an error page.", + "enum": [ + "INVALID_PAGE_UNSPECIFIED", + "EMPTY_OR_ERROR_PAGE" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "Page was empty or had an error." + ], + "type": "string" + }, + "lastCheckTime": { + "description": "Approximate time when the ad destination was last checked.", + "format": "google-datetime", + "type": "string" + }, + "platform": { + "description": "Platform of the non-working URL.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "PERSONAL_COMPUTER", + "ANDROID", + "IOS" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "The personal computer platform.", + "The Android platform.", + "The iOS platform." + ], + "type": "string" + }, + "redirectionError": { + "description": "HTTP redirect chain error.", + "enum": [ + "REDIRECTION_ERROR_UNSPECIFIED", + "TOO_MANY_REDIRECTS", + "INVALID_REDIRECT", + "EMPTY_REDIRECT", + "REDIRECT_ERROR_UNKNOWN" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "Too many redirect hops.", + "Got a redirect but it was invalid.", + "Got a redirect but it was empty.", + "Unknown redirect error." + ], + "type": "string" + }, + "urlRejected": { + "description": "Rejected because of malformed URLs or invalid requests.", + "enum": [ + "URL_REJECTED_UNSPECIFIED", + "BAD_REQUEST", + "MALFORMED_URL", + "URL_REJECTED_UNKNOWN" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "URL rejected because of a malformed request.", + "URL rejected because of a malformed URL.", + "URL rejected because of unknown reason." + ], + "type": "string" + } + }, + "type": "object" + }, + "DestinationUrlEvidence": { + "description": "The full landing page URL of the destination.", + "id": "DestinationUrlEvidence", + "properties": { + "destinationUrl": { + "description": "The full landing page URL of the destination.", + "type": "string" + } + }, + "type": "object" + }, + "DomainCallEvidence": { + "description": "Number of HTTP calls made by a creative, broken down by domain.", + "id": "DomainCallEvidence", + "properties": { + "topHttpCallDomains": { + "description": "Breakdown of the most frequent domains called via HTTP by the creative.", + "items": { + "$ref": "DomainCalls" + }, + "type": "array" + }, + "totalHttpCallCount": { + "description": "The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DomainCalls": { + "description": "The number of HTTP calls made to the given domain.", + "id": "DomainCalls", + "properties": { + "domain": { + "description": "The domain name.", + "type": "string" + }, + "httpCallCount": { + "description": "Number of HTTP calls made to the domain.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DownloadSizeEvidence": { + "description": "Total download size and URL-level download size breakdown for resources in a creative.", + "id": "DownloadSizeEvidence", + "properties": { + "topUrlDownloadSizeBreakdowns": { + "description": "Download size broken down by URLs with the top download size.", + "items": { + "$ref": "UrlDownloadSize" + }, + "type": "array" + }, + "totalDownloadSizeKb": { + "description": "Total download size (in kilobytes) for all the resources in the creative.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "GetRemarketingTagResponse": { + "description": "Response for a request to get remarketing tag.", + "id": "GetRemarketingTagResponse", + "properties": { + "snippet": { + "description": "A HTML tag that can be placed on the advertiser's page to add users to a user list. For more information and code samples on using snippet on your website refer to [Tag your site for remarketing]( https://support.google.com/google-ads/answer/2476688).", + "type": "string" + } + }, + "type": "object" + }, + "HtmlContent": { + "description": "HTML content for a creative.", + "id": "HtmlContent", + "properties": { + "height": { + "description": "The height of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.", + "format": "int32", + "type": "integer" + }, + "snippet": { + "description": "The HTML snippet that displays the ad when inserted in the web page.", + "type": "string" + }, + "width": { + "description": "The width of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "HttpCallEvidence": { + "description": "HTTP calls made by a creative that resulted in policy violations.", + "id": "HttpCallEvidence", + "properties": { + "urls": { + "description": "URLs of HTTP calls made by the creative.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "HttpCookieEvidence": { + "description": "Evidence for HTTP cookie-related policy violations.", + "id": "HttpCookieEvidence", + "properties": { + "cookieNames": { + "description": "Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.", + "items": { + "type": "string" + }, + "type": "array" + }, + "maxCookieCount": { + "description": "The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Image": { + "description": "An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved.", + "id": "Image", + "properties": { + "height": { + "description": "Image height in pixels.", + "format": "int32", + "type": "integer" + }, + "url": { + "description": "The URL of the image.", + "type": "string" + }, + "width": { + "description": "Image width in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ListCreativesResponse": { + "description": "A response for listing creatives.", + "id": "ListCreativesResponse", + "properties": { + "creatives": { + "description": "The list of creatives.", + "items": { + "$ref": "Creative" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.pageToken field in the subsequent call to the `ListCreatives` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListPretargetingConfigsResponse": { + "description": "A response containing pretargeting configurations.", + "id": "ListPretargetingConfigsResponse", + "properties": { + "nextPageToken": { + "description": "A token which can be passed to a subsequent call to the `ListPretargetingConfigs` method to retrieve the next page of results in ListPretargetingConfigsRequest.pageToken.", + "type": "string" + }, + "pretargetingConfigs": { + "description": "List of pretargeting configurations.", + "items": { + "$ref": "PretargetingConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListUserListsResponse": { + "description": "The list user list response.", + "id": "ListUserListsResponse", + "properties": { + "nextPageToken": { + "description": "The continuation page token to send back to the server in a subsequent request. Due to a currently known issue, it is recommended that the caller keep invoking the list method till the time a next page token is not returned (even if the result set is empty).", + "type": "string" + }, + "userLists": { + "description": "List of user lists from the search.", + "items": { + "$ref": "UserList" + }, + "type": "array" + } + }, + "type": "object" + }, + "MediaFile": { + "description": "Information about each media file in the VAST.", + "id": "MediaFile", + "properties": { + "bitrate": { + "description": "Bitrate of the video file, in Kbps. Can be used to filter the response of the creatives.list method.", + "format": "int64", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of this media file. Can be used to filter the response of the creatives.list method.", + "enum": [ + "VIDEO_MIME_TYPE_UNSPECIFIED", + "MIME_VIDEO_XFLV", + "MIME_VIDEO_WEBM", + "MIME_VIDEO_MP4", + "MIME_VIDEO_OGG", + "MIME_VIDEO_YT_HOSTED", + "MIME_VIDEO_X_MS_WMV", + "MIME_VIDEO_3GPP", + "MIME_VIDEO_MOV", + "MIME_APPLICATION_SWF", + "MIME_APPLICATION_SURVEY", + "MIME_APPLICATION_JAVASCRIPT", + "MIME_APPLICATION_SILVERLIGHT", + "MIME_APPLICATION_MPEGURL", + "MIME_APPLICATION_MPEGDASH", + "MIME_AUDIO_MP4A", + "MIME_AUDIO_MP3", + "MIME_AUDIO_OGG" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "Flash container.", + "WebM container assuming VP9 codec.", + "MPEG-4 container typically with H.264 codec.", + "Ogg container assuming Theora codec.", + "Video files hosted on YouTube.", + "Windows Media Video Codec.", + "3GPP container format used on 3G phones.", + "Quicktime container format.", + "Shockwave Flash (used for VPAID ads).", + "Properties of VAST served by consumer survey.", + "JavaScript (used for VPAID ads).", + "Silverlight (used for VPAID ads).", + "HLS/M3U8.", + "DASH.", + "MPEG-4 audio format.", + "MPEG-3 audio format.", + "Ogg audio format" + ], + "type": "string" + } + }, + "type": "object" + }, + "NativeContent": { + "description": "Native content for a creative.", + "id": "NativeContent", + "properties": { + "advertiserName": { + "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.", + "type": "string" + }, + "appIcon": { + "$ref": "Image", + "description": "The app icon, for app download ads." + }, + "body": { + "description": "A long description of the ad.", + "type": "string" + }, + "callToAction": { + "description": "A label for the button that the user is supposed to click.", + "type": "string" + }, + "clickLinkUrl": { + "description": "The URL that the browser/SDK will load when the user clicks the ad.", + "type": "string" + }, + "clickTrackingUrl": { + "description": "The URL to use for click tracking.", + "type": "string" + }, + "headline": { + "description": "A short title for the ad.", + "type": "string" + }, + "image": { + "$ref": "Image", + "description": "A large image." + }, + "logo": { + "$ref": "Image", + "description": "A smaller image, for the advertiser's logo." + }, + "priceDisplayText": { + "description": "The price of the promoted app including currency info.", + "type": "string" + }, + "starRating": { + "description": "The app rating in the app store. Must be in the range [0-5].", + "format": "double", + "type": "number" + }, + "videoUrl": { + "description": "The URL to fetch a native video ad.", + "type": "string" + } + }, + "type": "object" + }, + "NumericTargetingDimension": { + "description": "Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting.", + "id": "NumericTargetingDimension", + "properties": { + "excludedIds": { + "description": "The IDs excluded in a configuration.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "includedIds": { + "description": "The IDs included in a configuration.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "OpenUserListRequest": { + "description": "A request to open a specified user list.", + "id": "OpenUserListRequest", + "properties": {}, + "type": "object" + }, + "PolicyCompliance": { + "description": "Policy compliance of the creative for a transaction type or a region.", + "id": "PolicyCompliance", + "properties": { + "status": { + "description": "Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.", + "enum": [ + "STATUS_UNSPECIFIED", + "PENDING_REVIEW", + "DISAPPROVED", + "APPROVED" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "Creative is pending review.", + "Creative cannot serve.", + "Creative is approved." + ], + "type": "string" + }, + "topics": { + "description": "Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.", + "items": { + "$ref": "PolicyTopicEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "PolicyTopicEntry": { + "description": "Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.", + "id": "PolicyTopicEntry", + "properties": { + "evidences": { + "description": "Pieces of evidence associated with this policy topic entry.", + "items": { + "$ref": "PolicyTopicEvidence" + }, + "type": "array" + }, + "helpCenterUrl": { + "description": "URL of the help center article describing this policy topic.", + "type": "string" + }, + "policyTopic": { + "description": "Policy topic this entry refers to. For example, \"ALCOHOL\", \"TRADEMARKS_IN_AD_TEXT\", or \"DESTINATION_NOT_WORKING\". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method", + "type": "string" + } + }, + "type": "object" + }, + "PolicyTopicEvidence": { + "description": "Evidence associated with a policy topic entry.", + "id": "PolicyTopicEvidence", + "properties": { + "destinationNotCrawlable": { + "$ref": "DestinationNotCrawlableEvidence", + "description": "The creative's destination URL was not crawlable by Google." + }, + "destinationNotWorking": { + "$ref": "DestinationNotWorkingEvidence", + "description": "The creative's destination URL did not function properly or was incorrectly set up." + }, + "destinationUrl": { + "$ref": "DestinationUrlEvidence", + "description": "URL of the actual landing page." + }, + "domainCall": { + "$ref": "DomainCallEvidence", + "description": "Number of HTTP calls made by the creative, broken down by domain." + }, + "downloadSize": { + "$ref": "DownloadSizeEvidence", + "description": "Total download size and URL-level download size breakdown for resources in a creative." + }, + "httpCall": { + "$ref": "HttpCallEvidence", + "description": "HTTP calls made by the creative that resulted in policy violations." + }, + "httpCookie": { + "$ref": "HttpCookieEvidence", + "description": "Evidence for HTTP cookie-related policy violations." + } + }, + "type": "object" + }, + "PretargetingConfig": { + "description": "Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.", + "id": "PretargetingConfig", + "properties": { + "allowedUserTargetingModes": { + "description": "Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow.", + "items": { + "enum": [ + "USER_TARGETING_MODE_UNSPECIFIED", + "REMARKETING_ADS", + "INTEREST_BASED_TARGETING" + ], + "enumDescriptions": [ + "Placeholder for undefined user targeting mode.", + "Remarketing ads are allowed to serve.", + "Ads based on user interest category targeting are allowed to serve." + ], + "type": "string" + }, + "type": "array" + }, + "appTargeting": { + "$ref": "AppTargeting", + "description": "Targeting on a subset of app inventory. If APP is listed in targeted_environments, the specified targeting is applied. A maximum of 30,000 app IDs can be targeted. An unset value for targeting allows all app-based bid requests to be sent. Apps can either be targeting positively (bid requests will be sent only if the destination app is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination app is not listed in the targeting dimension)." + }, + "billingId": { + "description": "Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has.", + "type": "string" + }, + "excludedContentLabelIds": { + "description": "The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "geoTargeting": { + "$ref": "NumericTargetingDimension", + "description": "The geos included or excluded in this configuration defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv" + }, + "includedCreativeDimensions": { + "description": "Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension.", + "items": { + "$ref": "CreativeDimensions" + }, + "type": "array" + }, + "includedEnvironments": { + "description": "Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments.", + "items": { + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "APP", + "WEB" + ], + "enumDescriptions": [ + "Placeholder for unspecified environment. This value should not be used.", + "App environment.", + "Web environment." + ], + "type": "string" + }, + "type": "array" + }, + "includedFormats": { + "description": "Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format.", + "items": { + "enum": [ + "CREATIVE_FORMAT_UNSPECIFIED", + "HTML", + "VAST", + "NATIVE" + ], + "enumDescriptions": [ + "Placeholder for undefined creative format. This value should not be used.", + "HTML and AMPHTML creatives.", + "VAST video or audio creative.", + "Native creative, including standard and video native ads." + ], + "type": "string" + }, + "type": "array" + }, + "includedLanguages": { + "description": "The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/languagecodes.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedMobileOperatingSystemIds": { + "description": "The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "includedPlatforms": { + "description": "The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform.", + "items": { + "enum": [ + "PLATFORM_UNSPECIFIED", + "PERSONAL_COMPUTER", + "PHONE", + "TABLET", + "CONNECTED_TV" + ], + "enumDescriptions": [ + "Placeholder for an undefined platform. This value should not be used.", + "The personal computer platform.", + "The mobile platform.", + "The tablet platform.", + "The connected TV platform." + ], + "type": "string" + }, + "type": "array" + }, + "includedUserIdTypes": { + "description": "User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent.", + "items": { + "enum": [ + "USER_ID_TYPE_UNSPECIFIED", + "HOSTED_MATCH_DATA", + "GOOGLE_COOKIE", + "DEVICE_ID" + ], + "enumDescriptions": [ + "Placeholder for unspecified user identifier.", + "Hosted match data, referring to hosted_match_data in the bid request.", + "Google cookie, referring to google_user_id in the bid request.", + "Mobile device advertising ID." + ], + "type": "string" + }, + "type": "array" + }, + "interstitialTargeting": { + "description": "The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not.", + "enum": [ + "INTERSTITIAL_TARGETING_UNSPECIFIED", + "ONLY_INTERSTITIAL_REQUESTS", + "ONLY_NON_INTERSTITIAL_REQUESTS" + ], + "enumDescriptions": [ + "Unspecified interstitial targeting. Represents an interstitial-agnostic selection.", + "Only bid requests for interstitial inventory should be sent.", + "Only bid requests for non-interstitial inventory should be sent." + ], + "type": "string" + }, + "invalidGeoIds": { + "description": "Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "maximumQps": { + "description": "The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/peer-guide", + "format": "int64", + "type": "string" + }, + "minimumViewabilityDecile": { + "description": "The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Output only. Name of the pretargeting configuration that must follow the pattern `bidders/{bidder_account_id}/pretargetingConfigs/{config_id}`", + "readOnly": true, + "type": "string" + }, + "publisherTargeting": { + "$ref": "StringTargetingDimension", + "description": "Targeting on a subset of publisher inventory. Publishers can either be targeted positively (bid requests will be sent only if the publisher is listed in the targeting dimension) or negatively (bid requests will be sent only if the publisher is not listed in the targeting dimension). A maximum of 10,000 publisher IDs can be targeted. Publisher IDs are found in [ads.txt](https://iabtechlab.com/ads-txt/) / [app-ads.txt](https://iabtechlab.com/app-ads-txt/) and in bid requests in the `BidRequest.publisher_id` field on the [Google RTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) or the `BidRequest.site.publisher.id` / `BidRequest.app.publisher.id` field on the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto)." + }, + "state": { + "description": "Output only. The state of this pretargeting configuration.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "SUSPENDED" + ], + "enumDescriptions": [ + "Placeholder for undefined state.", + "This pretargeting configuration is actively being used to filter bid requests.", + "This pretargeting configuration is suspended and not used in serving." + ], + "readOnly": true, + "type": "string" + }, + "userListTargeting": { + "$ref": "NumericTargetingDimension", + "description": "The remarketing lists included or excluded in this configuration as defined in UserList." + }, + "verticalTargeting": { + "$ref": "NumericTargetingDimension", + "description": "The verticals included or excluded in this configuration as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals" + }, + "webTargeting": { + "$ref": "StringTargetingDimension", + "description": "Targeting on a subset of site inventory. If WEB is listed in included_environments, the specified targeting is applied. A maximum of 50,000 site URLs can be targeted. An unset value for targeting allows all web-based bid requests to be sent. Sites can either be targeting positively (bid requests will be sent only if the destination site is listed in the targeting dimension) or negatively (bid requests will be sent only if the destination site is not listed in the pretargeting configuration)." + } + }, + "type": "object" + }, + "RemoveTargetedAppsRequest": { + "description": "A request to stop targeting the provided apps in a specific pretargeting configuration. The pretargeting configuration itself specifies how these apps are targeted. in PretargetingConfig.appTargeting.mobileAppTargeting.", + "id": "RemoveTargetedAppsRequest", + "properties": { + "appIds": { + "description": "A list of app IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted app IDs in PretargetingConfig.appTargeting.mobileAppTargeting.values.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RemoveTargetedPublishersRequest": { + "description": "A request to stop targeting publishers in a specific configuration. The pretargeting configuration itself specifies how these publishers are targeted in PretargetingConfig.publisherTargeting.", + "id": "RemoveTargetedPublishersRequest", + "properties": { + "publisherIds": { + "description": "A list of publisher IDs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted publisher IDs in PretargetingConfig.publisherTargeting.values. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RemoveTargetedSitesRequest": { + "description": "A request to stop targeting sites in a specific pretargeting configuration. The pretargeting configuration itself specifies how these sites are targeted in PretargetingConfig.webTargeting.", + "id": "RemoveTargetedSitesRequest", + "properties": { + "sites": { + "description": "A list of site URLs to stop targeting in the pretargeting configuration. These values will be removed from the list of targeted URLs in PretargetingConfig.webTargeting.values.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "StringTargetingDimension": { + "description": "Generic targeting with string values used in app, website and publisher targeting.", + "id": "StringTargetingDimension", + "properties": { + "targetingMode": { + "description": "How the items in this list should be targeted.", + "enum": [ + "TARGETING_MODE_UNSPECIFIED", + "INCLUSIVE", + "EXCLUSIVE" + ], + "enumDescriptions": [ + "Placeholder for undefined targeting mode.", + "The inclusive list type. Inventory must match an item in this list to be targeted.", + "The exclusive list type. Inventory must not match any item in this list to be targeted." + ], + "type": "string" + }, + "values": { + "description": "The values specified.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SuspendPretargetingConfigRequest": { + "description": "A request to suspend a pretargeting configuration. Sets the configuration's state to SUSPENDED.", + "id": "SuspendPretargetingConfigRequest", + "properties": {}, + "type": "object" + }, + "UrlDownloadSize": { + "description": "The URL-level breakdown for the download size.", + "id": "UrlDownloadSize", + "properties": { + "downloadSizeKb": { + "description": "Download size of the URL in kilobytes.", + "format": "int32", + "type": "integer" + }, + "normalizedUrl": { + "description": "The normalized URL with query parameters and fragment removed.", + "type": "string" + } + }, + "type": "object" + }, + "UrlRestriction": { + "description": "Represents the URL restriction (for the URL captured by the pixel callback) for a user list.", + "id": "UrlRestriction", + "properties": { + "endDate": { + "$ref": "Date", + "description": "End date (if specified) of the URL restriction. End date should be later than the start date for the date range to be valid." + }, + "restrictionType": { + "description": "The restriction type for the specified URL.", + "enum": [ + "RESTRICTION_TYPE_UNSPECIFIED", + "CONTAINS", + "EQUALS", + "STARTS_WITH", + "ENDS_WITH", + "DOES_NOT_EQUAL", + "DOES_NOT_CONTAIN", + "DOES_NOT_START_WITH", + "DOES_NOT_END_WITH" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "The tag URL (as recorded by the pixel callback) contains the specified URL.", + "The tag URL (as recorded by the pixel callback) exactly matches the specified URL.", + "The tag URL (as recorded by the pixel callback) starts with the specified URL.", + "The tag URL (as recorded by the pixel callback) ends with the specified URL.", + "The tag URL (as recorded by the pixel callback) does not equal the specified URL.", + "The tag URL (as recorded by the pixel callback) does not contain the specified URL.", + "The tag URL (as recorded by the pixel callback) does not start with the specified URL.", + "The tag URL (as recorded by the pixel callback) does not end with the specified URL." + ], + "type": "string" + }, + "startDate": { + "$ref": "Date", + "description": "Start date (if specified) of the URL restriction." + }, + "url": { + "description": "Required. The URL to use for applying the restriction on the user list.", + "type": "string" + } + }, + "type": "object" + }, + "UserList": { + "description": "Represents an Authorized Buyers user list. Authorized Buyers can create/update/list user lists. Once a user list is created in the system, Authorized Buyers can add users to the user list using the bulk uploader API. Alternatively, users can be added by hosting a tag on the advertiser's page.", + "id": "UserList", + "properties": { + "description": { + "description": "The description for the user list.", + "type": "string" + }, + "displayName": { + "description": "Required. Display name of the user list. This must be unique across all user lists for a given account.", + "type": "string" + }, + "membershipDurationDays": { + "description": "Required. The number of days a user's cookie stays on the user list. The field must be between 0 and 540 inclusive.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Output only. Name of the user list that must follow the pattern `buyers/{buyer}/userLists/{user_list}`, where `{buyer}` represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, `{buyer}` represents the account ID of the child seat buyer. `{user_list}` is an int64 identifier assigned by Google to uniquely identify a user list.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The status of the user list. A new user list starts out as open.", + "enum": [ + "STATUS_UNSPECIFIED", + "OPEN", + "CLOSED" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "New users can be added to the user list.", + "New users cannot be added to the user list." + ], + "readOnly": true, + "type": "string" + }, + "urlRestriction": { + "$ref": "UrlRestriction", + "description": "Required. The URL restriction for the user list." + } + }, + "type": "object" + }, + "VideoContent": { + "description": "Video content for a creative.", + "id": "VideoContent", + "properties": { + "videoMetadata": { + "$ref": "VideoMetadata", + "description": "Output only. Video metadata.", + "readOnly": true + }, + "videoUrl": { + "description": "The URL to fetch a video ad.", + "type": "string" + }, + "videoVastXml": { + "description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.", + "type": "string" + } + }, + "type": "object" + }, + "VideoMetadata": { + "description": "Video metadata for a creative.", + "id": "VideoMetadata", + "properties": { + "duration": { + "description": "The duration of the ad. Can be used to filter the response of the creatives.list method.", + "format": "google-duration", + "type": "string" + }, + "isValidVast": { + "description": "Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.", + "type": "boolean" + }, + "isVpaid": { + "description": "Is this a VPAID ad? Can be used to filter the response of the creatives.list method.", + "type": "boolean" + }, + "mediaFiles": { + "description": "The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper chain, this includes the media files from the deepest one in the chain.", + "items": { + "$ref": "MediaFile" + }, + "type": "array" + }, + "skipOffset": { + "description": "The minimum duration that the user has to watch before being able to skip this ad. If the field is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to filter the response of the creatives.list method.", + "format": "google-duration", + "type": "string" + }, + "vastVersion": { + "description": "The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the creatives.list method.", + "enum": [ + "VAST_VERSION_UNSPECIFIED", + "VAST_VERSION_1_0", + "VAST_VERSION_2_0", + "VAST_VERSION_3_0", + "VAST_VERSION_4_0" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "VAST 1.0", + "VAST 2.0", + "VAST 3.0", + "VAST 4.0" + ], + "type": "string" + } + }, + "type": "object" + }, + "WatchCreativesRequest": { + "description": "A request to receive push notifications when any of the creatives belonging to the bidder changes status.", + "id": "WatchCreativesRequest", + "properties": {}, + "type": "object" + }, + "WatchCreativesResponse": { + "description": "A response for the request to receive push notification when a bidder's creatives change status.", + "id": "WatchCreativesResponse", + "properties": { + "subscription": { + "description": "The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Please use watchCreatives to re-enable the subscription.", + "type": "string" + }, + "topic": { + "description": "The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format `projects/{project_id}/topics/{topic_id}`.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Real-time Bidding API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/recommender__v1.json b/discovery/googleapis/recommender__v1.json index 08c38f3..0cb4138 100644 --- a/discovery/googleapis/recommender__v1.json +++ b/discovery/googleapis/recommender__v1.json
@@ -103,6 +103,786 @@ }, "protocol": "rest", "resources": { + "billingAccounts": { + "resources": { + "locations": { + "resources": { + "insightTypes": { + "resources": { + "insights": { + "methods": { + "get": { + "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", + "httpMethod": "GET", + "id": "recommender.billingAccounts.locations.insightTypes.insights.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the insight.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudRecommenderV1Insight" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.", + "httpMethod": "GET", + "id": "recommender.billingAccounts.locations.insightTypes.insights.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/insights", + "response": { + "$ref": "GoogleCloudRecommenderV1ListInsightsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markAccepted": { + "description": "Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.", + "httpMethod": "POST", + "id": "recommender.billingAccounts.locations.insightTypes.insights.markAccepted", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the insight.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markAccepted", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Insight" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "recommenders": { + "resources": { + "recommendations": { + "methods": { + "get": { + "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", + "httpMethod": "GET", + "id": "recommender.billingAccounts.locations.recommenders.recommendations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.", + "httpMethod": "GET", + "id": "recommender.billingAccounts.locations.recommenders.recommendations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/recommendations", + "response": { + "$ref": "GoogleCloudRecommenderV1ListRecommendationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markClaimed": { + "description": "Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.billingAccounts.locations.recommenders.recommendations.markClaimed", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markClaimed", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markFailed": { + "description": "Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.billingAccounts.locations.recommenders.recommendations.markFailed", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markFailed", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markSucceeded": { + "description": "Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markSucceeded", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, + "folders": { + "resources": { + "locations": { + "resources": { + "insightTypes": { + "resources": { + "insights": { + "methods": { + "get": { + "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", + "httpMethod": "GET", + "id": "recommender.folders.locations.insightTypes.insights.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the insight.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudRecommenderV1Insight" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.", + "httpMethod": "GET", + "id": "recommender.folders.locations.insightTypes.insights.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/insights", + "response": { + "$ref": "GoogleCloudRecommenderV1ListInsightsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markAccepted": { + "description": "Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.", + "httpMethod": "POST", + "id": "recommender.folders.locations.insightTypes.insights.markAccepted", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the insight.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markAccepted", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Insight" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "recommenders": { + "resources": { + "recommendations": { + "methods": { + "get": { + "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", + "httpMethod": "GET", + "id": "recommender.folders.locations.recommenders.recommendations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.", + "httpMethod": "GET", + "id": "recommender.folders.locations.recommenders.recommendations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/recommendations", + "response": { + "$ref": "GoogleCloudRecommenderV1ListRecommendationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markClaimed": { + "description": "Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.folders.locations.recommenders.recommendations.markClaimed", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markClaimed", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markFailed": { + "description": "Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.folders.locations.recommenders.recommendations.markFailed", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markFailed", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markSucceeded": { + "description": "Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.folders.locations.recommenders.recommendations.markSucceeded", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markSucceeded", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, + "organizations": { + "resources": { + "locations": { + "resources": { + "insightTypes": { + "resources": { + "insights": { + "methods": { + "get": { + "description": "Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.", + "httpMethod": "GET", + "id": "recommender.organizations.locations.insightTypes.insights.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the insight.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudRecommenderV1Insight" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.", + "httpMethod": "GET", + "id": "recommender.organizations.locations.insightTypes.insights.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:\"DISMISSED\" or state:\"ACTIVE\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.)", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/insights", + "response": { + "$ref": "GoogleCloudRecommenderV1ListInsightsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markAccepted": { + "description": "Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.", + "httpMethod": "POST", + "id": "recommender.organizations.locations.insightTypes.insights.markAccepted", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the insight.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/insightTypes/[^/]+/insights/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markAccepted", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkInsightAcceptedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Insight" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "recommenders": { + "resources": { + "recommendations": { + "methods": { + "get": { + "description": "Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.", + "httpMethod": "GET", + "id": "recommender.organizations.locations.recommenders.recommendations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.", + "httpMethod": "GET", + "id": "recommender.organizations.locations.recommenders.recommendations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:\"DISMISSED\" or state_info.state:\"FAILED\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The container resource on which to execute the request. Acceptable formats: 1. \"projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]\", LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/recommendations", + "response": { + "$ref": "GoogleCloudRecommenderV1ListRecommendationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markClaimed": { + "description": "Marks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation themselves. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.organizations.locations.recommenders.recommendations.markClaimed", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markClaimed", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationClaimedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markFailed": { + "description": "Marks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation failed. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.organizations.locations.recommenders.recommendations.markFailed", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markFailed", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationFailedRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "markSucceeded": { + "description": "Marks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves, and the operation was successful. This stops the recommendation content from being updated. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.", + "httpMethod": "POST", + "id": "recommender.organizations.locations.recommenders.recommendations.markSucceeded", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the recommendation.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/recommenders/[^/]+/recommendations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:markSucceeded", + "request": { + "$ref": "GoogleCloudRecommenderV1MarkRecommendationSucceededRequest" + }, + "response": { + "$ref": "GoogleCloudRecommenderV1Recommendation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, "projects": { "resources": { "locations": { @@ -364,7 +1144,7 @@ } } }, - "revision": "20201003", + "revision": "20210131", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { @@ -654,7 +1434,7 @@ "additionalProperties": { "type": "any" }, - "description": "Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { \"/versions/*/name\" : \"it-123\" \"/versions/*/targetSize/percent\": 20 } * Example: { \"/bindings/*/role\": \"roles/admin\" \"/bindings/*/condition\" : null } * Example: { \"/bindings/*/role\": \"roles/admin\" \"/bindings/*/members/*\" : [\"x@google.com\", \"y@google.com\"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.", + "description": "Set of filters to apply if `path` refers to array elements or nested array elements in order to narrow down to a single unique element that is being tested/modified. This is intended to be an exact match per filter. To perform advanced matching, use path_value_matchers. * Example: { \"/versions/*/name\" : \"it-123\" \"/versions/*/targetSize/percent\": 20 } * Example: { \"/bindings/*/role\": \"roles/owner\" \"/bindings/*/condition\" : null } * Example: { \"/bindings/*/role\": \"roles/owner\" \"/bindings/*/members/*\" : [\"x@example.com\", \"y@example.com\"] } When both path_filters and path_value_matchers are set, an implicit AND must be performed.", "type": "object" }, "pathValueMatchers": { @@ -834,7 +1614,7 @@ "id": "GoogleTypeMoney", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": {
diff --git a/discovery/googleapis/redis__v1.json b/discovery/googleapis/redis__v1.json index 923fab3..efede31 100644 --- a/discovery/googleapis/redis__v1.json +++ b/discovery/googleapis/redis__v1.json
@@ -309,6 +309,30 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getAuthString": { + "description": "Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.", + "httpMethod": "GET", + "id": "redis.projects.locations.instances.getAuthString", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/authString", + "response": { + "$ref": "InstanceAuthString" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "description": "Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.", "httpMethod": "POST", @@ -554,7 +578,7 @@ } } }, - "revision": "20200928", + "revision": "20210122", "rootUrl": "https://redis.googleapis.com/", "schemas": { "Empty": { @@ -705,6 +729,10 @@ "description": "Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in location_id.", "type": "string" }, + "authEnabled": { + "description": "Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to \"true\" AUTH is enabled on the instance. Default value is \"false\" meaning AUTH is disabled.", + "type": "boolean" + }, "authorizedNetwork": { "description": "Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.", "type": "string" @@ -789,6 +817,14 @@ "description": "Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.", "type": "string" }, + "serverCaCerts": { + "description": "Output only. List of server CA certificates for the instance.", + "items": { + "$ref": "TlsCertificate" + }, + "readOnly": true, + "type": "array" + }, "state": { "description": "Output only. The current state of this instance.", "enum": [ @@ -834,6 +870,31 @@ "STANDARD_HA tier: highly available primary/replica instances" ], "type": "string" + }, + "transitEncryptionMode": { + "description": "Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.", + "enum": [ + "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED", + "SERVER_AUTHENTICATION", + "DISABLED" + ], + "enumDescriptions": [ + "Not set.", + "Client to Server traffic encryption enabled with server authentication.", + "TLS is disabled for the instance." + ], + "type": "string" + } + }, + "type": "object" + }, + "InstanceAuthString": { + "description": "Instance AUTH string details.", + "id": "InstanceAuthString", + "properties": { + "authString": { + "description": "AUTH string set on the instance.", + "type": "string" } }, "type": "object" @@ -1006,6 +1067,37 @@ }, "type": "object" }, + "TlsCertificate": { + "description": "TlsCertificate Resource", + "id": "TlsCertificate", + "properties": { + "cert": { + "description": "PEM representation.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "expireTime": { + "description": "Output only. The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "serialNumber": { + "description": "Serial number, as extracted from the certificate.", + "type": "string" + }, + "sha1Fingerprint": { + "description": "Sha1 Fingerprint of the certificate.", + "type": "string" + } + }, + "type": "object" + }, "UpgradeInstanceRequest": { "description": "Request for UpgradeInstance.", "id": "UpgradeInstanceRequest",
diff --git a/discovery/googleapis/remotebuildexecution__v2.json b/discovery/googleapis/remotebuildexecution__v2.json index 5c14c25..9bd3856 100644 --- a/discovery/googleapis/remotebuildexecution__v2.json +++ b/discovery/googleapis/remotebuildexecution__v2.json
@@ -436,7 +436,7 @@ } } }, - "revision": "20201006", + "revision": "20210202", "rootUrl": "https://remotebuildexecution.googleapis.com/", "schemas": { "BuildBazelRemoteExecutionV2Action": { @@ -1428,6 +1428,11 @@ "description": "CommandDuration contains the various duration metrics tracked when a bot performs a command.", "id": "GoogleDevtoolsRemotebuildbotCommandDurations", "properties": { + "cmWaitForAssignment": { + "description": "The time spent waiting for Container Manager to assign an asynchronous container for execution.", + "format": "google-duration", + "type": "string" + }, "dockerPrep": { "description": "The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary).", "format": "google-duration", @@ -1512,6 +1517,10 @@ "description": "The number of warnings reported.", "format": "uint64", "type": "string" + }, + "usedAsyncContainer": { + "description": "Indicates whether an asynchronous container was used for execution.", + "type": "boolean" } }, "type": "object" @@ -1560,7 +1569,9 @@ "DOCKER_CREATE_RUNTIME_FILE_NOT_FOUND", "DOCKER_CREATE_RUNTIME_PERMISSION_DENIED", "DOCKER_CREATE_PROCESS_FILE_NOT_FOUND", - "DOCKER_CREATE_COMPUTE_SYSTEM_INCORRECT_PARAMETER_ERROR" + "DOCKER_CREATE_COMPUTE_SYSTEM_INCORRECT_PARAMETER_ERROR", + "DOCKER_TOO_MANY_SYMBOLIC_LINK_LEVELS", + "LOCAL_CONTAINER_MANAGER_NOT_RUNNING" ], "enumDescriptions": [ "The command succeeded.", @@ -1600,7 +1611,9 @@ "Docker failed to create OCI runtime because of file not found.", "Docker failed to create OCI runtime because of permission denied.", "Docker failed to create process because of file not found.", - "Docker failed to run containers with CreateComputeSystem error that involves an incorrect parameter (more specific version of DOCKER_CREATE_COMPUTE_SYSTEM_ERROR that is user-caused)." + "Docker failed to run containers with CreateComputeSystem error that involves an incorrect parameter (more specific version of DOCKER_CREATE_COMPUTE_SYSTEM_ERROR that is user-caused).", + "Docker failed to create an overlay mount because of too many levels of symbolic links.", + "The local Container Manager is not running." ], "type": "string" }, @@ -1906,7 +1919,7 @@ "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest", "properties": { "filter": { - "description": "Optional. A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. String values are case-insensitive. The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. You can also filter on nested fields. To filter on multiple expressions, you can separate expression using `AND` and `OR` operators, using parentheses to specify precedence. If neither operator is specified, `AND` is assumed. Examples: Include only pools with more than 100 reserved workers: `(worker_count > 100) (worker_config.reserved = true)` Include only pools with a certain label or machines of the n1-standard family: `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard`", + "description": "Optional. A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. String values are case-insensitive. The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. You can also filter on nested fields. To filter on multiple expressions, you can separate expression using `AND` and `OR` operators, using parentheses to specify precedence. If neither operator is specified, `AND` is assumed. Examples: Include only pools with more than 100 reserved workers: `(worker_count > 100) (worker_config.reserved = true)` Include only pools with a certain label or machines of the e2-standard family: `worker_config.labels.key1 : * OR worker_config.machine_type: e2-standard`", "type": "string" }, "parent": { @@ -1929,21 +1942,6 @@ }, "type": "object" }, - "GoogleDevtoolsRemotebuildexecutionAdminV1alphaSoleTenancyConfig": { - "description": "SoleTenancyConfig specifies information required to host a pool on STNs.", - "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaSoleTenancyConfig", - "properties": { - "nodeType": { - "description": "The sole-tenant node type to host the pool's workers on.", - "type": "string" - }, - "nodesZone": { - "description": "Zone in which STNs are reserved.", - "type": "string" - } - }, - "type": "object" - }, "GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest": { "description": "The request used for `UpdateInstance`.", "id": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest", @@ -2009,7 +2007,7 @@ "type": "object" }, "machineType": { - "description": "Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported.", + "description": "Required. Machine type of the worker, such as `e2-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported.", "type": "string" }, "maxConcurrentActions": { @@ -2029,9 +2027,9 @@ "description": "Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details.", "type": "boolean" }, - "soleTenancy": { - "$ref": "GoogleDevtoolsRemotebuildexecutionAdminV1alphaSoleTenancyConfig", - "description": "Sole-tenant node information for pools hosted on STNs." + "soleTenantNodeType": { + "description": "The node type name to be used for sole-tenant nodes.", + "type": "string" }, "vmImage": { "description": "The name of the image used by each VM.",
diff --git a/discovery/googleapis/reseller__v1.json b/discovery/googleapis/reseller__v1.json index 4017bd1..6430df9 100644 --- a/discovery/googleapis/reseller__v1.json +++ b/discovery/googleapis/reseller__v1.json
@@ -11,38 +11,62 @@ } } }, - "basePath": "/apps/reseller/v1/", - "baseUrl": "https://www.googleapis.com/apps/reseller/v1/", - "batchPath": "batch/reseller/v1", - "description": "Creates and manages your customers and their subscriptions.", + "basePath": "", + "baseUrl": "https://reseller.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Reseller", + "description": "Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/google-apps/reseller/", - "etag": "\"-2NioU2H8y8siEzrBOV_qzRI6kQ/4xq0Bw2LuAbeJZTw0U29AruL5y4\"", "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "id": "reseller:v1", "kind": "discovery#restDescription", - "labels": [ - "limited_availability" - ], "name": "reseller", "ownerDomain": "google.com", "ownerName": "Google", "parameters": { - "alt": { - "default": "json", - "description": "Data format for the response.", + "$.xgafv": { + "description": "V1 error format.", "enum": [ - "json" + "1", + "2" ], "enumDescriptions": [ - "Responses with Content-Type of application/json" + "v1 error format", + "v2 error format" ], "location": "query", "type": "string" }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", @@ -65,12 +89,17 @@ "type": "boolean" }, "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", + "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", "type": "string" }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } @@ -94,7 +123,7 @@ "type": "string" } }, - "path": "customers/{customerId}", + "path": "apps/reseller/v1/customers/{customerId}", "response": { "$ref": "Customer" }, @@ -107,6 +136,7 @@ "description": "Order a new customer's account.", "httpMethod": "POST", "id": "reseller.customers.insert", + "parameterOrder": [], "parameters": { "customerAuthToken": { "description": "The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.", @@ -114,7 +144,7 @@ "type": "string" } }, - "path": "customers", + "path": "apps/reseller/v1/customers", "request": { "$ref": "Customer" }, @@ -126,7 +156,7 @@ ] }, "patch": { - "description": "Update a customer account's settings. This method supports patch semantics.", + "description": "Patch a customer account's settings via Apiary Patch Orchestration", "httpMethod": "PATCH", "id": "reseller.customers.patch", "parameterOrder": [ @@ -140,7 +170,7 @@ "type": "string" } }, - "path": "customers/{customerId}", + "path": "apps/reseller/v1/customers/{customerId}", "request": { "$ref": "Customer" }, @@ -166,7 +196,7 @@ "type": "string" } }, - "path": "customers/{customerId}", + "path": "apps/reseller/v1/customers/{customerId}", "request": { "$ref": "Customer" }, @@ -185,7 +215,9 @@ "description": "Returns all the details of the watch corresponding to the reseller.", "httpMethod": "GET", "id": "reseller.resellernotify.getwatchdetails", - "path": "resellernotify/getwatchdetails", + "parameterOrder": [], + "parameters": {}, + "path": "apps/reseller/v1/resellernotify/getwatchdetails", "response": { "$ref": "ResellernotifyGetwatchdetailsResponse" }, @@ -198,6 +230,7 @@ "description": "Registers a Reseller for receiving notifications.", "httpMethod": "POST", "id": "reseller.resellernotify.register", + "parameterOrder": [], "parameters": { "serviceAccountEmailAddress": { "description": "The service account which will own the created Cloud-PubSub topic.", @@ -205,7 +238,7 @@ "type": "string" } }, - "path": "resellernotify/register", + "path": "apps/reseller/v1/resellernotify/register", "response": { "$ref": "ResellernotifyResource" }, @@ -217,6 +250,7 @@ "description": "Unregisters a Reseller for receiving notifications.", "httpMethod": "POST", "id": "reseller.resellernotify.unregister", + "parameterOrder": [], "parameters": { "serviceAccountEmailAddress": { "description": "The service account which owns the Cloud-PubSub topic.", @@ -224,7 +258,7 @@ "type": "string" } }, - "path": "resellernotify/unregister", + "path": "apps/reseller/v1/resellernotify/unregister", "response": { "$ref": "ResellernotifyResource" }, @@ -258,7 +292,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}/activate", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/activate", "response": { "$ref": "Subscription" }, @@ -288,7 +322,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}/changePlan", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan", "request": { "$ref": "ChangePlanRequest" }, @@ -321,7 +355,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeRenewalSettings", "request": { "$ref": "RenewalSettings" }, @@ -354,7 +388,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}/changeSeats", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changeSeats", "request": { "$ref": "Seats" }, @@ -384,12 +418,14 @@ "deletionType": { "description": "The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.", "enum": [ + "deletion_type_undefined", "cancel", "transfer_to_direct" ], "enumDescriptions": [ + "", "Cancels the subscription immediately. This does not apply to a G Suite subscription.", - "Transfers a subscription directly to Google. The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller." + "Transfers a subscription directly to Google. The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller." ], "location": "query", "required": true, @@ -402,7 +438,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}", "scopes": [ "https://www.googleapis.com/auth/apps.order" ] @@ -429,7 +465,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}", "response": { "$ref": "Subscription" }, @@ -458,7 +494,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions", "request": { "$ref": "Subscription" }, @@ -473,6 +509,7 @@ "description": "List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions.", "httpMethod": "GET", "id": "reseller.subscriptions.list", + "parameterOrder": [], "parameters": { "customerAuthToken": { "description": "The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.", @@ -485,7 +522,7 @@ "type": "string" }, "customerNamePrefix": { - "description": "When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: \n- exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. \n- example -- Returns example20.com and example.com.", + "description": "When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com. ", "location": "query", "type": "string" }, @@ -503,7 +540,7 @@ "type": "string" } }, - "path": "subscriptions", + "path": "apps/reseller/v1/subscriptions", "response": { "$ref": "Subscriptions" }, @@ -534,7 +571,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}/startPaidService", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/startPaidService", "response": { "$ref": "Subscription" }, @@ -564,7 +601,7 @@ "type": "string" } }, - "path": "customers/{customerId}/subscriptions/{subscriptionId}/suspend", + "path": "apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend", "response": { "$ref": "Subscription" }, @@ -575,8 +612,8 @@ } } }, - "revision": "20191008", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210202", + "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { "description": "JSON template for address of a customer.", @@ -640,7 +677,7 @@ "type": "string" }, "planName": { - "description": "The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts.\n\nPossible values are: \n- ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. \n- ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments \n- FLEXIBLE - The flexible plan \n- TRIAL - The 30-day free trial plan", + "description": "The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan ", "type": "string" }, "purchaseOrderId": { @@ -659,7 +696,7 @@ "id": "Customer", "properties": { "alternateEmail": { - "description": "Like the \"Customer email\" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.", + "description": "Like the \"Customer email\" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain .", "type": "string" }, "customerDomain": { @@ -754,12 +791,12 @@ "type": "integer" }, "maximumNumberOfSeats": { - "description": "This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. Note: G Suite subscriptions automatically assign a license to every user.", + "description": "This is a required property and is exclusive to subscriptions with FLEXIBLE or TRIAL plans. This property sets the maximum number of licensed users allowed on a subscription. This quantity can be increased up to the maximum limit defined in the reseller's contract. The minimum quantity is the current number of users in the customer account. *Note: *G Suite subscriptions automatically assign a license to every user.", "format": "int32", "type": "integer" }, "numberOfSeats": { - "description": "This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. Note: G Suite subscriptions automatically assign a license to every user.", + "description": "This is a required property and is exclusive to subscriptions with ANNUAL_MONTHLY_PAY and ANNUAL_YEARLY_PAY plans. This property sets the maximum number of licenses assignable to users on a subscription. The reseller can add more licenses, but once set, the numberOfSeats cannot be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are assigned. *Note: *G Suite subscriptions automatically assign a license to every user.", "format": "int32", "type": "integer" } @@ -800,7 +837,7 @@ "description": "The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API\"s payment plans, see the API concepts.", "properties": { "commitmentInterval": { - "description": "In this version of the API, annual commitment plan's interval is one year. Note: When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses.", + "description": "In this version of the API, annual commitment plan's interval is one year. *Note: *When billingMethod value is OFFLINE, the subscription property object plan.commitmentInterval is omitted in all API responses. ", "properties": { "endTime": { "description": "An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.", @@ -816,11 +853,11 @@ "type": "object" }, "isCommitmentPlan": { - "description": "The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan:\n- true — The subscription's plan is an annual commitment plan.\n- false — The plan is not an annual commitment plan.", + "description": "The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan: - true — The subscription's plan is an annual commitment plan. - false — The plan is not an annual commitment plan. ", "type": "boolean" }, "planName": { - "description": "The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts.\n\nPossible values are: \n- ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. Caution: ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. \n- ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments \n- FLEXIBLE — The flexible plan \n- TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService. \n- FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.", + "description": "The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts. Possible values are: - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments. *Caution: *ANNUAL_MONTHLY_PAY is returned as ANNUAL in all API responses. - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments - FLEXIBLE — The flexible plan - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService. - FREE — The free plan is exclusive to the Cloud Identity SKU and does not incur any billing. ", "type": "string" } }, @@ -843,11 +880,11 @@ "description": "This is a required property. The number and limit of user seat licenses in the plan." }, "skuId": { - "description": "A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.", + "description": "A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.", "type": "string" }, "skuName": { - "description": "Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.", + "description": "Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.", "type": "string" }, "status": { @@ -859,7 +896,7 @@ "type": "string" }, "suspensionReasons": { - "description": "Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed.\n\nPossible options include: \n- PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. \n- RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. \n- RESELLER_INITIATED - A manual suspension invoked by a Reseller. \n- TRIAL_ENDED - The customer's trial expired without a plan selected. \n- OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).", + "description": "Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. - RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED - The customer's trial expired without a plan selected. - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise). ", "items": { "type": "string" }, @@ -885,7 +922,7 @@ "description": "The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.", "properties": { "isInTrial": { - "description": "Determines if a subscription's plan is in a 30-day free trial or not:\n- true — The plan is in trial.\n- false — The plan is not in trial.", + "description": "Determines if a subscription's plan is in a 30-day free trial or not: - true — The plan is in trial. - false — The plan is not in trial. ", "type": "boolean" }, "trialEndTime": { @@ -923,7 +960,7 @@ "type": "object" } }, - "servicePath": "apps/reseller/v1/", - "title": "Enterprise Apps Reseller API", + "servicePath": "", + "title": "Google Workspace Reseller API", "version": "v1" } \ No newline at end of file
diff --git a/discovery/googleapis/retail__v2.json b/discovery/googleapis/retail__v2.json new file mode 100644 index 0000000..d32246d --- /dev/null +++ b/discovery/googleapis/retail__v2.json
@@ -0,0 +1,2297 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://retail.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Retail", + "description": "Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/recommendations", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "retail:v2", + "kind": "discovery#restDescription", + "name": "retail", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "catalogs": { + "methods": { + "list": { + "description": "Lists all the Catalogs associated with the project.", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/catalogs", + "response": { + "$ref": "GoogleCloudRetailV2ListCatalogsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the Catalogs.", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Immutable. The fully qualified resource name of the catalog.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided Catalog to update. If not set, will only update the Catalog.product_level_config field, which is also the only currently supported field to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudRetailV2Catalog" + }, + "response": { + "$ref": "GoogleCloudRetailV2Catalog" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "branches": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.branches.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "products": { + "methods": { + "create": { + "description": "Creates a Product.", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.branches.products.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + }, + "productId": { + "description": "Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/products", + "request": { + "$ref": "GoogleCloudRetailV2Product" + }, + "response": { + "$ref": "GoogleCloudRetailV2Product" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Product.", + "httpMethod": "DELETE", + "id": "retail.projects.locations.catalogs.branches.products.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Product.", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.branches.products.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudRetailV2Product" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of multiple Products. Request processing may be synchronous. No partial updating is supported. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated.", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.branches.products.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/products:import", + "request": { + "$ref": "GoogleCloudRetailV2ImportProductsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Product.", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.branches.products.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the Product is not found, a new Product will be created. In this situation, `update_mask` is ignored.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. The branch ID must be \"default_branch\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+/products/.*$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "GoogleCloudRetailV2Product" + }, + "response": { + "$ref": "GoogleCloudRetailV2Product" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "placements": { + "methods": { + "predict": { + "description": "Makes a recommendation prediction.", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.placements.predict", + "parameterOrder": [ + "placement" + ], + "parameters": { + "placement": { + "description": "Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/placements/*} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts products frequently bought together with one or more products in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More products like this. * `recently_viewed_default`: Returns up to 75 products recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any products yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+placement}:predict", + "request": { + "$ref": "GoogleCloudRetailV2PredictRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "userEvents": { + "methods": { + "collect": { + "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.userEvents.collect", + "parameterOrder": [ + "parent" + ], + "parameters": { + "ets": { + "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "uri": { + "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + "location": "query", + "type": "string" + }, + "userEvent": { + "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+parent}/userEvents:collect", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. `projects/1234/locations/global/catalogs/default_catalog`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/userEvents:import", + "request": { + "$ref": "GoogleCloudRetailV2ImportUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/catalogs/${catalogId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudRetailV2PurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rejoin": { + "description": "Triggers a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of product catalog. It can also be used to correct events joined with wrong product catalog.", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.rejoin", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/userEvents:rejoin", + "request": { + "$ref": "GoogleCloudRetailV2RejoinUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Writes a single user event.", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.write", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent catalog resource name, such as `projects/1234/locations/global/catalogs/default_catalog`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/userEvents:write", + "request": { + "$ref": "GoogleCloudRetailV2UserEvent" + }, + "response": { + "$ref": "GoogleCloudRetailV2UserEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "retail.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "retail.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210126", + "rootUrl": "https://retail.googleapis.com/", + "schemas": { + "GoogleApiHttpBody": { + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", + "id": "GoogleApiHttpBody", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailLoggingErrorContext": { + "description": "A description of the context in which an error occurred.", + "id": "GoogleCloudRetailLoggingErrorContext", + "properties": { + "httpRequest": { + "$ref": "GoogleCloudRetailLoggingHttpRequestContext", + "description": "The HTTP request which was processed when the error was triggered." + }, + "reportLocation": { + "$ref": "GoogleCloudRetailLoggingSourceLocation", + "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + } + }, + "type": "object" + }, + "GoogleCloudRetailLoggingErrorLog": { + "description": "An error log which is reported to the Error Reporting system. This proto a superset of google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.", + "id": "GoogleCloudRetailLoggingErrorLog", + "properties": { + "context": { + "$ref": "GoogleCloudRetailLoggingErrorContext", + "description": "A description of the context in which the error occurred." + }, + "importPayload": { + "$ref": "GoogleCloudRetailLoggingImportErrorContext", + "description": "The error payload that is populated on LRO import APIs." + }, + "message": { + "description": "A message describing the error.", + "type": "string" + }, + "requestPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API request payload, represented as a protocol buffer. Most API request types are supported. For example: \"type.googleapis.com/google.cloud.retail.v2.ProductService.CreateProductRequest\" \"type.googleapis.com/google.cloud.retail.v2.UserEventService.WriteUserEventRequest\"", + "type": "object" + }, + "responsePayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported and no PII is included: \"google.cloud.retail.v2.PredictionService.Predict\" \"google.cloud.retail.v2.UserEventService.WriteUserEvent\" \"google.cloud.retail.v2.UserEventService.CollectUserEvent\"", + "type": "object" + }, + "serviceContext": { + "$ref": "GoogleCloudRetailLoggingServiceContext", + "description": "The service context in which this error has occurred." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The RPC status associated with the error log." + } + }, + "type": "object" + }, + "GoogleCloudRetailLoggingHttpRequestContext": { + "description": "HTTP request data that is related to a reported error.", + "id": "GoogleCloudRetailLoggingHttpRequestContext", + "properties": { + "responseStatusCode": { + "description": "The HTTP response status code for the request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudRetailLoggingImportErrorContext": { + "description": "The error payload that is populated on LRO import APIs. Including: \"google.cloud.retail.v2.ProductService.ImportProducts\" \"google.cloud.retail.v2.EventService.ImportUserEvents\"", + "id": "GoogleCloudRetailLoggingImportErrorContext", + "properties": { + "catalogItem": { + "description": "The detailed content which caused the error on importing a catalog item.", + "type": "string" + }, + "gcsPath": { + "description": "GCS file path of the import source. Can be set for batch operation error.", + "type": "string" + }, + "lineNumber": { + "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "type": "string" + }, + "operationName": { + "description": "The operation resource name of the LRO.", + "type": "string" + }, + "product": { + "description": "The detailed content which caused the error on importing a product.", + "type": "string" + }, + "userEvent": { + "description": "The detailed content which caused the error on importing a user event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailLoggingServiceContext": { + "description": "Describes a running service that sends errors.", + "id": "GoogleCloudRetailLoggingServiceContext", + "properties": { + "service": { + "description": "An identifier of the service. For example, \"retail.googleapis.com\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailLoggingSourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are reported.", + "id": "GoogleCloudRetailLoggingSourceLocation", + "properties": { + "functionName": { + "description": "Human-readable name of a function or method. For example, \"google.cloud.retail.v2.UserEventService.ImportUserEvents\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2BigQuerySource": { + "description": "BigQuery source import data from.", + "id": "GoogleCloudRetailV2BigQuerySource", + "properties": { + "dataSchema": { + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", + "type": "string" + }, + "datasetId": { + "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.", + "type": "string" + }, + "projectId": { + "description": "The project id (can be project # or id) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project id from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2Catalog": { + "description": "The catalog configuration.", + "id": "GoogleCloudRetailV2Catalog", + "properties": { + "displayName": { + "description": "Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "name": { + "description": "Required. Immutable. The fully qualified resource name of the catalog.", + "type": "string" + }, + "productLevelConfig": { + "$ref": "GoogleCloudRetailV2ProductLevelConfig", + "description": "Required. The product level configuration." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2CustomAttribute": { + "description": "A custom attribute that is not explicitly modeled in Product.", + "id": "GoogleCloudRetailV2CustomAttribute", + "properties": { + "numbers": { + "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "text": { + "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". At most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2GcsSource": { + "description": "Google Cloud Storage location for input content. format.", + "id": "GoogleCloudRetailV2GcsSource", + "properties": { + "dataSchema": { + "description": "The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mcc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: Using https://support.google.com/analytics/answer/3437719?hl=en.", + "type": "string" + }, + "inputUris": { + "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing product information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2Image": { + "description": "Product thumbnail/detail image.", + "id": "GoogleCloudRetailV2Image", + "properties": { + "height": { + "description": "Height of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "Required. URI of the image. This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).", + "type": "string" + }, + "width": { + "description": "Width of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ImportErrorsConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudRetailV2ImportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Import errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ImportMetadata": { + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2ImportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ImportProductsRequest": { + "description": "Request message for Import methods.", + "id": "GoogleCloudRetailV2ImportProductsRequest", + "properties": { + "errorsConfig": { + "$ref": "GoogleCloudRetailV2ImportErrorsConfig", + "description": "The desired location of errors incurred during the Import." + }, + "inputConfig": { + "$ref": "GoogleCloudRetailV2ProductInputConfig", + "description": "Required. The desired input location of the data." + }, + "updateMask": { + "description": "Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ImportProductsResponse": { + "description": "Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2ImportProductsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2ImportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ImportUserEventsRequest": { + "description": "Request message for the ImportUserEvents request.", + "id": "GoogleCloudRetailV2ImportUserEventsRequest", + "properties": { + "errorsConfig": { + "$ref": "GoogleCloudRetailV2ImportErrorsConfig", + "description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports." + }, + "inputConfig": { + "$ref": "GoogleCloudRetailV2UserEventInputConfig", + "description": "Required. The desired input location of the data." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2ImportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2ImportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "importSummary": { + "$ref": "GoogleCloudRetailV2UserEventImportSummary", + "description": "Aggregated statistics of user event import status." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ListCatalogsResponse": { + "description": "Response for CatalogService.ListCatalogs method.", + "id": "GoogleCloudRetailV2ListCatalogsResponse", + "properties": { + "catalogs": { + "description": "All the customer's Catalogs.", + "items": { + "$ref": "GoogleCloudRetailV2Catalog" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListCatalogsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2PredictRequest": { + "description": "Request message for Predict method.", + "id": "GoogleCloudRetailV2PredictRequest", + "properties": { + "filter": { + "description": "Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-\"tagA\"` is also supported and is equivalent to `NOT \"tagA\"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000 characters. * filterOutOfStockItems. Restricts predictions to products that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") * filterOutOfStockItems tag=(-\"promotional\") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular products to be returned instead, set `strictFiltering` to false in `PredictRequest.params`.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.", + "type": "object" + }, + "pageSize": { + "description": "Maximum number of results to return per page. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "The previous PredictResponse.next_page_token.", + "type": "string" + }, + "params": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional domain specific parameters for the predictions. Allowed values: * `returnProduct`: Boolean. If set to true, the associated product object will be returned in the `results.metadata` field in the prediction response. * `returnScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the `results.metadata` field in the prediction response. The given 'score' indicates the probability of an product being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results.", + "type": "object" + }, + "userEvent": { + "$ref": "GoogleCloudRetailV2UserEvent", + "description": "Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging." + }, + "validateOnly": { + "description": "Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2PredictResponse": { + "description": "Response message for predict method.", + "id": "GoogleCloudRetailV2PredictResponse", + "properties": { + "attributionToken": { + "description": "A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.", + "type": "string" + }, + "missingIds": { + "description": "IDs of products in the request that were missing from the inventory.", + "items": { + "type": "string" + }, + "type": "array" + }, + "results": { + "description": "A list of recommended products. The order represents the ranking (from the most relevant product to the least).", + "items": { + "$ref": "GoogleCloudRetailV2PredictResponsePredictionResult" + }, + "type": "array" + }, + "validateOnly": { + "description": "True if the validateOnly property was set in the request.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2PredictResponsePredictionResult": { + "description": "PredictionResult represents the recommendation prediction results.", + "id": "GoogleCloudRetailV2PredictResponsePredictionResult", + "properties": { + "id": { + "description": "ID of the recommended product", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional product metadata / annotations. Possible values: * `product`: JSON representation of the product. Will be set if `returnProduct` is set to true in `PredictRequest.params`. * `score`: Prediction score in double value. Will be set if `returnScore` is set to true in `PredictRequest.params`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2PriceInfo": { + "description": "The price information of a Product.", + "id": "GoogleCloudRetailV2PriceInfo", + "properties": { + "cost": { + "description": "The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).", + "format": "float", + "type": "number" + }, + "currencyCode": { + "description": "The 3-letter currency code defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html). If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "originalPrice": { + "description": "Price of the product without any discount. If zero, by default set to be the price.", + "format": "float", + "type": "number" + }, + "price": { + "description": "Price of the product. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371). Schema.org property [Offer.priceSpecification](https://schema.org/priceSpecification).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2Product": { + "description": "Product captures all metadata information of items to be recommended or searched.", + "id": "GoogleCloudRetailV2Product", + "properties": { + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudRetailV2CustomAttribute" + }, + "description": "Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ \"vendor\": {\"text\": [\"vendor123\", \"vendor456\"]}, \"lengths_cm\": {\"numbers\":[2.3, 15.4]}, \"heights_cm\": {\"numbers\":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 150 by default; 100 for Type.VARIANT. * Max indexable entries count: 150 by default; 40 for Type.VARIANT. * Max searchable entries count: 30. * The key must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "object" + }, + "availability": { + "description": "The online availability of the Product. Default to Availability.IN_STOCK. Google Merchant Center Property [availability](https://support.google.com/merchants/answer/6324448). Schema.org Property [Offer.availability](https://schema.org/availability).", + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "IN_STOCK", + "OUT_OF_STOCK", + "PREORDER", + "BACKORDER" + ], + "enumDescriptions": [ + "Default product availability. Default to Availability.IN_STOCK if unset.", + "Product in stock.", + "Product out of stock.", + "Product that is in pre-order state.", + "Product that is back-ordered (i.e. temporarily out of stock)." + ], + "type": "string" + }, + "availableQuantity": { + "description": "The available quantity of the item.", + "format": "int32", + "type": "integer" + }, + "availableTime": { + "description": "The timestamp when this Product becomes available recommendation and search.", + "format": "google-datetime", + "type": "string" + }, + "categories": { + "description": "Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). For example, if a shoes product belongs to both [\"Shoes & Accessories\" -> \"Shoes\"] and [\"Sports & Fitness\" -> \"Athletic Clothing\" -> \"Shoes\"], it could be represented as: \"categories\": [ \"Shoes & Accessories > Shoes\", \"Sports & Fitness > Athletic Clothing > Shoes\" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property google_product_category. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [description](https://support.google.com/merchants/answer/6324468). schema.org property [Product.description](https://schema.org/description).", + "type": "string" + }, + "id": { + "description": "Immutable. Product identifier, which is the final component of name. For example, this field is \"id_1\", if name is `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [id](https://support.google.com/merchants/answer/6324405). Schema.org Property [Product.sku](https://schema.org/sku).", + "type": "string" + }, + "images": { + "description": "Product images for the product. A maximum of 300 images are allowed. Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image).", + "items": { + "$ref": "GoogleCloudRetailV2Image" + }, + "type": "array" + }, + "name": { + "description": "Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. The branch ID must be \"default_branch\".", + "type": "string" + }, + "priceInfo": { + "$ref": "GoogleCloudRetailV2PriceInfo", + "description": "Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371)." + }, + "primaryProductId": { + "description": "Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center Property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org Property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).", + "type": "string" + }, + "tags": { + "description": "Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473).", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Required. Product title. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [title](https://support.google.com/merchants/answer/6324415). Schema.org property [Product.name](https://schema.org/name).", + "type": "string" + }, + "type": { + "description": "Immutable. The type of the product. This field is output-only.", + "enum": [ + "TYPE_UNSPECIFIED", + "PRIMARY", + "VARIANT", + "COLLECTION" + ], + "enumDescriptions": [ + "Default value. Default to Type.PRIMARY if unset.", + "The primary type. As the primary unit for predicting, indexing and search serving, a Type.PRIMARY Product is grouped with multiple Type.VARIANT Products.", + "The variant type. Type.VARIANT Products usually share some common attributes on the same Type.PRIMARY Products, but they have variant attributes like different colors, sizes and prices, etc.", + "The collection type. Collection products are bundled Type.PRIMARY Products or Type.VARIANT Products that are sold together, such as a jewelry set with necklaces, earrings and rings, etc." + ], + "type": "string" + }, + "uri": { + "description": "Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ProductDetail": { + "description": "Detailed product information associated with a user event.", + "id": "GoogleCloudRetailV2ProductDetail", + "properties": { + "product": { + "$ref": "GoogleCloudRetailV2Product", + "description": "Required. Product information. Only Product.id field is used when ingesting an event, all other product fields are ignored as we will look them up from the catalog." + }, + "quantity": { + "description": "Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for `purchase-complete` event. Required for `add-to-cart` and `purchase-complete` event types.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ProductInlineSource": { + "description": "The inline source for the input config for ImportProducts method.", + "id": "GoogleCloudRetailV2ProductInlineSource", + "properties": { + "products": { + "description": "Required. A list of products to update/create. Each product must have a valid Product.id. Recommended max of 10k items.", + "items": { + "$ref": "GoogleCloudRetailV2Product" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ProductInputConfig": { + "description": "The input config source for products.", + "id": "GoogleCloudRetailV2ProductInputConfig", + "properties": { + "bigQuerySource": { + "$ref": "GoogleCloudRetailV2BigQuerySource", + "description": "BigQuery input source." + }, + "gcsSource": { + "$ref": "GoogleCloudRetailV2GcsSource", + "description": "Google Cloud Storage location for the input content." + }, + "productInlineSource": { + "$ref": "GoogleCloudRetailV2ProductInlineSource", + "description": "The Inline source for the input content for products." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ProductLevelConfig": { + "description": "Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.", + "id": "GoogleCloudRetailV2ProductLevelConfig", + "properties": { + "ingestionProductType": { + "description": "The type of Products allowed to be ingested into the catalog. Acceptable values are: * `primary` (default): You can only ingest Product.Type.PRIMARY Products. This means Product.primary_product_id can only be empty or set to the same value as Product.id. * `variant`: You can only ingest Product.Type.VARIANT Products. This means Product.primary_product_id cannot be empty. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `variant` and merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error is returned. See [Using catalog levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more details.", + "type": "string" + }, + "merchantCenterProductIdField": { + "description": "Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as Product.id. Acceptable values are: * `offerId` (default): Import `offerId` as the product ID. * `itemGroupId`: Import `itemGroupId` as the product ID. Notice that Retail API will choose one item from the ones with the same `itemGroupId`, and use it to represent the item group. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `itemGroupId` and ingestion_product_type is `variant`, an INVALID_ARGUMENT error is returned. See [Using catalog levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more details.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2PurchaseTransaction": { + "description": "A transaction represents the entire purchase transaction.", + "id": "GoogleCloudRetailV2PurchaseTransaction", + "properties": { + "cost": { + "description": "All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = revenue - tax - cost", + "format": "float", + "type": "number" + }, + "currencyCode": { + "description": "Required. Currency code. Use three-character ISO-4217 code.", + "type": "string" + }, + "id": { + "description": "The transaction ID with a length limit of 128 characters.", + "type": "string" + }, + "revenue": { + "description": "Required. Total non-zero revenue or grand total associated with the transaction. This value include shipping, tax, or other adjustments to total revenue that you want to include as part of your revenue calculations.", + "format": "float", + "type": "number" + }, + "tax": { + "description": "All the taxes associated with the transaction.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2PurgeMetadata": { + "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2PurgeMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2PurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudRetailV2PurgeUserEventsRequest", + "properties": { + "filter": { + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. Empty string filter is not allowed. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `visitorId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` * Deleting all events for a specific visitor: `visitorId = \"visitor1024\"` The filtering fields are assumed to have an implicit AND.", + "type": "string" + }, + "force": { + "description": "Actually perform the purge. If `force` is set to false, the method will return the expected purge count without deleting any user events.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2PurgeUserEventsResponse": { + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudRetailV2PurgeUserEventsResponse", + "properties": { + "purgedEventsCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2RejoinUserEventsMetadata": { + "description": "Metadata for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2RejoinUserEventsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2RejoinUserEventsRequest": { + "description": "Request message for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2RejoinUserEventsRequest", + "properties": { + "userEventRejoinScope": { + "description": "The type of the user event rejoin to define the scope and range of the user events to be rejoined with the latest product catalog. Defaults to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an invalid integer value.", + "enum": [ + "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED", + "JOINED_EVENTS", + "UNJOINED_EVENTS" + ], + "enumDescriptions": [ + "Rejoin all events with the latest product catalog, including both joined events and unjoined events.", + "Only rejoin joined events with the latest product catalog.", + "Only rejoin unjoined events with the latest product catalog." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2RejoinUserEventsResponse": { + "description": "Response message for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2RejoinUserEventsResponse", + "properties": { + "rejoinedUserEventsCount": { + "description": "Number of user events that were joined with latest product catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2UserEvent": { + "description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.", + "id": "GoogleCloudRetailV2UserEvent", + "properties": { + "attributes": { + "additionalProperties": { + "$ref": "GoogleCloudRetailV2CustomAttribute" + }, + "description": "Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc.", + "type": "object" + }, + "attributionToken": { + "description": "Highly recommended for user events that are the result of PredictionService.Predict. This field enables accurate attribution of recommendation model performance. The value must be a valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field.", + "type": "string" + }, + "cartId": { + "description": "The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`, `purchase-complete`, or `shopping-cart-page-view` events.", + "type": "string" + }, + "eventTime": { + "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", + "format": "google-datetime", + "type": "string" + }, + "eventType": { + "description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.", + "type": "string" + }, + "experimentIds": { + "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models).", + "items": { + "type": "string" + }, + "type": "array" + }, + "pageCategories": { + "description": "The categories associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: \"pageCategories\" : [\"Sales > 2017 Black Friday Deals\"]. Required for `category-page-view` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pageViewId": { + "description": "A unique id of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.", + "type": "string" + }, + "productDetails": { + "description": "The main product details related to the event. This field is required for the following event types: * `add-to-cart` * `detail-page-view` * `purchase-complete` In a `search` event, this field represents the products returned to the end user on the current page (the end user may have not finished broswing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different product_details is desired. The end user may have not finished broswing the whole page yet.", + "items": { + "$ref": "GoogleCloudRetailV2ProductDetail" + }, + "type": "array" + }, + "purchaseTransaction": { + "$ref": "GoogleCloudRetailV2PurchaseTransaction", + "description": "A transaction represents the entire purchase transaction. Required for `purchase-complete` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned." + }, + "referrerUri": { + "description": "The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.", + "type": "string" + }, + "searchQuery": { + "description": "The user's search query. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or filter is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "uri": { + "description": "Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.", + "type": "string" + }, + "userInfo": { + "$ref": "GoogleCloudRetailV2UserInfo", + "description": "User information." + }, + "visitorId": { + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2UserEventImportSummary": { + "description": "A summary of import result. The UserEventImportSummary summarizes the import status for user events.", + "id": "GoogleCloudRetailV2UserEventImportSummary", + "properties": { + "joinedEventsCount": { + "description": "Count of user events imported with complete existing catalog information.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with catalog information not found in the imported catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2UserEventInlineSource": { + "description": "The inline source for the input config for ImportUserEvents method.", + "id": "GoogleCloudRetailV2UserEventInlineSource", + "properties": { + "userEvents": { + "description": "Required. A list of user events to import. Recommended max of 10k items.", + "items": { + "$ref": "GoogleCloudRetailV2UserEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2UserEventInputConfig": { + "description": "The input config source for user events.", + "id": "GoogleCloudRetailV2UserEventInputConfig", + "properties": { + "bigQuerySource": { + "$ref": "GoogleCloudRetailV2BigQuerySource", + "description": "Required. BigQuery input source." + }, + "gcsSource": { + "$ref": "GoogleCloudRetailV2GcsSource", + "description": "Required. Google Cloud Storage location for the input content." + }, + "userEventInlineSource": { + "$ref": "GoogleCloudRetailV2UserEventInlineSource", + "description": "Required. The Inline source for the input content for UserEvents." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2UserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudRetailV2UserInfo", + "properties": { + "directUserRequest": { + "description": "True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.", + "type": "boolean" + }, + "ipAddress": { + "description": "The end user's IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. \"104.133.9.80\") or an IPv6 address (e.g. \"2001:0db8:85a3:0000:0000:8a2e:0370:7334\"). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", + "type": "string" + }, + "userAgent": { + "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", + "type": "string" + }, + "userId": { + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaExportErrorsConfig": { + "description": "Configuration of destination for Export related errors.", + "id": "GoogleCloudRetailV2alphaExportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaExportMetadata": { + "description": "Metadata related to the progress of the Export operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2alphaExportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaExportProductsResponse": { + "description": "Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2alphaExportProductsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2alphaExportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaExportUserEventsResponse": { + "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2alphaExportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2alphaExportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaImportErrorsConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudRetailV2alphaImportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Import errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaImportMetadata": { + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2alphaImportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaImportProductsResponse": { + "description": "Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2alphaImportProductsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2alphaImportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2alphaImportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2alphaImportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "importSummary": { + "$ref": "GoogleCloudRetailV2alphaUserEventImportSummary", + "description": "Aggregated statistics of user event import status." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaPurgeMetadata": { + "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2alphaPurgeMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2alphaPurgeUserEventsResponse": { + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudRetailV2alphaPurgeUserEventsResponse", + "properties": { + "purgedEventsCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaRejoinUserEventsMetadata": { + "description": "Metadata for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2alphaRejoinUserEventsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2alphaRejoinUserEventsResponse": { + "description": "Response message for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2alphaRejoinUserEventsResponse", + "properties": { + "rejoinedUserEventsCount": { + "description": "Number of user events that were joined with latest product catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaUserEventImportSummary": { + "description": "A summary of import result. The UserEventImportSummary summarizes the import status for user events.", + "id": "GoogleCloudRetailV2alphaUserEventImportSummary", + "properties": { + "joinedEventsCount": { + "description": "Count of user events imported with complete existing catalog information.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with catalog information not found in the imported catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaExportErrorsConfig": { + "description": "Configuration of destination for Export related errors.", + "id": "GoogleCloudRetailV2betaExportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaExportMetadata": { + "description": "Metadata related to the progress of the Export operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2betaExportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaExportProductsResponse": { + "description": "Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2betaExportProductsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2betaExportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaExportUserEventsResponse": { + "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2betaExportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2betaExportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaImportErrorsConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudRetailV2betaImportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Import errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaImportMetadata": { + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2betaImportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaImportProductsResponse": { + "description": "Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2betaImportProductsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2betaImportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2betaImportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2betaImportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "importSummary": { + "$ref": "GoogleCloudRetailV2betaUserEventImportSummary", + "description": "Aggregated statistics of user event import status." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaPurgeMetadata": { + "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2betaPurgeMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2betaPurgeUserEventsResponse": { + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudRetailV2betaPurgeUserEventsResponse", + "properties": { + "purgedEventsCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaRejoinUserEventsMetadata": { + "description": "Metadata for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2betaRejoinUserEventsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2betaRejoinUserEventsResponse": { + "description": "Response message for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2betaRejoinUserEventsResponse", + "properties": { + "rejoinedUserEventsCount": { + "description": "Number of user events that were joined with latest product catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaUserEventImportSummary": { + "description": "A summary of import result. The UserEventImportSummary summarizes the import status for user events.", + "id": "GoogleCloudRetailV2betaUserEventImportSummary", + "properties": { + "joinedEventsCount": { + "description": "Count of user events imported with complete existing catalog information.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with catalog information not found in the imported catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainExportErrorsConfig": { + "description": "Configuration of destination for Export related errors.", + "id": "GoogleCloudRetailV2mainExportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainExportMetadata": { + "description": "Metadata related to the progress of the Export operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2mainExportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainExportProductsResponse": { + "description": "Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2mainExportProductsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2mainExportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainExportUserEventsResponse": { + "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2mainExportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2mainExportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainImportErrorsConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudRetailV2mainImportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Import errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainImportMetadata": { + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2mainImportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainImportProductsResponse": { + "description": "Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2mainImportProductsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2mainImportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRetailV2mainImportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRetailV2mainImportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "importSummary": { + "$ref": "GoogleCloudRetailV2mainUserEventImportSummary", + "description": "Aggregated statistics of user event import status." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainPurgeMetadata": { + "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRetailV2mainPurgeMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2mainPurgeUserEventsResponse": { + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudRetailV2mainPurgeUserEventsResponse", + "properties": { + "purgedEventsCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainRejoinUserEventsMetadata": { + "description": "Metadata for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2mainRejoinUserEventsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRetailV2mainRejoinUserEventsResponse": { + "description": "Response message for RejoinUserEvents method.", + "id": "GoogleCloudRetailV2mainRejoinUserEventsResponse", + "properties": { + "rejoinedUserEventsCount": { + "description": "Number of user events that were joined with latest product catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2mainUserEventImportSummary": { + "description": "A summary of import result. The UserEventImportSummary summarizes the import status for user events.", + "id": "GoogleCloudRetailV2mainUserEventImportSummary", + "properties": { + "joinedEventsCount": { + "description": "Count of user events imported with complete existing catalog information.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with catalog information not found in the imported catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Retail API", + "version": "v2", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/run__v1.json b/discovery/googleapis/run__v1.json index 093e4be..155a716 100644 --- a/discovery/googleapis/run__v1.json +++ b/discovery/googleapis/run__v1.json
@@ -1635,7 +1635,7 @@ } } }, - "revision": "20201002", + "revision": "20210129", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -1835,7 +1835,7 @@ "properties": { "template": { "$ref": "RevisionTemplate", - "description": "Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. To set minimum instances for this revision, use the \"autoscaling.knative.dev/minScale\" annotation key. To set maximum instances for this revision, use the \"autoscaling.knative.dev/maxScale\" annotation key. To set Cloud SQL connections for the revision, use the \"run.googleapis.com/cloudsql-instances\" annotation key. To set a Serverless VPC Access connector for the revision, use the \"run.googleapis.com/vpc-access-connector\" annotation key. Values should be comma separated." + "description": "Template holds the latest specification for the Revision to be stamped out." } }, "type": "object" @@ -1976,7 +1976,7 @@ "type": "object" }, "DomainMapping": { - "description": "Resource to hold the state and status of a user's domain mapping.", + "description": "Resource to hold the state and status of a user's domain mapping. NOTE: This resource is currently in Beta.", "id": "DomainMapping", "properties": { "apiVersion": { @@ -2741,7 +2741,7 @@ "additionalProperties": { "type": "string" }, - "description": "(Optional) Cloud Run fully managed: Only memory and CPU are supported. Note: The only supported values for CPU are '1' and '2'. Cloud Run for Anthos: supported Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go", + "description": "(Optional) Cloud Run fully managed: Only memory and CPU are supported. Note: The only supported values for CPU are '1', '2', and '4'. Setting 4 CPU requires at least 2Gi of memory. Cloud Run for Anthos: supported Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go", "type": "object" }, "requests": { @@ -2852,7 +2852,7 @@ "properties": { "metadata": { "$ref": "ObjectMeta", - "description": "Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. To set minimum instances for this revision, use the \"autoscaling.knative.dev/minScale\" annotation key. To set maximum instances for this revision, use the \"autoscaling.knative.dev/maxScale\" annotation key. To set Cloud SQL connections for the revision, use the \"run.googleapis.com/cloudsql-instances\" annotation key." + "description": "Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all` and `private-ranges-only`." }, "spec": { "$ref": "RevisionSpec", @@ -3272,7 +3272,7 @@ "type": "string" }, "tag": { - "description": "Tag is optionally used to expose a dedicated url for referencing this target exclusively. Not currently supported in Cloud Run. +optional", + "description": "Tag is optionally used to expose a dedicated url for referencing this target exclusively. +optional", "type": "string" }, "url": {
diff --git a/discovery/googleapis/runtimeconfig__v1.json b/discovery/googleapis/runtimeconfig__v1.json index db4f173..a8747a2 100644 --- a/discovery/googleapis/runtimeconfig__v1.json +++ b/discovery/googleapis/runtimeconfig__v1.json
@@ -205,7 +205,7 @@ } } }, - "revision": "20201006", + "revision": "20210201", "rootUrl": "https://runtimeconfig.googleapis.com/", "schemas": { "CancelOperationRequest": {
diff --git a/discovery/googleapis/safebrowsing__v4.json b/discovery/googleapis/safebrowsing__v4.json index 0d8b28d..a901e59 100644 --- a/discovery/googleapis/safebrowsing__v4.json +++ b/discovery/googleapis/safebrowsing__v4.json
@@ -124,7 +124,7 @@ }, "path": "v4/encodedFullHashes/{encodedRequest}", "response": { - "$ref": "FindFullHashesResponse" + "$ref": "GoogleSecuritySafebrowsingV4FindFullHashesResponse" } } } @@ -159,7 +159,7 @@ }, "path": "v4/encodedUpdates/{encodedRequest}", "response": { - "$ref": "FetchThreatListUpdatesResponse" + "$ref": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse" } } } @@ -174,10 +174,10 @@ "parameters": {}, "path": "v4/fullHashes:find", "request": { - "$ref": "FindFullHashesRequest" + "$ref": "GoogleSecuritySafebrowsingV4FindFullHashesRequest" }, "response": { - "$ref": "FindFullHashesResponse" + "$ref": "GoogleSecuritySafebrowsingV4FindFullHashesResponse" } } } @@ -192,10 +192,10 @@ "parameters": {}, "path": "v4/threatHits", "request": { - "$ref": "ThreatHit" + "$ref": "GoogleSecuritySafebrowsingV4ThreatHit" }, "response": { - "$ref": "Empty" + "$ref": "GoogleProtobufEmpty" } } } @@ -210,10 +210,10 @@ "parameters": {}, "path": "v4/threatListUpdates:fetch", "request": { - "$ref": "FetchThreatListUpdatesRequest" + "$ref": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest" }, "response": { - "$ref": "FetchThreatListUpdatesResponse" + "$ref": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse" } } } @@ -228,7 +228,7 @@ "parameters": {}, "path": "v4/threatLists", "response": { - "$ref": "ListThreatListsResponse" + "$ref": "GoogleSecuritySafebrowsingV4ListThreatListsResponse" } } } @@ -243,21 +243,27 @@ "parameters": {}, "path": "v4/threatMatches:find", "request": { - "$ref": "FindThreatMatchesRequest" + "$ref": "GoogleSecuritySafebrowsingV4FindThreatMatchesRequest" }, "response": { - "$ref": "FindThreatMatchesResponse" + "$ref": "GoogleSecuritySafebrowsingV4FindThreatMatchesResponse" } } } } }, - "revision": "20201006", + "revision": "20210202", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { - "Checksum": { + "GoogleProtobufEmpty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4Checksum": { "description": "The expected state of a client's local database.", - "id": "Checksum", + "id": "GoogleSecuritySafebrowsingV4Checksum", "properties": { "sha256": { "description": "The SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database.", @@ -267,9 +273,9 @@ }, "type": "object" }, - "ClientInfo": { + "GoogleSecuritySafebrowsingV4ClientInfo": { "description": "The client metadata associated with Safe Browsing API requests.", - "id": "ClientInfo", + "id": "GoogleSecuritySafebrowsingV4ClientInfo", "properties": { "clientId": { "description": "A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.", @@ -282,191 +288,30 @@ }, "type": "object" }, - "Constraints": { - "description": "The constraints for this update.", - "id": "Constraints", - "properties": { - "deviceLocation": { - "description": "A client's physical location, expressed as a ISO 31166-1 alpha-2 region code.", - "type": "string" - }, - "language": { - "description": "Requests the lists for a specific language. Expects ISO 639 alpha-2 format.", - "type": "string" - }, - "maxDatabaseEntries": { - "description": "Sets the maximum number of entries that the client is willing to have in the local database for the specified list. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set.", - "format": "int32", - "type": "integer" - }, - "maxUpdateEntries": { - "description": "The maximum size in number of entries. The update will not contain more entries than this value. This should be a power of 2 between 2**10 and 2**20. If zero, no update size limit is set.", - "format": "int32", - "type": "integer" - }, - "region": { - "description": "Requests the list for a specific geographic location. If not set the server may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2 format.", - "type": "string" - }, - "supportedCompressions": { - "description": "The compression types supported by the client.", - "items": { - "enum": [ - "COMPRESSION_TYPE_UNSPECIFIED", - "RAW", - "RICE" - ], - "enumDescriptions": [ - "Unknown.", - "Raw, uncompressed data.", - "Rice-Golomb encoded data." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "FetchThreatListUpdatesRequest": { - "description": "Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. NOTE: Field index 2 is unused. NEXT: 5", - "id": "FetchThreatListUpdatesRequest", + "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest": { + "description": "Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. The server may not respond to all requests, if the server has no updates for that list. NOTE: Field index 2 is unused. NEXT: 5", + "id": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest", "properties": { "client": { - "$ref": "ClientInfo", + "$ref": "GoogleSecuritySafebrowsingV4ClientInfo", "description": "The client metadata." }, "listUpdateRequests": { "description": "The requested threat list updates.", "items": { - "$ref": "ListUpdateRequest" + "$ref": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest" }, "type": "array" } }, "type": "object" }, - "FetchThreatListUpdatesResponse": { - "id": "FetchThreatListUpdatesResponse", - "properties": { - "listUpdateResponses": { - "description": "The list updates requested by the clients.", - "items": { - "$ref": "ListUpdateResponse" - }, - "type": "array" - }, - "minimumWaitDuration": { - "description": "The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "FindFullHashesRequest": { - "description": "Request to return full hashes matched by the provided hash prefixes.", - "id": "FindFullHashesRequest", - "properties": { - "apiClient": { - "$ref": "ClientInfo", - "description": "Client metadata associated with callers of higher-level APIs built on top of the client's implementation." - }, - "client": { - "$ref": "ClientInfo", - "description": "The client metadata." - }, - "clientStates": { - "description": "The current client states for each of the client's local threat lists.", - "items": { - "format": "byte", - "type": "string" - }, - "type": "array" - }, - "threatInfo": { - "$ref": "ThreatInfo", - "description": "The lists and hashes to be checked." - } - }, - "type": "object" - }, - "FindFullHashesResponse": { - "id": "FindFullHashesResponse", - "properties": { - "matches": { - "description": "The full hashes that matched the requested prefixes.", - "items": { - "$ref": "ThreatMatch" - }, - "type": "array" - }, - "minimumWaitDuration": { - "description": "The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want.", - "format": "google-duration", - "type": "string" - }, - "negativeCacheDuration": { - "description": "For requested entities that did not match the threat list, how long to cache the response.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "FindThreatMatchesRequest": { - "description": "Request to check entries against lists.", - "id": "FindThreatMatchesRequest", - "properties": { - "client": { - "$ref": "ClientInfo", - "description": "The client metadata." - }, - "threatInfo": { - "$ref": "ThreatInfo", - "description": "The lists and entries to be checked for matches." - } - }, - "type": "object" - }, - "FindThreatMatchesResponse": { - "id": "FindThreatMatchesResponse", - "properties": { - "matches": { - "description": "The threat list matches.", - "items": { - "$ref": "ThreatMatch" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListThreatListsResponse": { - "id": "ListThreatListsResponse", - "properties": { - "threatLists": { - "description": "The lists available for download by the client.", - "items": { - "$ref": "ThreatListDescriptor" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListUpdateRequest": { + "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest": { "description": "A single list update request.", - "id": "ListUpdateRequest", + "id": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest", "properties": { "constraints": { - "$ref": "Constraints", + "$ref": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints", "description": "The constraints associated with this request." }, "platformType": { @@ -567,19 +412,83 @@ }, "type": "object" }, - "ListUpdateResponse": { + "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints": { + "description": "The constraints for this update.", + "id": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints", + "properties": { + "deviceLocation": { + "description": "A client's physical location, expressed as a ISO 31166-1 alpha-2 region code.", + "type": "string" + }, + "language": { + "description": "Requests the lists for a specific language. Expects ISO 639 alpha-2 format.", + "type": "string" + }, + "maxDatabaseEntries": { + "description": "Sets the maximum number of entries that the client is willing to have in the local database for the specified list. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set.", + "format": "int32", + "type": "integer" + }, + "maxUpdateEntries": { + "description": "The maximum size in number of entries. The update will not contain more entries than this value. This should be a power of 2 between 2**10 and 2**20. If zero, no update size limit is set.", + "format": "int32", + "type": "integer" + }, + "region": { + "description": "Requests the list for a specific geographic location. If not set the server may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2 format.", + "type": "string" + }, + "supportedCompressions": { + "description": "The compression types supported by the client.", + "items": { + "enum": [ + "COMPRESSION_TYPE_UNSPECIFIED", + "RAW", + "RICE" + ], + "enumDescriptions": [ + "Unknown.", + "Raw, uncompressed data.", + "Rice-Golomb encoded data." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse": { + "id": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse", + "properties": { + "listUpdateResponses": { + "description": "The list updates requested by the clients. The number of responses here may be less than the number of requests sent by clients. This is the case, for example, if the server has no updates for a particular list.", + "items": { + "$ref": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse" + }, + "type": "array" + }, + "minimumWaitDuration": { + "description": "The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse": { "description": "An update to an individual list.", - "id": "ListUpdateResponse", + "id": "GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse", "properties": { "additions": { "description": "A set of entries to add to a local threat type's list. Repeated to allow for a combination of compressed and raw data to be sent in a single response.", "items": { - "$ref": "ThreatEntrySet" + "$ref": "GoogleSecuritySafebrowsingV4ThreatEntrySet" }, "type": "array" }, "checksum": { - "$ref": "Checksum", + "$ref": "GoogleSecuritySafebrowsingV4Checksum", "description": "The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided update. If the client state doesn't match the expected state, the client must disregard this update and retry later." }, "newClientState": { @@ -616,7 +525,7 @@ "removals": { "description": "A set of entries to remove from a local threat type's list. In practice, this field is empty or contains exactly one ThreatEntrySet.", "items": { - "$ref": "ThreatEntrySet" + "$ref": "GoogleSecuritySafebrowsingV4ThreatEntrySet" }, "type": "array" }, @@ -701,26 +610,100 @@ }, "type": "object" }, - "MetadataEntry": { - "description": "A single metadata entry.", - "id": "MetadataEntry", + "GoogleSecuritySafebrowsingV4FindFullHashesRequest": { + "description": "Request to return full hashes matched by the provided hash prefixes.", + "id": "GoogleSecuritySafebrowsingV4FindFullHashesRequest", "properties": { - "key": { - "description": "The metadata entry key. For JSON requests, the key is base64-encoded.", - "format": "byte", + "apiClient": { + "$ref": "GoogleSecuritySafebrowsingV4ClientInfo", + "description": "Client metadata associated with callers of higher-level APIs built on top of the client's implementation." + }, + "client": { + "$ref": "GoogleSecuritySafebrowsingV4ClientInfo", + "description": "The client metadata." + }, + "clientStates": { + "description": "The current client states for each of the client's local threat lists.", + "items": { + "format": "byte", + "type": "string" + }, + "type": "array" + }, + "threatInfo": { + "$ref": "GoogleSecuritySafebrowsingV4ThreatInfo", + "description": "The lists and hashes to be checked." + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4FindFullHashesResponse": { + "id": "GoogleSecuritySafebrowsingV4FindFullHashesResponse", + "properties": { + "matches": { + "description": "The full hashes that matched the requested prefixes.", + "items": { + "$ref": "GoogleSecuritySafebrowsingV4ThreatMatch" + }, + "type": "array" + }, + "minimumWaitDuration": { + "description": "The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want.", + "format": "google-duration", "type": "string" }, - "value": { - "description": "The metadata entry value. For JSON requests, the value is base64-encoded.", - "format": "byte", + "negativeCacheDuration": { + "description": "For requested entities that did not match the threat list, how long to cache the response.", + "format": "google-duration", "type": "string" } }, "type": "object" }, - "RawHashes": { + "GoogleSecuritySafebrowsingV4FindThreatMatchesRequest": { + "description": "Request to check entries against lists.", + "id": "GoogleSecuritySafebrowsingV4FindThreatMatchesRequest", + "properties": { + "client": { + "$ref": "GoogleSecuritySafebrowsingV4ClientInfo", + "description": "The client metadata." + }, + "threatInfo": { + "$ref": "GoogleSecuritySafebrowsingV4ThreatInfo", + "description": "The lists and entries to be checked for matches." + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4FindThreatMatchesResponse": { + "id": "GoogleSecuritySafebrowsingV4FindThreatMatchesResponse", + "properties": { + "matches": { + "description": "The threat list matches.", + "items": { + "$ref": "GoogleSecuritySafebrowsingV4ThreatMatch" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4ListThreatListsResponse": { + "id": "GoogleSecuritySafebrowsingV4ListThreatListsResponse", + "properties": { + "threatLists": { + "description": "The lists available for download by the client.", + "items": { + "$ref": "GoogleSecuritySafebrowsingV4ThreatListDescriptor" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4RawHashes": { "description": "The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression.", - "id": "RawHashes", + "id": "GoogleSecuritySafebrowsingV4RawHashes", "properties": { "prefixSize": { "description": "The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).", @@ -735,9 +718,9 @@ }, "type": "object" }, - "RawIndices": { + "GoogleSecuritySafebrowsingV4RawIndices": { "description": "A set of raw indices to remove from a local list.", - "id": "RawIndices", + "id": "GoogleSecuritySafebrowsingV4RawIndices", "properties": { "indices": { "description": "The indices to remove from a lexicographically-sorted local list.", @@ -750,9 +733,9 @@ }, "type": "object" }, - "RiceDeltaEncoding": { + "GoogleSecuritySafebrowsingV4RiceDeltaEncoding": { "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.", - "id": "RiceDeltaEncoding", + "id": "GoogleSecuritySafebrowsingV4RiceDeltaEncoding", "properties": { "encodedData": { "description": "The encoded deltas that are encoded using the Golomb-Rice coder.", @@ -777,9 +760,9 @@ }, "type": "object" }, - "ThreatEntry": { + "GoogleSecuritySafebrowsingV4ThreatEntry": { "description": "An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.", - "id": "ThreatEntry", + "id": "GoogleSecuritySafebrowsingV4ThreatEntry", "properties": { "digest": { "description": "The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.", @@ -798,23 +781,40 @@ }, "type": "object" }, - "ThreatEntryMetadata": { + "GoogleSecuritySafebrowsingV4ThreatEntryMetadata": { "description": "The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.", - "id": "ThreatEntryMetadata", + "id": "GoogleSecuritySafebrowsingV4ThreatEntryMetadata", "properties": { "entries": { "description": "The metadata entries.", "items": { - "$ref": "MetadataEntry" + "$ref": "GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry" }, "type": "array" } }, "type": "object" }, - "ThreatEntrySet": { + "GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry": { + "description": "A single metadata entry.", + "id": "GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry", + "properties": { + "key": { + "description": "The metadata entry key. For JSON requests, the key is base64-encoded.", + "format": "byte", + "type": "string" + }, + "value": { + "description": "The metadata entry value. For JSON requests, the value is base64-encoded.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4ThreatEntrySet": { "description": "A set of threats that should be added or removed from a client's local database.", - "id": "ThreatEntrySet", + "id": "GoogleSecuritySafebrowsingV4ThreatEntrySet", "properties": { "compressionType": { "description": "The compression type for the entries in this set.", @@ -831,33 +831,33 @@ "type": "string" }, "rawHashes": { - "$ref": "RawHashes", + "$ref": "GoogleSecuritySafebrowsingV4RawHashes", "description": "The raw SHA256-formatted entries." }, "rawIndices": { - "$ref": "RawIndices", + "$ref": "GoogleSecuritySafebrowsingV4RawIndices", "description": "The raw removal indices for a local list." }, "riceHashes": { - "$ref": "RiceDeltaEncoding", + "$ref": "GoogleSecuritySafebrowsingV4RiceDeltaEncoding", "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a Golomb-Rice encoding. The hashes are converted to uint32, sorted in ascending order, then delta encoded and stored as encoded_data." }, "riceIndices": { - "$ref": "RiceDeltaEncoding", + "$ref": "GoogleSecuritySafebrowsingV4RiceDeltaEncoding", "description": "The encoded local, lexicographically-sorted list indices, using a Golomb-Rice encoding. Used for sending compressed removal indices. The removal indices (uint32) are sorted in ascending order, then delta encoded and stored as encoded_data." } }, "type": "object" }, - "ThreatHit": { - "id": "ThreatHit", + "GoogleSecuritySafebrowsingV4ThreatHit": { + "id": "GoogleSecuritySafebrowsingV4ThreatHit", "properties": { "clientInfo": { - "$ref": "ClientInfo", + "$ref": "GoogleSecuritySafebrowsingV4ClientInfo", "description": "Client-reported identification." }, "entry": { - "$ref": "ThreatEntry", + "$ref": "GoogleSecuritySafebrowsingV4ThreatEntry", "description": "The threat entry responsible for the hit. Full hash should be reported for hash-based hits." }, "platformType": { @@ -889,7 +889,7 @@ "resources": { "description": "The resources related to the threat hit.", "items": { - "$ref": "ThreatSource" + "$ref": "GoogleSecuritySafebrowsingV4ThreatHitThreatSource" }, "type": "array" }, @@ -936,15 +936,68 @@ "type": "string" }, "userInfo": { - "$ref": "UserInfo", + "$ref": "GoogleSecuritySafebrowsingV4ThreatHitUserInfo", "description": "Details about the user that encountered the threat." } }, "type": "object" }, - "ThreatInfo": { + "GoogleSecuritySafebrowsingV4ThreatHitThreatSource": { + "description": "A single resource related to a threat hit.", + "id": "GoogleSecuritySafebrowsingV4ThreatHitThreatSource", + "properties": { + "referrer": { + "description": "Referrer of the resource. Only set if the referrer is available.", + "type": "string" + }, + "remoteIp": { + "description": "The remote IP of the resource in ASCII format. Either IPv4 or IPv6.", + "type": "string" + }, + "type": { + "description": "The type of source reported.", + "enum": [ + "THREAT_SOURCE_TYPE_UNSPECIFIED", + "MATCHING_URL", + "TAB_URL", + "TAB_REDIRECT", + "TAB_RESOURCE" + ], + "enumDescriptions": [ + "Unknown.", + "The URL that matched the threat list (for which GetFullHash returned a valid hash).", + "The final top-level URL of the tab that the client was browsing when the match occurred.", + "A redirect URL that was fetched before hitting the final TAB_URL.", + "A resource loaded within the final TAB_URL." + ], + "type": "string" + }, + "url": { + "description": "The URL of the resource.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4ThreatHitUserInfo": { + "description": "Details about the user that encountered the threat.", + "id": "GoogleSecuritySafebrowsingV4ThreatHitUserInfo", + "properties": { + "regionCode": { + "description": "The UN M.49 region code associated with the user's location.", + "type": "string" + }, + "userId": { + "description": "Unique user identifier defined by the client.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV4ThreatInfo": { "description": "The information regarding one or more threats that a client submits when checking for matches in threat lists.", - "id": "ThreatInfo", + "id": "GoogleSecuritySafebrowsingV4ThreatInfo", "properties": { "platformTypes": { "description": "The platform types to be checked.", @@ -978,7 +1031,7 @@ "threatEntries": { "description": "The threat entries to be checked.", "items": { - "$ref": "ThreatEntry" + "$ref": "GoogleSecuritySafebrowsingV4ThreatEntry" }, "type": "array" }, @@ -1055,9 +1108,9 @@ }, "type": "object" }, - "ThreatListDescriptor": { + "GoogleSecuritySafebrowsingV4ThreatListDescriptor": { "description": "Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.", - "id": "ThreatListDescriptor", + "id": "GoogleSecuritySafebrowsingV4ThreatListDescriptor", "properties": { "platformType": { "description": "The platform type targeted by the list's entries.", @@ -1152,9 +1205,9 @@ }, "type": "object" }, - "ThreatMatch": { + "GoogleSecuritySafebrowsingV4ThreatMatch": { "description": "A match when checking a threat entry in the Safe Browsing threat lists.", - "id": "ThreatMatch", + "id": "GoogleSecuritySafebrowsingV4ThreatMatch", "properties": { "cacheDuration": { "description": "The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.", @@ -1188,11 +1241,11 @@ "type": "string" }, "threat": { - "$ref": "ThreatEntry", + "$ref": "GoogleSecuritySafebrowsingV4ThreatEntry", "description": "The threat matching this threat." }, "threatEntryMetadata": { - "$ref": "ThreatEntryMetadata", + "$ref": "GoogleSecuritySafebrowsingV4ThreatEntryMetadata", "description": "Optional metadata associated with this threat." }, "threatEntryType": { @@ -1261,59 +1314,6 @@ } }, "type": "object" - }, - "ThreatSource": { - "description": "A single resource related to a threat hit.", - "id": "ThreatSource", - "properties": { - "referrer": { - "description": "Referrer of the resource. Only set if the referrer is available.", - "type": "string" - }, - "remoteIp": { - "description": "The remote IP of the resource in ASCII format. Either IPv4 or IPv6.", - "type": "string" - }, - "type": { - "description": "The type of source reported.", - "enum": [ - "THREAT_SOURCE_TYPE_UNSPECIFIED", - "MATCHING_URL", - "TAB_URL", - "TAB_REDIRECT", - "TAB_RESOURCE" - ], - "enumDescriptions": [ - "Unknown.", - "The URL that matched the threat list (for which GetFullHash returned a valid hash).", - "The final top-level URL of the tab that the client was browsing when the match occurred.", - "A redirect URL that was fetched before hitting the final TAB_URL.", - "A resource loaded within the final TAB_URL." - ], - "type": "string" - }, - "url": { - "description": "The URL of the resource.", - "type": "string" - } - }, - "type": "object" - }, - "UserInfo": { - "description": "Details about the user that encountered the threat.", - "id": "UserInfo", - "properties": { - "regionCode": { - "description": "The UN M.49 region code associated with the user's location.", - "type": "string" - }, - "userId": { - "description": "Unique user identifier defined by the client.", - "format": "byte", - "type": "string" - } - }, - "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/script__v1.json b/discovery/googleapis/script__v1.json index 6573869..5d35ce2 100644 --- a/discovery/googleapis/script__v1.json +++ b/discovery/googleapis/script__v1.json
@@ -830,7 +830,7 @@ "scripts": { "methods": { "run": { - "description": "Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the project in the script editor, then select **File > Project properties** and click the **Scopes** tab. The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.", + "description": "Runs a function in an Apps Script project. The script project must be deployed for use with the Apps Script API and the calling application must share the same Cloud Platform project. This method requires authorization with an OAuth 2.0 token that includes at least one of the scopes listed in the [Authorization](#authorization-scopes) section; script projects that do not require authorization cannot be executed through this API. To find the correct scopes to include in the authentication token, open the script project **Overview** page and scroll down to \"Project OAuth Scopes.\" The error `403, PERMISSION_DENIED: The caller does not have permission` indicates that the Cloud Platform project used to authorize the request is not the same as the one used by the script.", "httpMethod": "POST", "id": "script.scripts.run", "parameterOrder": [ @@ -838,7 +838,7 @@ ], "parameters": { "scriptId": { - "description": "The script ID of the script to be executed. To find the script ID, open the project in the script editor and select **File > Project properties**.", + "description": "The script ID of the script to be executed. Find the script ID on the **Project settings** page under \"IDs.\"", "location": "path", "required": true, "type": "string" @@ -869,7 +869,7 @@ } } }, - "revision": "20200927", + "revision": "20210124", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": {
diff --git a/discovery/googleapis/searchconsole__v1.json b/discovery/googleapis/searchconsole__v1.json index 4a6c01e..9979fff 100644 --- a/discovery/googleapis/searchconsole__v1.json +++ b/discovery/googleapis/searchconsole__v1.json
@@ -361,7 +361,7 @@ } } }, - "revision": "20200927", + "revision": "20210203", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "ApiDataRow": { @@ -598,6 +598,20 @@ ], "type": "string" }, + "dataState": { + "description": "The data state to be fetched, can be full or all, the latter including full and partial data.", + "enum": [ + "DATA_STATE_UNSPECIFIED", + "FINAL", + "ALL" + ], + "enumDescriptions": [ + "Default value, should not be used.", + "Include full final data only, without partial.", + "Include all data, full and partial." + ], + "type": "string" + }, "dimensionFilterGroups": { "description": "[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \\\"buy\\\"' to see only data where the query string contains the substring \\\"buy\\\" (not case-sensitive). You can filter by a dimension without grouping by it.", "items": { @@ -642,11 +656,13 @@ "enum": [ "WEB", "IMAGE", - "VIDEO" + "VIDEO", + "NEWS" ], "enumDescriptions": [ "", "", + "", "" ], "type": "string"
diff --git a/discovery/googleapis/secretmanager__v1.json b/discovery/googleapis/secretmanager__v1.json index 974b560..8e528d8 100644 --- a/discovery/googleapis/secretmanager__v1.json +++ b/discovery/googleapis/secretmanager__v1.json
@@ -609,7 +609,7 @@ } } }, - "revision": "20201002", + "revision": "20210201", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -713,10 +713,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -1005,6 +1001,11 @@ "readOnly": true, "type": "string" }, + "expireTime": { + "description": "Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.", + "format": "google-datetime", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -1020,6 +1021,11 @@ "replication": { "$ref": "Replication", "description": "Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created." + }, + "ttl": { + "description": "Input only. The TTL for the Secret.", + "format": "google-duration", + "type": "string" } }, "type": "object"
diff --git a/discovery/googleapis/securitycenter__v1.json b/discovery/googleapis/securitycenter__v1.json index 690c2cf..66b0309 100644 --- a/discovery/googleapis/securitycenter__v1.json +++ b/discovery/googleapis/securitycenter__v1.json
@@ -14,7 +14,7 @@ "canonicalName": "Security Command Center", "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryVersion": "v1", - "documentationLink": "https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview", + "documentationLink": "https://cloud.google.com/security-command-center", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" @@ -103,6 +103,377 @@ }, "protocol": "rest", "resources": { + "folders": { + "resources": { + "assets": { + "methods": { + "group": { + "description": "Filters an organization's assets and groups them by their specified properties.", + "httpMethod": "POST", + "id": "securitycenter.folders.assets.group", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/assets:group", + "request": { + "$ref": "GroupAssetsRequest" + }, + "response": { + "$ref": "GroupAssetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists an organization's assets.", + "httpMethod": "GET", + "id": "securitycenter.folders.assets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "compareDuration": { + "description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "fieldMask": { + "description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + }, + "readTime": { + "description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", + "format": "google-datetime", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/assets", + "response": { + "$ref": "ListAssetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateSecurityMarks": { + "description": "Updates security marks.", + "httpMethod": "PATCH", + "id": "securitycenter.folders.assets.updateSecurityMarks", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", + "location": "path", + "pattern": "^folders/[^/]+/assets/[^/]+/securityMarks$", + "required": true, + "type": "string" + }, + "startTime": { + "description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "SecurityMarks" + }, + "response": { + "$ref": "SecurityMarks" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "sources": { + "methods": { + "list": { + "description": "Lists all sources belonging to an organization.", + "httpMethod": "GET", + "id": "securitycenter.folders.sources.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", + "location": "path", + "pattern": "^folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sources", + "response": { + "$ref": "ListSourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "findings": { + "methods": { + "group": { + "description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings", + "httpMethod": "POST", + "id": "securitycenter.folders.sources.findings.group", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "location": "path", + "pattern": "^folders/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/findings:group", + "request": { + "$ref": "GroupFindingsRequest" + }, + "response": { + "$ref": "GroupFindingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings", + "httpMethod": "GET", + "id": "securitycenter.folders.sources.findings.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "compareDuration": { + "description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "fieldMask": { + "description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` * severity: `=`, `:` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "location": "path", + "pattern": "^folders/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + }, + "readTime": { + "description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", + "format": "google-datetime", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/findings", + "response": { + "$ref": "ListFindingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.", + "httpMethod": "PATCH", + "id": "securitycenter.folders.sources.findings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"", + "location": "path", + "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using \"source_properties.\" in the field mask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Finding" + }, + "response": { + "$ref": "Finding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setState": { + "description": "Updates the state of a finding.", + "httpMethod": "POST", + "id": "securitycenter.folders.sources.findings.setState", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/finding/{finding_id}\".", + "location": "path", + "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:setState", + "request": { + "$ref": "SetFindingStateRequest" + }, + "response": { + "$ref": "Finding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateSecurityMarks": { + "description": "Updates security marks.", + "httpMethod": "PATCH", + "id": "securitycenter.folders.sources.findings.updateSecurityMarks", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", + "location": "path", + "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$", + "required": true, + "type": "string" + }, + "startTime": { + "description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "SecurityMarks" + }, + "response": { + "$ref": "SecurityMarks" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "organizations": { "methods": { "getOrganizationSettings": { @@ -175,7 +546,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id]\".", + "description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -235,7 +606,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id]\".", + "description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -692,7 +1063,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\".", + "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -831,7 +1202,7 @@ ] }, "group": { - "description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings", + "description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings", "httpMethod": "POST", "id": "securitycenter.organizations.sources.findings.group", "parameterOrder": [ @@ -839,7 +1210,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\". To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-", + "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -878,7 +1249,7 @@ "type": "string" }, "filter": { - "description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`", + "description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` * severity: `=`, `:` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`", "location": "query", "type": "string" }, @@ -899,7 +1270,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-", + "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -1024,9 +1395,380 @@ } } } + }, + "projects": { + "resources": { + "assets": { + "methods": { + "group": { + "description": "Filters an organization's assets and groups them by their specified properties.", + "httpMethod": "POST", + "id": "securitycenter.projects.assets.group", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the organization to groupBy. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/assets:group", + "request": { + "$ref": "GroupAssetsRequest" + }, + "response": { + "$ref": "GroupAssetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists an organization's assets.", + "httpMethod": "GET", + "id": "securitycenter.projects.assets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "compareDuration": { + "description": "When compare_duration is set, the ListAssetsResult's \"state_change\" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible \"state_change\" values when compare_duration is specified: * \"ADDED\": indicates that the asset was not present at the start of compare_duration, but present at read_time. * \"REMOVED\": indicates that the asset was present at the start of compare_duration, but not present at read_time. * \"ACTIVE\": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all assets present at read_time.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "fieldMask": { + "description": "A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `update_time = \"2019-06-10T16:07:18-07:00\"` `update_time = 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `create_time = \"2019-06-10T16:07:18-07:00\"` `create_time = 1560208038000` * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `resource_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-resource_properties.my_property : \"\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,resource_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,resource_properties.a_property\" and \" name desc , resource_properties.a_property \" are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the organization assets should belong to. Its format is \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "readTime": { + "description": "Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", + "format": "google-datetime", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/assets", + "response": { + "$ref": "ListAssetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateSecurityMarks": { + "description": "Updates security marks.", + "httpMethod": "PATCH", + "id": "securitycenter.projects.assets.updateSecurityMarks", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", + "location": "path", + "pattern": "^projects/[^/]+/assets/[^/]+/securityMarks$", + "required": true, + "type": "string" + }, + "startTime": { + "description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "SecurityMarks" + }, + "response": { + "$ref": "SecurityMarks" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "sources": { + "methods": { + "list": { + "description": "Lists all sources belonging to an organization.", + "httpMethod": "GET", + "id": "securitycenter.projects.sources.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id], folders/[folder_id], or projects/[project_id]\".", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sources", + "response": { + "$ref": "ListSourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "findings": { + "methods": { + "group": { + "description": "Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings, /v1/folders/{folder_id}/sources/-/findings, /v1/projects/{project_id}/sources/-/findings", + "httpMethod": "POST", + "id": "securitycenter.projects.sources.findings.group", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "location": "path", + "pattern": "^projects/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/findings:group", + "request": { + "$ref": "GroupFindingsRequest" + }, + "response": { + "$ref": "GroupFindingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1/organizations/{organization_id}/sources/-/findings", + "httpMethod": "GET", + "id": "securitycenter.projects.sources.findings.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "compareDuration": { + "description": "When compare_duration is set, the ListFindingsResult's \"state_change\" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible \"state_change\" values when compare_duration is specified: * \"CHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration, but changed its state at read_time. * \"UNCHANGED\": indicates that the finding was present and matched the given filter at the start of compare_duration and did not change state at read_time. * \"ADDED\": indicates that the finding did not match the given filter or was not present at the start of compare_duration, but was present at read_time. * \"REMOVED\": indicates that the finding was present and matched the filter at the start of compare_duration, but did not match the filter at read_time. If compare_duration is not specified, then the only possible state_change is \"UNUSED\", which will be the state_change set for all findings present at read_time.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "fieldMask": { + "description": "A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` * severity: `=`, `:` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: \"name,resource_properties.a_property\". The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be appended to the field name. For example: \"name desc,source_properties.a_property\". Redundant space characters in the syntax are insignificant. \"name desc,source_properties.a_property\" and \" name desc , source_properties.a_property \" are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "location": "path", + "pattern": "^projects/[^/]+/sources/[^/]+$", + "required": true, + "type": "string" + }, + "readTime": { + "description": "Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW.", + "format": "google-datetime", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/findings", + "response": { + "$ref": "ListFindingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Creates or updates a finding. The corresponding source must exist for a finding creation to succeed.", + "httpMethod": "PATCH", + "id": "securitycenter.projects.sources.findings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using \"source_properties.\" in the field mask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Finding" + }, + "response": { + "$ref": "Finding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setState": { + "description": "Updates the state of a finding.", + "httpMethod": "POST", + "id": "securitycenter.projects.sources.findings.setState", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: \"organizations/{organization_id}/sources/{source_id}/finding/{finding_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:setState", + "request": { + "$ref": "SetFindingStateRequest" + }, + "response": { + "$ref": "Finding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateSecurityMarks": { + "description": "Updates security marks.", + "httpMethod": "PATCH", + "id": "securitycenter.projects.sources.findings.updateSecurityMarks", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: \"organizations/{organization_id}/assets/{asset_id}/securityMarks\" \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks\".", + "location": "path", + "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+/securityMarks$", + "required": true, + "type": "string" + }, + "startTime": { + "description": "The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to \"marks\", all marks will be replaced. Individual marks can be updated using \"marks.\".", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "SecurityMarks" + }, + "response": { + "$ref": "SecurityMarks" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } } }, - "revision": "20201002", + "revision": "20210129", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Asset": { @@ -1073,6 +1815,13 @@ "description": "The configuration used for Asset Discovery runs.", "id": "AssetDiscoveryConfig", "properties": { + "folderIds": { + "description": "The folder ids to use for filtering asset discovery. It consists of only digits, e.g., 756619654966.", + "items": { + "type": "string" + }, + "type": "array" + }, "inclusionMode": { "description": "The mode to use for filtering asset discovery.", "enum": [ @@ -1235,6 +1984,24 @@ "description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, + "severity": { + "description": "The severity of the finding. This field is managed by the source that writes the finding.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "This value is used for findings when a source doesn't write a severity value.", + "Vulnerability: A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data, public SSH access with weak or no passwords, etc. Threat: Indicates a threat that is able to access, modify, or delete data or execute unauthorized code within existing resources.", + "Vulnerability: A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities in order to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. Threat: Indicates a threat that is able to create new computational resources in an environment but not able to access data or execute code in existing resources.", + "Vulnerability: A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. Threat: Indicates a threat that is able to cause operational impact but may not access data or execute unauthorized code.", + "Vulnerability: A low risk vulnerability hampers a security organization’s ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. Threat: Indicates a threat that has obtained minimal access to an environment but is not able to access data, execute code, or create resources." + ], + "type": "string" + }, "sourceProperties": { "additionalProperties": { "type": "any" @@ -1259,6 +2026,21 @@ }, "type": "object" }, + "Folder": { + "description": "Message that contains the resource name and display name of a folder resource.", + "id": "Folder", + "properties": { + "resourceFolder": { + "description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", + "type": "string" + }, + "resourceFolderDisplayName": { + "description": "The user defined display name for this folder.", + "type": "string" + } + }, + "type": "object" + }, "GetIamPolicyRequest": { "description": "Request message for `GetIamPolicy` method.", "id": "GetIamPolicyRequest", @@ -1305,6 +2087,14 @@ "description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1Resource", "properties": { + "folders": { + "description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", + "items": { + "$ref": "Folder" + }, + "readOnly": true, + "type": "array" + }, "name": { "description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" @@ -1465,6 +2255,21 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1p1beta1Folder": { + "description": "Message that contains the resource name and display name of a folder resource.", + "id": "GoogleCloudSecuritycenterV1p1beta1Folder", + "properties": { + "resourceFolder": { + "description": "Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", + "type": "string" + }, + "resourceFolderDisplayName": { + "description": "The user defined display name for this folder.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1p1beta1NotificationMessage": { "description": "Security Command Center's Notification", "id": "GoogleCloudSecuritycenterV1p1beta1NotificationMessage", @@ -1488,6 +2293,14 @@ "description": "Information related to the Google Cloud resource.", "id": "GoogleCloudSecuritycenterV1p1beta1Resource", "properties": { + "folders": { + "description": "Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", + "items": { + "$ref": "GoogleCloudSecuritycenterV1p1beta1Folder" + }, + "readOnly": true, + "type": "array" + }, "name": { "description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" @@ -1629,11 +2442,11 @@ "type": "string" }, "filter": { - "description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`", + "description": "Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` * severity: `=`, `:` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: `event_time = \"2019-06-10T16:07:18-07:00\"` `event_time = 1560208038000` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. Use a partial match on the empty string to filter based on a property existing: `source_properties.my_property : \"\"` Use a negated partial match on the empty string to filter based on a property not existing: `-source_properties.my_property : \"\"`", "type": "string" }, "groupBy": { - "description": "Required. Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: \"parent,resource_name\". The following fields are supported: * resource_name * category * state * parent The following fields are supported when compare_duration is set: * state_change", + "description": "Required. Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: \"parent,resource_name\". The following fields are supported: * resource_name * category * state * parent * severity The following fields are supported when compare_duration is set: * state_change", "type": "string" }, "pageSize": { @@ -1999,6 +2812,13 @@ "description": "Information related to the Google Cloud resource that is associated with this finding. LINT.IfChange", "id": "Resource", "properties": { + "folders": { + "description": "Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", + "items": { + "$ref": "Folder" + }, + "type": "array" + }, "name": { "description": "The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" @@ -2032,6 +2852,13 @@ "description": "Security Command Center managed properties. These properties are managed by Security Command Center and cannot be modified by the user.", "id": "SecurityCenterProperties", "properties": { + "folders": { + "description": "Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization.", + "items": { + "$ref": "Folder" + }, + "type": "array" + }, "resourceDisplayName": { "description": "The user defined display name for this resource.", "type": "string"
diff --git a/discovery/googleapis/serviceconsumermanagement__v1.json b/discovery/googleapis/serviceconsumermanagement__v1.json index 1a7ab9a..318f603 100644 --- a/discovery/googleapis/serviceconsumermanagement__v1.json +++ b/discovery/googleapis/serviceconsumermanagement__v1.json
@@ -526,7 +526,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -651,7 +651,7 @@ "type": "string" }, "jwksUri": { - "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", + "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", "type": "string" }, "jwtLocations": { @@ -705,7 +705,7 @@ "id": "AuthenticationRule", "properties": { "allowWithoutCredential": { - "description": "If true, the service accepts API keys without any other credential.", + "description": "If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.", "type": "boolean" }, "oauth": { @@ -845,7 +845,7 @@ "type": "object" }, "Context": { - "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", + "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", "properties": { "rules": { @@ -1044,7 +1044,7 @@ "type": "object" }, "Endpoint": { - "description": "`Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", + "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { "aliases": { @@ -1268,10 +1268,6 @@ }, "type": "array" }, - "allowHalfDuplex": { - "description": "When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method.", - "type": "boolean" - }, "body": { "description": "The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.", "type": "string" @@ -1542,7 +1538,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -1585,7 +1581,7 @@ "type": "string" }, "unit": { - "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", + "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", "type": "string" }, "valueType": { @@ -1639,7 +1635,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -1724,7 +1720,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2014,7 +2010,7 @@ "description": "Billing configuration." }, "configVersion": { - "description": "The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`.", + "description": "Deprecated. The service config compiler always sets this field to `3`.", "format": "uint32", "type": "integer" }, @@ -2148,25 +2144,6 @@ }, "type": "object" }, - "ServiceIdentity": { - "description": "The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: \"projects/123456789\" display_name: \"Cloud XXX Service Agent\" description: \"Used as the identity of Cloud XXX to access resources\"", - "id": "ServiceIdentity", - "properties": { - "description": { - "description": "Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.", - "type": "string" - }, - "displayName": { - "description": "Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.", - "type": "string" - }, - "serviceAccountParent": { - "description": "A service account project that hosts the service accounts. An example name would be: `projects/123456789`", - "type": "string" - } - }, - "type": "object" - }, "SourceContext": { "description": "`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.", "id": "SourceContext", @@ -2350,7 +2327,7 @@ "id": "TenantProjectPolicy", "properties": { "policyBindings": { - "description": "Policy bindings to be applied to the tenant project, in addition to the 'roles/owner' role granted to the Service Consumer Management service account. At least one binding must have the role `roles/owner`. Among the list of members for `roles/owner`, at least one of them must be either the `user` or `group` type.", + "description": "Policy bindings to be applied to the tenant project, in addition to the 'roles/owner' role granted to the Service Consumer Management service account. At least one binding must have the role `roles/owner`.", "items": { "$ref": "PolicyBinding" }, @@ -2463,7 +2440,7 @@ "type": "string" }, "requirements": { - "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'.", + "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include \"serviceusage.googleapis.com/tos/cloud\". Other Google APIs should include \"serviceusage.googleapis.com/tos/universal\". Additional ToS can be included based on the business needs.", "items": { "type": "string" }, @@ -2475,10 +2452,6 @@ "$ref": "UsageRule" }, "type": "array" - }, - "serviceIdentity": { - "$ref": "ServiceIdentity", - "description": "The configuration of a per-product per-project service identity." } }, "type": "object"
diff --git a/discovery/googleapis/servicecontrol__v1.json b/discovery/googleapis/servicecontrol__v1.json index d5d3828..c9e0f1a 100644 --- a/discovery/googleapis/servicecontrol__v1.json +++ b/discovery/googleapis/servicecontrol__v1.json
@@ -15,7 +15,7 @@ "baseUrl": "https://servicecontrol.googleapis.com/", "batchPath": "batch", "canonicalName": "Service Control", - "description": "Provides control plane functionality to managed services, such as logging, monitoring, and status checks.", + "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/service-control/", "icons": { @@ -192,7 +192,7 @@ } } }, - "revision": "20201001", + "revision": "20210123", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -1076,7 +1076,7 @@ "type": "number" }, "endTime": { - "description": "The end of the time period over which this metric value's measurement applies.", + "description": "The end of the time period over which this metric value's measurement applies. If not specified, google.api.servicecontrol.v1.Operation.end_time will be used.", "format": "google-datetime", "type": "string" }, @@ -1097,7 +1097,7 @@ "description": "A money value." }, "startTime": { - "description": "The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details.", + "description": "The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. If not specified, google.api.servicecontrol.v1.Operation.start_time will be used.", "format": "google-datetime", "type": "string" }, @@ -1131,7 +1131,7 @@ "id": "Money", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { @@ -1179,9 +1179,9 @@ "DEBUG" ], "enumDescriptions": [ - "The API implementation may cache and aggregate the data. The data may be lost when rare and unexpected system failures occur.", - "The API implementation doesn't cache and aggregate the data. If the method returns successfully, it's guaranteed that the data has been persisted in durable storage.", - "In addition to the behavior described in HIGH, DEBUG enables additional validation logic that is only useful during the onboarding process. This is only available to Google internal services and the service must be whitelisted by chemist-dev@google.com in order to use this level." + "Allows data caching, batching, and aggregation. It provides higher performance with higher data loss risk.", + "Disables data aggregation to minimize data loss. It is for operations that contains significant monetary value or audit trail. This feature only applies to the client libraries.", + "Deprecated. Do not use. Disables data aggregation and enables additional validation logic. It should only be used during the onboarding process. It is only available to Google internal services, and the service must be approved by chemist-dev@google.com in order to use this level." ], "type": "string" }, @@ -1241,7 +1241,7 @@ "additionalProperties": { "type": "string" }, - "description": "User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed.", + "description": "Private Preview. This feature is only available for approved services. User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed.", "type": "object" } }, @@ -1322,6 +1322,10 @@ "description": "Free-form text that provides details on the cause of the error.", "type": "string" }, + "status": { + "$ref": "Status", + "description": "Contains additional information about the quota error. If available, `status.code` will be non zero." + }, "subject": { "description": "Subject to whom this error applies. See the specific enum for more details on this field. For example, \"clientip:\" or \"project:\".", "type": "string" @@ -1403,7 +1407,7 @@ "For AllocateQuota request, allocates quota for the amount specified in the service configuration or specified using the quota metrics. If the amount is higher than the available quota, allocation error will be returned and no quota will be allocated. If multiple quotas are part of the request, and one fails, none of the quotas are allocated or released.", "The operation allocates quota for the amount specified in the service configuration or specified using the quota metrics. If the amount is higher than the available quota, request does not fail but all available quota will be allocated. For rate quota, BEST_EFFORT will continue to deduct from other groups even if one does not have enough quota. For allocation, it will find the minimum available amount across all groups and deduct that amount from all the affected groups.", "For AllocateQuota request, only checks if there is enough quota available and does not change the available quota. No lock is placed on the available quota either.", - "Unimplemented. When used in AllocateQuotaRequest, this returns the effective quota limit(s) in the response, and no quota check will be performed. Not supported for other requests, and even for AllocateQuotaRequest, this is currently supported only for whitelisted services.", + "Unimplemented. When used in AllocateQuotaRequest, this returns the effective quota limit(s) in the response, and no quota check will be performed. Not supported for other requests, and even for AllocateQuotaRequest, this is currently supported only for allowlisted services.", "The operation allocates quota for the amount specified in the service configuration or specified using the quota metrics. If the requested amount is higher than the available quota, request does not fail and remaining quota would become negative (going over the limit). Not supported for Rate Quota." ], "type": "string" @@ -1449,21 +1453,6 @@ }, "type": "object" }, - "ReportInfo": { - "description": "Contains additional info about the report operation.", - "id": "ReportInfo", - "properties": { - "operationId": { - "description": "The Operation.operation_id value from the request.", - "type": "string" - }, - "quotaInfo": { - "$ref": "QuotaInfo", - "description": "Quota usage info when processing the `Operation`." - } - }, - "type": "object" - }, "ReportRequest": { "description": "Request message for the Report method.", "id": "ReportRequest", @@ -1493,13 +1482,6 @@ }, "type": "array" }, - "reportInfos": { - "description": "Quota usage for each quota release `Operation` request. Fully or partially failed quota release request may or may not be present in `report_quota_info`. For example, a failed quota release request will have the current quota usage info when precise quota library returns the info. A deadline exceeded quota request will not have quota usage info. If there is no quota release request, report_quota_info will be empty. ", - "items": { - "$ref": "ReportInfo" - }, - "type": "array" - }, "serviceConfigId": { "description": "The actual config id used to process the request.", "type": "string" @@ -1602,6 +1584,31 @@ "description": "This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.", "id": "Resource", "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", + "type": "object" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.", + "format": "google-datetime", + "type": "string" + }, + "deleteTime": { + "description": "Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Mutable. The display name set by clients. Must be <= 63 characters.", + "type": "string" + }, + "etag": { + "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -1609,6 +1616,10 @@ "description": "The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.", "type": "object" }, + "location": { + "description": "Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves. For Google Cloud products, the encoding is what is used by Google Cloud APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The semantics of `location` is identical to the `cloud.googleapis.com/location` label used by some Google Cloud APIs.", + "type": "string" + }, "name": { "description": "The stable identifier (name) of a resource on the `service`. A resource can be logically identified as \"//{resource.service}/{resource.name}\". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.", "type": "string" @@ -1620,6 +1631,15 @@ "type": { "description": "The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be \"{service}/{kind}\".", "type": "string" + }, + "uid": { + "description": "The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -1672,6 +1692,10 @@ "$ref": "FirstPartyPrincipal", "description": "First party (Google) identity as the real authority." }, + "principalSubject": { + "description": "A string representing the principal_subject associated with the identity. See go/3pical for more info on how principal_subject is formatted.", + "type": "string" + }, "thirdPartyPrincipal": { "$ref": "ThirdPartyPrincipal", "description": "Third party identity as the real authority."
diff --git a/discovery/googleapis/servicecontrol__v2.json b/discovery/googleapis/servicecontrol__v2.json new file mode 100644 index 0000000..5ca2f68 --- /dev/null +++ b/discovery/googleapis/servicecontrol__v2.json
@@ -0,0 +1,836 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/servicecontrol": { + "description": "Manage your Google Service Control data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://servicecontrol.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Service Control", + "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure. ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/service-control/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "servicecontrol:v2", + "kind": "discovery#restDescription", + "name": "servicecontrol", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "services": { + "methods": { + "check": { + "description": "Private Preview. This feature is only available for approved services. This method provides admission control for services that are integrated with [Service Infrastructure](/service-infrastructure). It checks whether an operation should be allowed based on the service configuration and relevant policies. It must be called before the operation is executed. For more information, see [Admission Control](/service-infrastructure/docs/admission-control). NOTE: The admission control has an expected policy propagation delay of 60s. The caller **must** not depend on the most recent policy changes. NOTE: The admission control has a hard limit of 1 referenced resources per call. If an operation refers to more than 1 resources, the caller must call the Check method multiple times. This method requires the `servicemanagement.services.check` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", + "httpMethod": "POST", + "id": "servicecontrol.services.check", + "parameterOrder": [ + "serviceName" + ], + "parameters": { + "serviceName": { + "description": "The service name as specified in its service configuration. For example, `\"pubsub.googleapis.com\"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v2/services/{serviceName}:check", + "request": { + "$ref": "CheckRequest" + }, + "response": { + "$ref": "CheckResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/servicecontrol" + ] + }, + "report": { + "description": "Private Preview. This feature is only available for approved services. This method provides telemetry reporting for services that are integrated with [Service Infrastructure](/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).", + "httpMethod": "POST", + "id": "servicecontrol.services.report", + "parameterOrder": [ + "serviceName" + ], + "parameters": { + "serviceName": { + "description": "The service name as specified in its service configuration. For example, `\"pubsub.googleapis.com\"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v2/services/{serviceName}:report", + "request": { + "$ref": "ReportRequest" + }, + "response": { + "$ref": "ReportResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/servicecontrol" + ] + } + } + } + }, + "revision": "20210123", + "rootUrl": "https://servicecontrol.googleapis.com/", + "schemas": { + "Api": { + "description": "This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.", + "id": "Api", + "properties": { + "operation": { + "description": "The API operation name. For gRPC requests, it is the fully qualified API method name, such as \"google.pubsub.v1.Publisher.Publish\". For OpenAPI requests, it is the `operationId`, such as \"getPet\".", + "type": "string" + }, + "protocol": { + "description": "The API protocol used for sending the request, such as \"http\", \"https\", \"grpc\", or \"internal\".", + "type": "string" + }, + "service": { + "description": "The API service name. It is a logical identifier for a networked API, such as \"pubsub.googleapis.com\". The naming syntax depends on the API management system being used for handling the request.", + "type": "string" + }, + "version": { + "description": "The API version associated with the API operation above, such as \"v1\" or \"v1alpha1\".", + "type": "string" + } + }, + "type": "object" + }, + "AttributeContext": { + "description": "This message defines the standard attribute vocabulary for Google APIs. An attribute is a piece of metadata that describes an activity on a network service. For example, the size of an HTTP request, or the status code of an HTTP response. Each attribute has a type and a name, which is logically defined as a proto message field in `AttributeContext`. The field type becomes the attribute type, and the field path becomes the attribute name. For example, the attribute `source.ip` maps to field `AttributeContext.source.ip`. This message definition is guaranteed not to have any wire breaking change. So you can use it directly for passing attributes across different systems. NOTE: Different system may generate different subset of attributes. Please verify the system specification before relying on an attribute generated a system.", + "id": "AttributeContext", + "properties": { + "api": { + "$ref": "Api", + "description": "Represents an API operation that is involved to a network activity." + }, + "destination": { + "$ref": "Peer", + "description": "The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop." + }, + "extensions": { + "description": "Supports extensions for advanced use cases, such as logs and metrics.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "origin": { + "$ref": "Peer", + "description": "The origin of a network activity. In a multi hop network activity, the origin represents the sender of the first hop. For the first hop, the `source` and the `origin` must have the same content." + }, + "request": { + "$ref": "Request", + "description": "Represents a network request, such as an HTTP request." + }, + "resource": { + "$ref": "Resource", + "description": "Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one." + }, + "response": { + "$ref": "Response", + "description": "Represents a network response, such as an HTTP response." + }, + "source": { + "$ref": "Peer", + "description": "The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop." + } + }, + "type": "object" + }, + "AuditLog": { + "description": "Common audit log format for Google Cloud Platform API operations. ", + "id": "AuditLog", + "properties": { + "authenticationInfo": { + "$ref": "AuthenticationInfo", + "description": "Authentication information." + }, + "authorizationInfo": { + "description": "Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.", + "items": { + "$ref": "AuthorizationInfo" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Other service-specific data about the request, response, and other information associated with the current audited event.", + "type": "object" + }, + "methodName": { + "description": "The name of the service method or operation. For API calls, this should be the name of the API method. For example, \"google.cloud.bigquery.v2.TableService.InsertTable\" \"google.logging.v2.ConfigServiceV2.CreateSink\"", + "type": "string" + }, + "numResponseItems": { + "description": "The number of items returned from a List or Query API method, if applicable.", + "format": "int64", + "type": "string" + }, + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", + "type": "object" + }, + "requestMetadata": { + "$ref": "RequestMetadata", + "description": "Metadata about the operation." + }, + "resourceLocation": { + "$ref": "ResourceLocation", + "description": "The resource location information." + }, + "resourceName": { + "description": "The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example: \"projects/PROJECT_ID/zones/us-central1-a/instances\" \"projects/PROJECT_ID/datasets/DATASET_ID\"", + "type": "string" + }, + "resourceOriginalState": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The resource's original state before mutation. Present only for operations which have successfully modified the targeted resource(s). In general, this field should contain all changed fields, except those that are already been included in `request`, `response`, `metadata` or `service_data` fields. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", + "type": "object" + }, + "serviceData": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Deprecated. Use the `metadata` field instead. Other service-specific data about the request, response, and other activities.", + "type": "object" + }, + "serviceName": { + "description": "The name of the API service performing the operation. For example, `\"compute.googleapis.com\"`.", + "type": "string" + }, + "status": { + "$ref": "Status", + "description": "The status of the overall operation." + } + }, + "type": "object" + }, + "Auth": { + "description": "This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.", + "id": "Auth", + "properties": { + "accessLevels": { + "description": "A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: \"//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}\" Example: \"//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "audiences": { + "description": "The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential. For example, [\"https://pubsub.googleapis.com/\", \"https://storage.googleapis.com/\"]. * A set of service-based scopes. For example, [\"https://www.googleapis.com/auth/cloud-platform\"]. * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided.", + "items": { + "type": "string" + }, + "type": "array" + }, + "claims": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.", + "type": "object" + }, + "presenter": { + "description": "The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: \"123456789012.apps.googleusercontent.com\".", + "type": "string" + }, + "principal": { + "description": "The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: \"https://accounts.google.com/{id}\"", + "type": "string" + } + }, + "type": "object" + }, + "AuthenticationInfo": { + "description": "Authentication information for the operation.", + "id": "AuthenticationInfo", + "properties": { + "authoritySelector": { + "description": "The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.", + "type": "string" + }, + "principalEmail": { + "description": "The email address of the authenticated user (or service account on behalf of third party principal) making the request. For third party identity callers, the `principal_subject` field is populated instead of this field. For privacy reasons, the principal email address is sometimes redacted. For more information, see [Caller identities in audit logs](https://cloud.google.com/logging/docs/audit#user-id).", + "type": "string" + }, + "principalSubject": { + "description": "String representation of identity of requesting party. Populated for both first and third party identities.", + "type": "string" + }, + "serviceAccountDelegationInfo": { + "description": "Identity delegation history of an authenticated service account that makes the request. It contains information on the real authorities that try to access GCP resources by delegating on a service account. When multiple authorities present, they are guaranteed to be sorted based on the original ordering of the identity delegation events.", + "items": { + "$ref": "ServiceAccountDelegationInfo" + }, + "type": "array" + }, + "serviceAccountKeyName": { + "description": "The name of the service account key used to create or exchange credentials for authenticating the service account making the request. This is a scheme-less URI full resource name. For example: \"//iam.googleapis.com/projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}\"", + "type": "string" + }, + "thirdPartyPrincipal": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The third party identification (if any) of the authenticated user making the request. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the `@type` property.", + "type": "object" + } + }, + "type": "object" + }, + "AuthorizationInfo": { + "description": "Authorization information for the operation.", + "id": "AuthorizationInfo", + "properties": { + "granted": { + "description": "Whether or not authorization for `resource` and `permission` was granted.", + "type": "boolean" + }, + "permission": { + "description": "The required IAM permission.", + "type": "string" + }, + "resource": { + "description": "The resource being accessed, as a REST-style string. For example: bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID", + "type": "string" + }, + "resourceAttributes": { + "$ref": "Resource", + "description": "Resource attributes used in IAM condition evaluation. This field contains resource attributes like resource type and resource name. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into `AuditLog.request_metadata.request_attributes`." + } + }, + "type": "object" + }, + "CheckRequest": { + "description": "Request message for the Check method.", + "id": "CheckRequest", + "properties": { + "attributes": { + "$ref": "AttributeContext", + "description": "Describes attributes about the operation being executed by the service." + }, + "resources": { + "description": "Describes the resources and the policies applied to each resource.", + "items": { + "$ref": "ResourceInfo" + }, + "type": "array" + }, + "serviceConfigId": { + "description": "Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.", + "type": "string" + } + }, + "type": "object" + }, + "CheckResponse": { + "description": "Response message for the Check method.", + "id": "CheckResponse", + "properties": { + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "Returns a set of request contexts generated from the `CheckRequest`.", + "type": "object" + }, + "status": { + "$ref": "Status", + "description": "An 'OK' status allows the operation. Any other status indicates a denial; [google.rpc.Status.details]() would contain additional details about the denial." + } + }, + "type": "object" + }, + "FirstPartyPrincipal": { + "description": "First party identity principal.", + "id": "FirstPartyPrincipal", + "properties": { + "principalEmail": { + "description": "The email address of a Google account. .", + "type": "string" + }, + "serviceMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Metadata about the service that uses the service account. .", + "type": "object" + } + }, + "type": "object" + }, + "Peer": { + "description": "This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate.", + "id": "Peer", + "properties": { + "ip": { + "description": "The IP address of the peer.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with the peer.", + "type": "object" + }, + "port": { + "description": "The network port of the peer.", + "format": "int64", + "type": "string" + }, + "principal": { + "description": "The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.", + "type": "string" + }, + "regionCode": { + "description": "The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.", + "type": "string" + } + }, + "type": "object" + }, + "ReportRequest": { + "description": "Request message for the Report method.", + "id": "ReportRequest", + "properties": { + "operations": { + "description": "Describes the list of operations to be reported. Each operation is represented as an AttributeContext, and contains all attributes around an API access.", + "items": { + "$ref": "AttributeContext" + }, + "type": "array" + }, + "serviceConfigId": { + "description": "Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.", + "type": "string" + } + }, + "type": "object" + }, + "ReportResponse": { + "description": "Response message for the Report method. If the request contains any invalid data, the server returns an RPC error.", + "id": "ReportResponse", + "properties": {}, + "type": "object" + }, + "Request": { + "description": "This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.", + "id": "Request", + "properties": { + "auth": { + "$ref": "Auth", + "description": "The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request `Authorization` header or equivalent." + }, + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.", + "type": "object" + }, + "host": { + "description": "The HTTP request `Host` header value.", + "type": "string" + }, + "id": { + "description": "The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.", + "type": "string" + }, + "method": { + "description": "The HTTP request method, such as `GET`, `POST`.", + "type": "string" + }, + "path": { + "description": "The HTTP URL path.", + "type": "string" + }, + "protocol": { + "description": "The network protocol used with the request, such as \"http/1.1\", \"spdy/3\", \"h2\", \"h2c\", \"webrtc\", \"tcp\", \"udp\", \"quic\". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.", + "type": "string" + }, + "query": { + "description": "The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed.", + "type": "string" + }, + "reason": { + "description": "A special parameter for request reason. It is used by security systems to associate auditing information with a request.", + "type": "string" + }, + "scheme": { + "description": "The HTTP URL scheme, such as `http` and `https`.", + "type": "string" + }, + "size": { + "description": "The HTTP request size in bytes. If unknown, it must be -1.", + "format": "int64", + "type": "string" + }, + "time": { + "description": "The timestamp when the `destination` service receives the first byte of the request.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RequestMetadata": { + "description": "Metadata about the request.", + "id": "RequestMetadata", + "properties": { + "callerIp": { + "description": "The IP address of the caller. For caller from internet, this will be public IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP address, this will be the VM's external IP address. For caller from a Compute Engine VM without external IP address, if the VM is in the same organization (or project) as the accessed resource, `caller_ip` will be the VM's internal IPv4 address, otherwise the `caller_ip` will be redacted to \"gce-internal-ip\". See https://cloud.google.com/compute/docs/vpc/ for more information.", + "type": "string" + }, + "callerNetwork": { + "description": "The network of the caller. Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example: \"//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID\"", + "type": "string" + }, + "callerSuppliedUserAgent": { + "description": "The user agent of the caller. This information is not authenticated and should be treated accordingly. For example: + `google-api-python-client/1.4.0`: The request was made by the Google API client for Python. + `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`: The request was made by the Google Cloud SDK CLI (gcloud). + `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`: The request was made from the `my-project` App Engine app. NOLINT", + "type": "string" + }, + "destinationAttributes": { + "$ref": "Peer", + "description": "The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature." + }, + "requestAttributes": { + "$ref": "Request", + "description": "Request attributes used in IAM condition evaluation. This field contains request attributes like request time and access levels associated with the request. To get the whole view of the attributes used in IAM condition evaluation, the user must also look into `AuditLog.authentication_info.resource_attributes`." + } + }, + "type": "object" + }, + "Resource": { + "description": "This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.", + "id": "Resource", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", + "type": "object" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.", + "format": "google-datetime", + "type": "string" + }, + "deleteTime": { + "description": "Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "Mutable. The display name set by clients. Must be <= 63 characters.", + "type": "string" + }, + "etag": { + "description": "Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.", + "type": "object" + }, + "location": { + "description": "Immutable. The location of the resource. The location encoding is specific to the service provider, and new encoding may be introduced as the service evolves. For Google Cloud products, the encoding is what is used by Google Cloud APIs, such as `us-east1`, `aws-us-east-1`, and `azure-eastus2`. The semantics of `location` is identical to the `cloud.googleapis.com/location` label used by some Google Cloud APIs.", + "type": "string" + }, + "name": { + "description": "The stable identifier (name) of a resource on the `service`. A resource can be logically identified as \"//{resource.service}/{resource.name}\". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.", + "type": "string" + }, + "service": { + "description": "The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request.", + "type": "string" + }, + "type": { + "description": "The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be \"{service}/{kind}\".", + "type": "string" + }, + "uid": { + "description": "The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ResourceInfo": { + "description": "Describes a resource referenced in the request.", + "id": "ResourceInfo", + "properties": { + "name": { + "description": "The name of the resource referenced in the request.", + "type": "string" + }, + "permission": { + "description": "The resource permission needed for this request. The format must be \"{service}/{plural}.{verb}\".", + "type": "string" + }, + "type": { + "description": "The resource type in the format of \"{service}/{kind}\".", + "type": "string" + } + }, + "type": "object" + }, + "ResourceLocation": { + "description": "Location information about a resource.", + "id": "ResourceLocation", + "properties": { + "currentLocations": { + "description": "The locations of a resource after the execution of the operation. Requests to create or delete a location based resource must populate the 'current_locations' field and not the 'original_locations' field. For example: \"europe-west1-a\" \"us-east1\" \"nam3\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "originalLocations": { + "description": "The locations of a resource prior to the execution of the operation. Requests that mutate the resource's location must populate both the 'original_locations' as well as the 'current_locations' fields. For example: \"europe-west1-a\" \"us-east1\" \"nam3\"", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Response": { + "description": "This message defines attributes for a typical network response. It generally models semantics of an HTTP response.", + "id": "Response", + "properties": { + "code": { + "description": "The HTTP response status code, such as `200` and `404`.", + "format": "int64", + "type": "string" + }, + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The HTTP response headers. If multiple headers share the same key, they must be merged according to HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.", + "type": "object" + }, + "size": { + "description": "The HTTP response size in bytes. If unknown, it must be -1.", + "format": "int64", + "type": "string" + }, + "time": { + "description": "The timestamp when the `destination` service generates the first byte of the response.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccountDelegationInfo": { + "description": "Identity delegation history of an authenticated service account.", + "id": "ServiceAccountDelegationInfo", + "properties": { + "firstPartyPrincipal": { + "$ref": "FirstPartyPrincipal", + "description": "First party (Google) identity as the real authority." + }, + "principalSubject": { + "description": "A string representing the principal_subject associated with the identity. See go/3pical for more info on how principal_subject is formatted.", + "type": "string" + }, + "thirdPartyPrincipal": { + "$ref": "ThirdPartyPrincipal", + "description": "Third party identity as the real authority." + } + }, + "type": "object" + }, + "SpanContext": { + "description": "The context of a span, attached to Exemplars in Distribution values during aggregation. It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]", + "id": "SpanContext", + "properties": { + "spanName": { + "description": "The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "ThirdPartyPrincipal": { + "description": "Third party identity principal.", + "id": "ThirdPartyPrincipal", + "properties": { + "thirdPartyClaims": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Metadata about third party identity.", + "type": "object" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Service Control API", + "version": "v2", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/servicedirectory__v1beta1.json b/discovery/googleapis/servicedirectory__v1.json similarity index 94% rename from discovery/googleapis_beta/servicedirectory__v1beta1.json rename to discovery/googleapis/servicedirectory__v1.json index 4b15062..b37d37c 100644 --- a/discovery/googleapis_beta/servicedirectory__v1beta1.json +++ b/discovery/googleapis/servicedirectory__v1.json
@@ -19,7 +19,7 @@ "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "id": "servicedirectory:v1beta1", + "id": "servicedirectory:v1", "kind": "discovery#restDescription", "name": "servicedirectory", "ownerDomain": "google.com", @@ -123,7 +123,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Location" }, @@ -163,7 +163,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}/locations", + "path": "v1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, @@ -196,7 +196,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/namespaces", + "path": "v1/{+parent}/namespaces", "request": { "$ref": "Namespace" }, @@ -223,7 +223,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Empty" }, @@ -247,7 +247,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Namespace" }, @@ -271,7 +271,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" }, @@ -319,7 +319,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/namespaces", + "path": "v1/{+parent}/namespaces", "response": { "$ref": "ListNamespacesResponse" }, @@ -349,7 +349,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "request": { "$ref": "Namespace" }, @@ -376,7 +376,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, @@ -403,7 +403,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, @@ -439,7 +439,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/services", + "path": "v1/{+parent}/services", "request": { "$ref": "Service" }, @@ -466,7 +466,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Empty" }, @@ -490,7 +490,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Service" }, @@ -514,7 +514,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" }, @@ -562,7 +562,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/services", + "path": "v1/{+parent}/services", "response": { "$ref": "ListServicesResponse" }, @@ -592,7 +592,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "request": { "$ref": "Service" }, @@ -619,7 +619,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}:resolve", + "path": "v1/{+name}:resolve", "request": { "$ref": "ResolveServiceRequest" }, @@ -646,7 +646,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, @@ -673,7 +673,7 @@ "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, @@ -709,7 +709,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/endpoints", + "path": "v1/{+parent}/endpoints", "request": { "$ref": "Endpoint" }, @@ -736,7 +736,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Empty" }, @@ -760,7 +760,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "response": { "$ref": "Endpoint" }, @@ -805,7 +805,7 @@ "type": "string" } }, - "path": "v1beta1/{+parent}/endpoints", + "path": "v1/{+parent}/endpoints", "response": { "$ref": "ListEndpointsResponse" }, @@ -835,7 +835,7 @@ "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1/{+name}", "request": { "$ref": "Endpoint" }, @@ -857,17 +857,13 @@ } } }, - "revision": "20201003", + "revision": "20210121", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -900,11 +896,11 @@ "description": "Optional. An IPv4 or IPv6 address. Service Directory will reject bad addresses like: \"8.8.8\" \"8.8.8.8:53\" \"test:bad:address\" \"[::1]\" \"[::1]:8080\" Limited to 45 characters.", "type": "string" }, - "metadata": { + "annotations": { "additionalProperties": { "type": "string" }, - "description": "Optional. Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond any these limits will be rejected.", + "description": "Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: - The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that goes beyond any these limits will be rejected. - Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/). Annotations that fails to meet these requirements will be rejected. - The '(*.)google.com/' and '(*.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. Note: This field is equivalent to the 'metadata' field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.", "type": "object" }, "name": { @@ -1143,6 +1139,13 @@ "description": "An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.", "id": "Service", "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Annotations for the service. This data can be consumed by service clients. Restrictions: - The entire annotations dictionary may contain up to 2000 characters, spread accoss all key-value pairs. Annotations that goes beyond any these limits will be rejected. - Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/). Annotations that fails to meet these requirements will be rejected. - The '(*.)google.com/' and '(*.)googleapis.com/' prefixes are reserved for system annotations managed by Service Directory. If the user tries to write to these keyspaces, those entries will be silently ignored by the system. Note: This field is equivalent to the 'metadata' field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.", + "type": "object" + }, "endpoints": { "description": "Output only. Endpoints associated with this service. Returned on LookupService.Resolve. Control plane clients should use RegistrationService.ListEndpoints.", "items": { @@ -1151,13 +1154,6 @@ "readOnly": true, "type": "array" }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Metadata for the service. This data can be consumed by service clients. The entire metadata dictionary may contain up to 2000 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.", - "type": "object" - }, "name": { "description": "Immutable. The resource name for the service in the format 'projects/*/locations/*/namespaces/*/services/*'.", "type": "string" @@ -1207,6 +1203,6 @@ }, "servicePath": "", "title": "Service Directory API", - "version": "v1beta1", + "version": "v1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis/servicemanagement__v1.json b/discovery/googleapis/servicemanagement__v1.json index cd12314..0abd912 100644 --- a/discovery/googleapis/servicemanagement__v1.json +++ b/discovery/googleapis/servicemanagement__v1.json
@@ -832,7 +832,7 @@ } } }, - "revision": "20201006", + "revision": "20210129", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -967,7 +967,7 @@ "type": "string" }, "jwksUri": { - "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", + "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", "type": "string" }, "jwtLocations": { @@ -1021,7 +1021,7 @@ "id": "AuthenticationRule", "properties": { "allowWithoutCredential": { - "description": "If true, the service accepts API keys without any other credential.", + "description": "If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.", "type": "boolean" }, "oauth": { @@ -1287,7 +1287,7 @@ "type": "object" }, "Context": { - "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", + "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", "properties": { "rules": { @@ -1514,7 +1514,7 @@ "type": "object" }, "Endpoint": { - "description": "`Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", + "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { "aliases": { @@ -1851,10 +1851,6 @@ }, "type": "array" }, - "allowHalfDuplex": { - "description": "When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method.", - "type": "boolean" - }, "body": { "description": "The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.", "type": "string" @@ -2176,7 +2172,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2219,7 +2215,7 @@ "type": "string" }, "unit": { - "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", + "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", "type": "string" }, "valueType": { @@ -2273,7 +2269,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2358,7 +2354,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2732,7 +2728,7 @@ "description": "Billing configuration." }, "configVersion": { - "description": "The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`.", + "description": "Deprecated. The service config compiler always sets this field to `3`.", "format": "uint32", "type": "integer" }, @@ -2848,25 +2844,6 @@ }, "type": "object" }, - "ServiceIdentity": { - "description": "The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: \"projects/123456789\" display_name: \"Cloud XXX Service Agent\" description: \"Used as the identity of Cloud XXX to access resources\"", - "id": "ServiceIdentity", - "properties": { - "description": { - "description": "Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.", - "type": "string" - }, - "displayName": { - "description": "Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.", - "type": "string" - }, - "serviceAccountParent": { - "description": "A service account project that hosts the service accounts. An example name would be: `projects/123456789`", - "type": "string" - } - }, - "type": "object" - }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -3158,7 +3135,7 @@ "type": "string" }, "requirements": { - "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'.", + "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include \"serviceusage.googleapis.com/tos/cloud\". Other Google APIs should include \"serviceusage.googleapis.com/tos/universal\". Additional ToS can be included based on the business needs.", "items": { "type": "string" }, @@ -3170,10 +3147,6 @@ "$ref": "UsageRule" }, "type": "array" - }, - "serviceIdentity": { - "$ref": "ServiceIdentity", - "description": "The configuration of a per-product per-project service identity." } }, "type": "object"
diff --git a/discovery/googleapis/servicenetworking__v1.json b/discovery/googleapis/servicenetworking__v1.json index 0b12477..e61571d 100644 --- a/discovery/googleapis/servicenetworking__v1.json +++ b/discovery/googleapis/servicenetworking__v1.json
@@ -627,6 +627,61 @@ "global": { "resources": { "networks": { + "methods": { + "get": { + "description": "Service producers use this method to get the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.", + "httpMethod": "GET", + "id": "servicenetworking.services.projects.global.networks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the consumer config to retrieve in the format: `services/{service}/projects/{project}/global/networks/{network}`. {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is a project number e.g. `12345` that contains the service consumer's VPC network. {network} is the name of the service consumer's VPC network.", + "location": "path", + "pattern": "^services/[^/]+/projects/[^/]+/global/networks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ConsumerConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ] + }, + "updateConsumerConfig": { + "description": "Service producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with public IP.", + "httpMethod": "PATCH", + "id": "servicenetworking.services.projects.global.networks.updateConsumerConfig", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent resource identifying the connection for which the consumer config is being updated in the format: `services/{service}/projects/{project}/global/networks/{network}` {service} is the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value is `servicenetworking.googleapis.com`. {project} is the number of the project that contains the service consumer's VPC network e.g. `12345`. {network} is the name of the service consumer's VPC network.", + "location": "path", + "pattern": "^services/[^/]+/projects/[^/]+/global/networks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:updateConsumerConfig", + "request": { + "$ref": "UpdateConsumerConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ] + } + }, "resources": { "peeredDnsDomains": { "methods": { @@ -719,7 +774,7 @@ "roles": { "methods": { "add": { - "description": "Service producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from within a whitelisted set of roles. Each role is applied at only the granularity specified in the whitelist.", + "description": "Service producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from within an allowlisted set of roles. Each role is applied at only the granularity specified in the allowlist.", "httpMethod": "POST", "id": "servicenetworking.services.roles.add", "parameterOrder": [ @@ -751,7 +806,7 @@ } } }, - "revision": "20201006", + "revision": "20210202", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -886,6 +941,20 @@ "description": "Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the subnet. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails.", "type": "string" }, + "requestedRanges": { + "description": "Optional. The name of one or more allocated IP address ranges associated with this private service access connection. If no range names are provided all ranges associated with this connection will be considered. If a CIDR range with the specified IP prefix length is not available within these ranges, the call fails.", + "items": { + "type": "string" + }, + "type": "array" + }, + "secondaryIpRangeSpecs": { + "description": "Optional. A list of secondary IP ranges to be created within the new subnetwork.", + "items": { + "$ref": "SecondaryIpRangeSpec" + }, + "type": "array" + }, "subnetwork": { "description": "Required. A name for the new subnet. For information about the naming requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.", "type": "string" @@ -973,7 +1042,7 @@ "type": "string" }, "jwksUri": { - "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", + "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", "type": "string" }, "jwtLocations": { @@ -1027,7 +1096,7 @@ "id": "AuthenticationRule", "properties": { "allowWithoutCredential": { - "description": "If true, the service accepts API keys without any other credential.", + "description": "If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.", "type": "boolean" }, "oauth": { @@ -1183,6 +1252,69 @@ }, "type": "object" }, + "ConsumerConfig": { + "description": "Configuration information for a private service access connection.", + "id": "ConsumerConfig", + "properties": { + "consumerExportCustomRoutes": { + "description": "Export custom routes flag value for peering from consumer to producer.", + "type": "boolean" + }, + "consumerExportSubnetRoutesWithPublicIp": { + "description": "Export subnet routes with public ip flag value for peering from consumer to producer.", + "type": "boolean" + }, + "consumerImportCustomRoutes": { + "description": "Import custom routes flag value for peering from consumer to producer.", + "type": "boolean" + }, + "consumerImportSubnetRoutesWithPublicIp": { + "description": "Import subnet routes with public ip flag value for peering from consumer to producer.", + "type": "boolean" + }, + "producerExportCustomRoutes": { + "description": "Export custom routes flag value for peering from producer to consumer.", + "type": "boolean" + }, + "producerExportSubnetRoutesWithPublicIp": { + "description": "Export subnet routes with public ip flag value for peering from producer to consumer.", + "type": "boolean" + }, + "producerImportCustomRoutes": { + "description": "Import custom routes flag value for peering from producer to consumer.", + "type": "boolean" + }, + "producerImportSubnetRoutesWithPublicIp": { + "description": "Import subnet routes with public ip flag value for peering from producer to consumer.", + "type": "boolean" + }, + "producerNetwork": { + "description": "Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name.", + "readOnly": true, + "type": "string" + }, + "reservedRanges": { + "description": "Output only. The reserved ranges associated with this private service access connection.", + "items": { + "$ref": "GoogleCloudServicenetworkingV1ConsumerConfigReservedRange" + }, + "readOnly": true, + "type": "array" + }, + "vpcScReferenceArchitectureEnabled": { + "description": "Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "ConsumerConfigMetadata": { + "description": "Metadata provided through GetOperation request for the LRO generated by UpdateConsumerConfig API.", + "id": "ConsumerConfigMetadata", + "properties": {}, + "type": "object" + }, "ConsumerProject": { "description": "Represents a consumer project.", "id": "ConsumerProject", @@ -1196,7 +1328,7 @@ "type": "object" }, "Context": { - "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", + "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", "properties": { "rules": { @@ -1310,6 +1442,12 @@ }, "type": "object" }, + "DeleteConnectionMetadata": { + "description": "Metadata provided through GetOperation request for the LRO generated by Delete Connection API", + "id": "DeleteConnectionMetadata", + "properties": {}, + "type": "object" + }, "DeletePeeredDnsDomainMetadata": { "description": "Metadata provided through GetOperation request for the LRO generated by DeletePeeredDnsDomain API.", "id": "DeletePeeredDnsDomainMetadata", @@ -1443,7 +1581,7 @@ "type": "object" }, "Endpoint": { - "description": "`Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", + "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { "aliases": { @@ -1638,6 +1776,52 @@ }, "type": "object" }, + "GoogleCloudServicenetworkingV1ConsumerConfigReservedRange": { + "description": "Allocated IP address ranges for this private service access connection.", + "id": "GoogleCloudServicenetworkingV1ConsumerConfigReservedRange", + "properties": { + "address": { + "description": "The starting address of the reserved range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix length is the CIDR range for the reserved range.", + "type": "string" + }, + "ipPrefixLength": { + "description": "The prefix length of the reserved range.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "The name of the reserved range.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudServicenetworkingV1betaConnection": { + "description": "Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network.", + "id": "GoogleCloudServicenetworkingV1betaConnection", + "properties": { + "network": { + "description": "The name of service consumer's VPC network that's connected with service producer network, in the following format: `projects/{project}/global/networks/{network}`. `{project}` is a project number, such as in `12345` that includes the VPC service consumer's VPC network. `{network}` is the name of the service consumer's VPC network.", + "type": "string" + }, + "peering": { + "description": "Output only. The name of the VPC Network Peering connection that was created by the service producer.", + "type": "string" + }, + "reservedPeeringRanges": { + "description": "The name of one or more allocated IP address ranges for this service producer of type `PEERING`. Note that invoking this method with a different range when connection is already established will not modify already provisioned service producer subnetworks.", + "items": { + "type": "string" + }, + "type": "array" + }, + "service": { + "description": "Output only. The name of the peering service that's associated with this connection, in the following format: `services/{service name}`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudServicenetworkingV1betaSubnetwork": { "description": "Represents a subnet that was created or discovered by a private access management service.", "id": "GoogleCloudServicenetworkingV1betaSubnetwork", @@ -1690,10 +1874,6 @@ }, "type": "array" }, - "allowHalfDuplex": { - "description": "When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method.", - "type": "boolean" - }, "body": { "description": "The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.", "type": "string" @@ -1974,7 +2154,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2017,7 +2197,7 @@ "type": "string" }, "unit": { - "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", + "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", "type": "string" }, "valueType": { @@ -2071,7 +2251,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2156,7 +2336,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2330,7 +2510,7 @@ "type": "string" }, "role": { - "description": "Required. Role to apply. Only whitelisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project", + "description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project", "type": "string" } }, @@ -2435,13 +2615,27 @@ "format": "int32", "type": "integer" }, + "requestedRanges": { + "description": "Optional. The name of one or more allocated IP address ranges associated with this private service access connection. If no range names are provided all ranges associated with this connection will be considered. If a CIDR range with the specified IP prefix length is not available within these ranges the validation fails.", + "items": { + "type": "string" + }, + "type": "array" + }, "secondaryRangeIpPrefixLengths": { - "description": "Optional. DO NOT USE - Under development. The size of the desired secondary ranges for the subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine that the allocated ranges have enough free space for all the requested secondary ranges.", + "description": "Optional. The size of the desired secondary ranges for the subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine that the allocated ranges have enough free space for all the requested secondary ranges.", "items": { "format": "int32", "type": "integer" }, "type": "array" + }, + "subnetworkCandidates": { + "description": "Optional. List of subnetwork candidates to validate. The required input fields are `name`, `network`, and `region`. Subnetworks from this list which exist will be returned in the response with the `ip_cidr_range`, `secondary_ip_cider_ranges`, and `outside_allocation` fields set.", + "items": { + "$ref": "Subnetwork" + }, + "type": "array" } }, "type": "object" @@ -2543,6 +2737,39 @@ }, "type": "object" }, + "SecondaryIpRange": { + "id": "SecondaryIpRange", + "properties": { + "ipCidrRange": { + "description": "Secondary IP CIDR range in `x.x.x.x/y` format.", + "type": "string" + }, + "rangeName": { + "description": "Name of the secondary IP range.", + "type": "string" + } + }, + "type": "object" + }, + "SecondaryIpRangeSpec": { + "id": "SecondaryIpRangeSpec", + "properties": { + "ipPrefixLength": { + "description": "Required. The prefix length of the secondary IP range. Use CIDR range notation, such as `30` to provision a secondary IP range with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range.", + "format": "int32", + "type": "integer" + }, + "rangeName": { + "description": "Required. A name for the secondary IP range. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.", + "type": "string" + }, + "requestedAddress": { + "description": "Optional. The starting address of a range. The address must be a valid IPv4 address in the x.x.x.x format. This value combined with the IP prefix range is the CIDR range for the secondary IP range. The range must be within the allocated range that is assigned to the private connection. If the CIDR range isn't available, the call fails.", + "type": "string" + } + }, + "type": "object" + }, "Service": { "description": "`Service` is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service config_version: 3 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", "id": "Service", @@ -2567,7 +2794,7 @@ "description": "Billing configuration." }, "configVersion": { - "description": "The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`.", + "description": "Deprecated. The service config compiler always sets this field to `3`.", "format": "uint32", "type": "integer" }, @@ -2683,25 +2910,6 @@ }, "type": "object" }, - "ServiceIdentity": { - "description": "The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: \"projects/123456789\" display_name: \"Cloud XXX Service Agent\" description: \"Used as the identity of Cloud XXX to access resources\"", - "id": "ServiceIdentity", - "properties": { - "description": { - "description": "Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.", - "type": "string" - }, - "displayName": { - "description": "Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.", - "type": "string" - }, - "serviceAccountParent": { - "description": "A service account project that hosts the service accounts. An example name would be: `projects/123456789`", - "type": "string" - } - }, - "type": "object" - }, "SourceContext": { "description": "`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined.", "id": "SourceContext", @@ -2777,6 +2985,17 @@ "outsideAllocation": { "description": "This is a discovered subnet that is not within the current consumer allocated ranges.", "type": "boolean" + }, + "region": { + "description": "GCP region where the subnetwork is located.", + "type": "string" + }, + "secondaryIpRanges": { + "description": "List of secondary IP ranges in this subnetwork.", + "items": { + "$ref": "SecondaryIpRange" + }, + "type": "array" } }, "type": "object" @@ -2880,6 +3099,17 @@ }, "type": "object" }, + "UpdateConsumerConfigRequest": { + "description": "Request to update the configuration of a service networking connection including the import/export of custom routes and subnetwork routes with public IP.", + "id": "UpdateConsumerConfigRequest", + "properties": { + "consumerConfig": { + "$ref": "ConsumerConfig", + "description": "Required. The updated peering config." + } + }, + "type": "object" + }, "UpdateDnsRecordSetMetadata": { "description": "Metadata provided through GetOperation request for the LRO generated by UpdateDnsRecordSet API", "id": "UpdateDnsRecordSetMetadata", @@ -2918,7 +3148,7 @@ "type": "string" }, "requirements": { - "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'.", + "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include \"serviceusage.googleapis.com/tos/cloud\". Other Google APIs should include \"serviceusage.googleapis.com/tos/universal\". Additional ToS can be included based on the business needs.", "items": { "type": "string" }, @@ -2930,10 +3160,6 @@ "$ref": "UsageRule" }, "type": "array" - }, - "serviceIdentity": { - "$ref": "ServiceIdentity", - "description": "The configuration of a per-product per-project service identity." } }, "type": "object" @@ -2982,10 +3208,19 @@ "ValidateConsumerConfigResponse": { "id": "ValidateConsumerConfigResponse", "properties": { + "existingSubnetworkCandidates": { + "description": "List of subnetwork candidates from the request which exist with the `ip_cidr_range`, `secondary_ip_cider_ranges`, and `outside_allocation` fields set.", + "items": { + "$ref": "Subnetwork" + }, + "type": "array" + }, "isValid": { + "description": "Indicates whether all the requested validations passed.", "type": "boolean" }, "validationError": { + "description": "The first validation which failed.", "enum": [ "VALIDATION_ERROR_UNSPECIFIED", "VALIDATION_NOT_REQUESTED",
diff --git a/discovery/googleapis/serviceusage__v1.json b/discovery/googleapis/serviceusage__v1.json index c3df490..ed7b52d 100644 --- a/discovery/googleapis/serviceusage__v1.json +++ b/discovery/googleapis/serviceusage__v1.json
@@ -414,7 +414,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AdminQuotaPolicy": { @@ -525,7 +525,7 @@ "type": "string" }, "jwksUri": { - "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", + "description": "URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs", "type": "string" }, "jwtLocations": { @@ -579,7 +579,7 @@ "id": "AuthenticationRule", "properties": { "allowWithoutCredential": { - "description": "If true, the service accepts API keys without any other credential.", + "description": "If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.", "type": "boolean" }, "oauth": { @@ -785,7 +785,7 @@ "type": "object" }, "Context": { - "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to whitelist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", + "description": "`Context` defines which contexts an API requests. Example: context: rules: - selector: \"*\" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: \"google.example.library.v1.LibraryService.CreateBook\" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here.", "id": "Context", "properties": { "rules": { @@ -1030,7 +1030,7 @@ "type": "object" }, "Endpoint": { - "description": "`Endpoint` describes a network endpoint that serves a set of APIs. A service may expose any number of endpoints, and all endpoints share the same service configuration, such as quota configuration and monitoring configuration. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", + "description": "`Endpoint` describes a network endpoint of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example service configuration: name: library-example.googleapis.com endpoints: # Below entry makes 'google.example.library.v1.Library' # API be served from endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS calls to be passed to the backend, for # it to decide whether the subsequent cross-origin request is # allowed to proceed. - name: library-example.googleapis.com allow_cors: true", "id": "Endpoint", "properties": { "aliases": { @@ -1272,7 +1272,7 @@ "description": "Billing configuration." }, "configVersion": { - "description": "The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions. The latest config version is `3`.", + "description": "Deprecated. The service config compiler always sets this field to `3`.", "format": "uint32", "type": "integer" }, @@ -1388,25 +1388,6 @@ }, "type": "object" }, - "GoogleApiServiceIdentity": { - "description": "The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: \"projects/123456789\" display_name: \"Cloud XXX Service Agent\" description: \"Used as the identity of Cloud XXX to access resources\"", - "id": "GoogleApiServiceIdentity", - "properties": { - "description": { - "description": "Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.", - "type": "string" - }, - "displayName": { - "description": "Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.", - "type": "string" - }, - "serviceAccountParent": { - "description": "A service account project that hosts the service accounts. An example name would be: `projects/123456789`", - "type": "string" - } - }, - "type": "object" - }, "GoogleApiServiceusageV1OperationMetadata": { "description": "The operation metadata returned for the batchend services operation.", "id": "GoogleApiServiceusageV1OperationMetadata", @@ -1577,10 +1558,6 @@ }, "type": "array" }, - "allowHalfDuplex": { - "description": "When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method.", - "type": "boolean" - }, "body": { "description": "The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.", "type": "string" @@ -1893,7 +1870,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -1936,7 +1913,7 @@ "type": "string" }, "unit": { - "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems may scale the values to be more easily displayed (so a value of `0.02KBy` _might_ be displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `KBy`, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", + "description": "The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, \"new users per day\" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean \"5 new users). Alternatively, \"thousands of page views per day\" would be represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean \"5300 page views per day\"). * `%` represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means \"3 percent\"). * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means \"3 percent\").", "type": "string" }, "valueType": { @@ -1990,7 +1967,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2075,7 +2052,7 @@ "The feature is not yet implemented. Users can not use it.", "Prelaunch features are hidden from users and are only visible internally.", "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects whitelisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don’t have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", "GA features are open to all developers and are considered stable and fully qualified for production use.", "Deprecated features are scheduled to be shut down and removed. For more information, see the “Deprecation Policy” section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." @@ -2522,7 +2499,7 @@ "type": "string" }, "requirements": { - "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'.", + "description": "Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include \"serviceusage.googleapis.com/tos/cloud\". Other Google APIs should include \"serviceusage.googleapis.com/tos/universal\". Additional ToS can be included based on the business needs.", "items": { "type": "string" }, @@ -2534,10 +2511,6 @@ "$ref": "UsageRule" }, "type": "array" - }, - "serviceIdentity": { - "$ref": "GoogleApiServiceIdentity", - "description": "The configuration of a per-product per-project service identity." } }, "type": "object"
diff --git a/discovery/googleapis/sheets__v4.json b/discovery/googleapis/sheets__v4.json index 7d47e2f..d0d6502 100644 --- a/discovery/googleapis/sheets__v4.json +++ b/discovery/googleapis/sheets__v4.json
@@ -851,7 +851,7 @@ } } }, - "revision": "20200929", + "revision": "20210128", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -1361,14 +1361,29 @@ "$ref": "ColorStyle", "description": "The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. If color is also set, this field takes precedence." }, + "dataLabel": { + "$ref": "DataLabel", + "description": "Information about the data labels for this series." + }, "lineStyle": { "$ref": "LineStyle", "description": "The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE." }, + "pointStyle": { + "$ref": "PointStyle", + "description": "The style for points associated with this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, LINE, or SCATTER. If empty, a default point style is used." + }, "series": { "$ref": "ChartData", "description": "The data being visualized in this chart series." }, + "styleOverrides": { + "description": "Style override settings for series data points.", + "items": { + "$ref": "BasicSeriesDataPointStyleOverride" + }, + "type": "array" + }, "targetAxis": { "description": "The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the \"Volume\" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type.", "enum": [ @@ -1527,6 +1542,10 @@ "threeDimensional": { "description": "True to make the chart 3D. Applies to Bar and Column charts.", "type": "boolean" + }, + "totalDataLabel": { + "$ref": "DataLabel", + "description": "Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. These data labels can only be set when chart_type is one of AREA, BAR, COLUMN, COMBO or STEPPED_AREA and stacked_type is either STACKED or PERCENT_STACKED. In addition, for COMBO, this will only be supported if there is only one type of stackable series type or one type has more series than the others and each of the other types have no more than one series. For example, if a chart has two stacked bar series and one area series, the total data labels will be supported. If it has three bar series and two area series, total data labels are not allowed. Neither CUSTOM nor placement can be set on the total_data_label." } }, "type": "object" @@ -1563,6 +1582,30 @@ }, "type": "object" }, + "BasicSeriesDataPointStyleOverride": { + "description": "Style override settings for a single series data point.", + "id": "BasicSeriesDataPointStyleOverride", + "properties": { + "color": { + "$ref": "Color", + "description": "Color of the series data point. If empty, the series default is used." + }, + "colorStyle": { + "$ref": "ColorStyle", + "description": "Color of the series data point. If empty, the series default is used. If color is also set, this field takes precedence." + }, + "index": { + "description": "Zero based index of the series data point.", + "format": "int32", + "type": "integer" + }, + "pointStyle": { + "$ref": "PointStyle", + "description": "Point style of the series data point. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, LINE, or SCATTER. If empty, the series default is used." + } + }, + "type": "object" + }, "BatchClearValuesByDataFilterRequest": { "description": "The request for clearing more than one range selected by a DataFilter in a spreadsheet.", "id": "BatchClearValuesByDataFilterRequest", @@ -2214,7 +2257,7 @@ }, "bubbleTextStyle": { "$ref": "TextFormat", - "description": "The format of the text inside the bubbles. Underline and Strikethrough are not supported." + "description": "The format of the text inside the bubbles. Strikethrough and underline are not supported." }, "domain": { "$ref": "ChartData", @@ -2350,7 +2393,7 @@ "type": "string" }, "hyperlink": { - "description": "A hyperlink this cell points to, if any. This field is read-only. (To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field.)", + "description": "A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field.", "type": "string" }, "note": { @@ -2362,7 +2405,7 @@ "description": "A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effective_value fields." }, "textFormatRuns": { - "description": "Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Runs start at specific indexes in the text and continue until the next run. Properties of a run will continue unless explicitly changed in a subsequent run (and properties of the first run will continue the properties of the cell unless explicitly changed). When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased.", + "description": "Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of the cell unless explicitly changed. When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased.", "items": { "$ref": "TextFormatRun" }, @@ -3207,6 +3250,63 @@ }, "type": "object" }, + "DataLabel": { + "description": "Settings for one set of data labels. Data labels are annotations that appear next to a set of data, such as the points on a line chart, and provide additional information about what the data represents, such as a text representation of the value behind that point on the graph.", + "id": "DataLabel", + "properties": { + "customLabelData": { + "$ref": "ChartData", + "description": "Data to use for custom labels. Only used if type is set to CUSTOM. This data must be the same length as the series or other element this data label is applied to. In addition, if the series is split into multiple source ranges, this source data must come from the next column in the source data. For example, if the series is B2:B4,E6:E8 then this data must come from C2:C4,F6:F8." + }, + "placement": { + "description": "The placement of the data label relative to the labeled data.", + "enum": [ + "DATA_LABEL_PLACEMENT_UNSPECIFIED", + "CENTER", + "LEFT", + "RIGHT", + "ABOVE", + "BELOW", + "INSIDE_END", + "INSIDE_BASE", + "OUTSIDE_END" + ], + "enumDescriptions": [ + "The positioning is determined automatically by the renderer.", + "Center within a bar or column, both horizontally and vertically.", + "To the left of a data point.", + "To the right of a data point.", + "Above a data point.", + "Below a data point.", + "Inside a bar or column at the end (top if positive, bottom if negative).", + "Inside a bar or column at the base.", + "Outside a bar or column at the end." + ], + "type": "string" + }, + "textFormat": { + "$ref": "TextFormat", + "description": "The text format used for the data label." + }, + "type": { + "description": "The type of the data label.", + "enum": [ + "DATA_LABEL_TYPE_UNSPECIFIED", + "NONE", + "DATA", + "CUSTOM" + ], + "enumDescriptions": [ + "The data label type is not specified and will be interpreted depending on the context of the data label within the chart.", + "The data label is not displayed.", + "The data label is displayed using values from the series data.", + "The data label is displayed using values from a custom data source indicated by customLabelData." + ], + "type": "string" + } + }, + "type": "object" + }, "DataSource": { "description": "Information about an external data source in the spreadsheet.", "id": "DataSource", @@ -4195,6 +4295,10 @@ "description": "A chart embedded in a sheet.", "id": "EmbeddedChart", "properties": { + "border": { + "$ref": "EmbeddedObjectBorder", + "description": "The border of the chart." + }, "chartId": { "description": "The ID of the chart.", "format": "int32", @@ -4211,6 +4315,21 @@ }, "type": "object" }, + "EmbeddedObjectBorder": { + "description": "A border along an embedded object.", + "id": "EmbeddedObjectBorder", + "properties": { + "color": { + "$ref": "Color", + "description": "The color of the border." + }, + "colorStyle": { + "$ref": "ColorStyle", + "description": "The color of the border. If color is also set, this field takes precedence." + } + }, + "type": "object" + }, "EmbeddedObjectPosition": { "description": "The position of an embedded object such as a chart.", "id": "EmbeddedObjectPosition", @@ -5267,6 +5386,14 @@ "description": "Criteria for showing/hiding rows in a pivot table.", "id": "PivotFilterCriteria", "properties": { + "condition": { + "$ref": "BooleanCondition", + "description": "A condition that must be true for values to be shown. (`visibleValues` does not override this -- even if a value is listed there, it is still hidden if it does not meet the condition.) Condition values that refer to ranges in A1-notation are evaluated relative to the pivot table sheet. References are treated absolutely, so are not filled down the pivot table. For example, a condition value of `=A1` on \"Pivot Table 1\" is treated as `'Pivot Table 1'!$A$1`. The source data of the pivot table can be referenced by column header name. For example, if the source data has columns named \"Revenue\" and \"Cost\" and a condition is applied to the \"Revenue\" column with type `NUMBER_GREATER` and value `=Cost`, then only columns where \"Revenue\" > \"Cost\" are included." + }, + "visibleByDefault": { + "description": "Whether values are visible by default. If true, the visible_values are ignored, all values that meet condition (if specified) are shown. If false, values that are both in visible_values and meet condition are shown.", + "type": "boolean" + }, "visibleValues": { "description": "Values that should be included. Values not listed here are excluded.", "items": { @@ -5573,6 +5700,44 @@ }, "type": "object" }, + "PointStyle": { + "description": "The style of a point on the chart.", + "id": "PointStyle", + "properties": { + "shape": { + "description": "The point shape. If empty or unspecified, a default shape is used.", + "enum": [ + "POINT_SHAPE_UNSPECIFIED", + "CIRCLE", + "DIAMOND", + "HEXAGON", + "PENTAGON", + "SQUARE", + "STAR", + "TRIANGLE", + "X_MARK" + ], + "enumDescriptions": [ + "Default value.", + "A circle shape.", + "A diamond shape.", + "A hexagon shape.", + "A pentagon shape.", + "A square shape.", + "A star shape.", + "A triangle shape.", + "An x-mark shape." + ], + "type": "string" + }, + "size": { + "description": "The point size. If empty, a default size is used.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "ProtectedRange": { "description": "A protected range.", "id": "ProtectedRange", @@ -5931,6 +6096,10 @@ "$ref": "UpdateDimensionPropertiesRequest", "description": "Updates dimensions' properties." }, + "updateEmbeddedObjectBorder": { + "$ref": "UpdateEmbeddedObjectBorderRequest", + "description": "Updates an embedded object's border." + }, "updateEmbeddedObjectPosition": { "$ref": "UpdateEmbeddedObjectPositionRequest", "description": "Updates an embedded object's (e.g. chart, image) position." @@ -7228,6 +7397,27 @@ }, "type": "object" }, + "UpdateEmbeddedObjectBorderRequest": { + "description": "Updates an embedded object's border property.", + "id": "UpdateEmbeddedObjectBorderRequest", + "properties": { + "border": { + "$ref": "EmbeddedObjectBorder", + "description": "The border that applies to the embedded object." + }, + "fields": { + "description": "The fields that should be updated. At least one field must be specified. The root `border` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, + "objectId": { + "description": "The ID of the embedded object to update.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "UpdateEmbeddedObjectPositionRequest": { "description": "Update an embedded object's position (such as a moving or resizing a chart or image).", "id": "UpdateEmbeddedObjectPositionRequest", @@ -7533,6 +7723,10 @@ "$ref": "ChartData", "description": "The data being visualized in this series." }, + "dataLabel": { + "$ref": "DataLabel", + "description": "Information about the data labels for this series." + }, "hideTrailingSubtotal": { "description": "True to hide the subtotal column from the end of the series. By default, a subtotal column will appear at the end of each series. Setting this field to true will hide that subtotal column for this series.", "type": "boolean" @@ -7592,6 +7786,10 @@ "Series will spread out along the horizontal axis." ], "type": "string" + }, + "totalDataLabel": { + "$ref": "DataLabel", + "description": "Controls whether to display additional data labels on stacked charts which sum the total value of all stacked values at each value along the domain axis. stacked_type must be STACKED and neither CUSTOM nor placement can be set on the total_data_label." } }, "type": "object"
diff --git a/discovery/googleapis/slides__v1.json b/discovery/googleapis/slides__v1.json index 3b7fd37..69828f5 100644 --- a/discovery/googleapis/slides__v1.json +++ b/discovery/googleapis/slides__v1.json
@@ -306,7 +306,7 @@ } } }, - "revision": "20200929", + "revision": "20210128", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { @@ -387,6 +387,39 @@ }, "type": "object" }, + "Autofit": { + "description": "The autofit properties of a Shape.", + "id": "Autofit", + "properties": { + "autofitType": { + "description": "The autofit type of the shape. If unspecified, the autofit type is inherited from a parent placeholder if it exists. The field will be automatically set to NONE if a request is made that may affect text fitting within its bounding text box. In this case the font_scale will be applied to the font_size and the line_spacing_reduction will be applied to the line_spacing. Both properties would also be reset to default values.", + "enum": [ + "AUTOFIT_TYPE_UNSPECIFIED", + "NONE", + "TEXT_AUTOFIT", + "SHAPE_AUTOFIT" + ], + "enumDescriptions": [ + "The autofit type is unspecified.", + "Do not autofit.", + "Shrink text on overflow to fit shape.", + "Resize shape to fit text." + ], + "type": "string" + }, + "fontScale": { + "description": "The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value will be the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size will give the font size that is rendered in the editor. This property is read-only.", + "format": "float", + "type": "number" + }, + "lineSpacingReduction": { + "description": "The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value will be the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing will give the line spacing that is rendered in the editor. This property is read-only.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "BatchUpdatePresentationRequest": { "description": "Request message for PresentationsService.BatchUpdatePresentation.", "id": "BatchUpdatePresentationRequest", @@ -2317,7 +2350,7 @@ }, "notesMaster": { "$ref": "Page", - "description": "The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appears on all notes pages. The notes master is read-only." + "description": "The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only." }, "pageSize": { "$ref": "Size", @@ -3323,9 +3356,13 @@ "type": "object" }, "ShapeProperties": { - "description": "The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value.", + "description": "The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape.", "id": "ShapeProperties", "properties": { + "autofit": { + "$ref": "Autofit", + "description": "The autofit properties of the shape. This property is only set for shapes that allow text." + }, "contentAlignment": { "description": "The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor.", "enum": [
diff --git a/discovery/googleapis/smartdevicemanagement__v1.json b/discovery/googleapis/smartdevicemanagement__v1.json new file mode 100644 index 0000000..e358292 --- /dev/null +++ b/discovery/googleapis/smartdevicemanagement__v1.json
@@ -0,0 +1,524 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/sdm.service": { + "description": "See and/or control the devices that you selected" + } + } + } + }, + "basePath": "", + "baseUrl": "https://smartdevicemanagement.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Smart Device Management", + "description": "Allow select enterprise partners to access, control, and manage Google and Nest devices programmatically.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/nest/device-access", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "smartdevicemanagement:v1", + "kind": "discovery#restDescription", + "name": "smartdevicemanagement", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "enterprises": { + "resources": { + "devices": { + "methods": { + "executeCommand": { + "description": "Executes a command to device managed by the enterprise.", + "httpMethod": "POST", + "id": "smartdevicemanagement.enterprises.devices.executeCommand", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the device requested. For example: \"enterprises/XYZ/devices/123\"", + "location": "path", + "pattern": "^enterprises/[^/]+/devices/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:executeCommand", + "request": { + "$ref": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest" + }, + "response": { + "$ref": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + }, + "get": { + "description": "Gets a device managed by the enterprise.", + "httpMethod": "GET", + "id": "smartdevicemanagement.enterprises.devices.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the device requested. For example: \"enterprises/XYZ/devices/123\"", + "location": "path", + "pattern": "^enterprises/[^/]+/devices/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleHomeEnterpriseSdmV1Device" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + }, + "list": { + "description": "Lists devices managed by the enterprise.", + "httpMethod": "GET", + "id": "smartdevicemanagement.enterprises.devices.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional requested page size. Server may return fewer devices than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional token of the page to retrieve.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent enterprise to list devices under. E.g. \"enterprises/XYZ\".", + "location": "path", + "pattern": "^enterprises/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/devices", + "response": { + "$ref": "GoogleHomeEnterpriseSdmV1ListDevicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + } + } + }, + "structures": { + "methods": { + "get": { + "description": "Gets a structure managed by the enterprise.", + "httpMethod": "GET", + "id": "smartdevicemanagement.enterprises.structures.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the structure requested. For example: \"enterprises/XYZ/structures/ABC\".", + "location": "path", + "pattern": "^enterprises/[^/]+/structures/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleHomeEnterpriseSdmV1Structure" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + }, + "list": { + "description": "Lists structures managed by the enterprise.", + "httpMethod": "GET", + "id": "smartdevicemanagement.enterprises.structures.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional filter to list structures.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Server may return fewer structures than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token of the page to retrieve.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent enterprise to list structures under. E.g. \"enterprises/XYZ\".", + "location": "path", + "pattern": "^enterprises/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/structures", + "response": { + "$ref": "GoogleHomeEnterpriseSdmV1ListStructuresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + } + }, + "resources": { + "rooms": { + "methods": { + "get": { + "description": "Gets a room managed by the enterprise.", + "httpMethod": "GET", + "id": "smartdevicemanagement.enterprises.structures.rooms.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the room requested. For example: \"enterprises/XYZ/structures/ABC/rooms/123\".", + "location": "path", + "pattern": "^enterprises/[^/]+/structures/[^/]+/rooms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleHomeEnterpriseSdmV1Room" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + }, + "list": { + "description": "Lists rooms managed by the enterprise.", + "httpMethod": "GET", + "id": "smartdevicemanagement.enterprises.structures.rooms.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Requested page size. Server may return fewer rooms than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token of the page to retrieve.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent resource name of the rooms requested. For example: \"enterprises/XYZ/structures/ABC\".", + "location": "path", + "pattern": "^enterprises/[^/]+/structures/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/rooms", + "response": { + "$ref": "GoogleHomeEnterpriseSdmV1ListRoomsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/sdm.service" + ] + } + } + } + } + } + } + } + }, + "revision": "20210122", + "rootUrl": "https://smartdevicemanagement.googleapis.com/", + "schemas": { + "GoogleHomeEnterpriseSdmV1Device": { + "description": "Device resource represents an instance of enterprise managed device in the property.", + "id": "GoogleHomeEnterpriseSdmV1Device", + "properties": { + "name": { + "description": "Required. The resource name of the device. For example: \"enterprises/XYZ/devices/123\".", + "type": "string" + }, + "parentRelations": { + "description": "Assignee details of the device.", + "items": { + "$ref": "GoogleHomeEnterpriseSdmV1ParentRelation" + }, + "type": "array" + }, + "traits": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. Device traits.", + "readOnly": true, + "type": "object" + }, + "type": { + "description": "Output only. Type of the device for general display purposes. For example: \"THERMOSTAT\". The device type should not be used to deduce or infer functionality of the actual device it is assigned to. Instead, use the returned traits for the device.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest": { + "description": "Request message for SmartDeviceManagementService.ExecuteDeviceCommand", + "id": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandRequest", + "properties": { + "command": { + "description": "The command name to execute, represented by the fully qualified protobuf message name.", + "type": "string" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The command message to execute, represented as a Struct.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse": { + "description": "Response message for SmartDeviceManagementService.ExecuteDeviceCommand", + "id": "GoogleHomeEnterpriseSdmV1ExecuteDeviceCommandResponse", + "properties": { + "results": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The results of executing the command.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1ListDevicesResponse": { + "description": "Response message for SmartDeviceManagementService.ListDevices", + "id": "GoogleHomeEnterpriseSdmV1ListDevicesResponse", + "properties": { + "devices": { + "description": "The list of devices.", + "items": { + "$ref": "GoogleHomeEnterpriseSdmV1Device" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The pagination token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1ListRoomsResponse": { + "description": "Response message for SmartDeviceManagementService.ListRooms", + "id": "GoogleHomeEnterpriseSdmV1ListRoomsResponse", + "properties": { + "nextPageToken": { + "description": "The pagination token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "rooms": { + "description": "The list of rooms.", + "items": { + "$ref": "GoogleHomeEnterpriseSdmV1Room" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1ListStructuresResponse": { + "description": "Response message for SmartDeviceManagementService.ListStructures", + "id": "GoogleHomeEnterpriseSdmV1ListStructuresResponse", + "properties": { + "nextPageToken": { + "description": "The pagination token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "structures": { + "description": "The list of structures.", + "items": { + "$ref": "GoogleHomeEnterpriseSdmV1Structure" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1ParentRelation": { + "description": "Represents device relationships, for instance, structure/room to which the device is assigned to. For now this is only filled in the enterprise flow.", + "id": "GoogleHomeEnterpriseSdmV1ParentRelation", + "properties": { + "displayName": { + "description": "Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to.", + "readOnly": true, + "type": "string" + }, + "parent": { + "description": "Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: \"enterprises/XYZ/structures/ABC\" or \"enterprises/XYZ/structures/ABC/rooms/123\"", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1Room": { + "description": "Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.", + "id": "GoogleHomeEnterpriseSdmV1Room", + "properties": { + "name": { + "description": "Output only. The resource name of the room. For example: \"enterprises/XYZ/structures/ABC/rooms/123\".", + "readOnly": true, + "type": "string" + }, + "traits": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Room traits.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleHomeEnterpriseSdmV1Structure": { + "description": "Structure resource represents an instance of enterprise managed home or hotel room.", + "id": "GoogleHomeEnterpriseSdmV1Structure", + "properties": { + "name": { + "description": "Output only. The resource name of the structure. For example: \"enterprises/XYZ/structures/ABC\".", + "readOnly": true, + "type": "string" + }, + "traits": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structure traits.", + "type": "object" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Smart Device Management API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/sourcerepo__v1.json b/discovery/googleapis/sourcerepo__v1.json index 357a4d6..ee02e9e 100644 --- a/discovery/googleapis/sourcerepo__v1.json +++ b/discovery/googleapis/sourcerepo__v1.json
@@ -437,7 +437,7 @@ } } }, - "revision": "20200920", + "revision": "20201024", "rootUrl": "https://sourcerepo.googleapis.com/", "schemas": { "AuditConfig": {
diff --git a/discovery/googleapis/spanner__v1.json b/discovery/googleapis/spanner__v1.json index 05f25b6..9e24b49 100644 --- a/discovery/googleapis/spanner__v1.json +++ b/discovery/googleapis/spanner__v1.json
@@ -303,6 +303,12 @@ "location": "query", "type": "string" }, + "instanceDeadline": { + "description": "Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.", "format": "int32", @@ -1836,7 +1842,7 @@ } } }, - "revision": "20201001", + "revision": "20210128", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Backup": { @@ -1844,7 +1850,7 @@ "id": "Backup", "properties": { "createTime": { - "description": "Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by `create_time`. `create_time` is approximately the time the CreateBackup request is received.", + "description": "Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1890,6 +1896,11 @@ ], "readOnly": true, "type": "string" + }, + "versionTime": { + "description": "The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -1903,13 +1914,18 @@ "type": "string" }, "createTime": { - "description": "The backup contains an externally consistent copy of `source_database` at the timestamp specified by `create_time`.", + "description": "The time the CreateBackup request was received.", "format": "google-datetime", "type": "string" }, "sourceDatabase": { "description": "Name of the database the backup was created from.", "type": "string" + }, + "versionTime": { + "description": "The backup contains an externally consistent copy of `source_database` at the timestamp specified by `version_time`. If the CreateBackup request did not specify `version_time`, the `version_time` of the backup is equivalent to the `create_time`.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -1959,10 +1975,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -2012,6 +2024,10 @@ }, "type": "array" }, + "returnCommitStats": { + "description": "If `true`, then statistics related to the transaction will be included in the CommitResponse. Default value is `false`.", + "type": "boolean" + }, "singleUseTransaction": { "$ref": "TransactionOptions", "description": "Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead." @@ -2028,6 +2044,10 @@ "description": "The response for Commit.", "id": "CommitResponse", "properties": { + "commitStats": { + "$ref": "CommitStats", + "description": "The statistics about this Commit. Not returned by default. For more information, see CommitRequest.return_commit_stats." + }, "commitTimestamp": { "description": "The Cloud Spanner timestamp at which the transaction committed.", "format": "google-datetime", @@ -2036,6 +2056,18 @@ }, "type": "object" }, + "CommitStats": { + "description": "Additional statistics about a commit.", + "id": "CommitStats", + "properties": { + "mutationCount": { + "description": "The total number of mutations for the transaction. Knowing the `mutation_count` value can help you maximize the number of mutations in a transaction and minimize the number of API round trips. You can also monitor this value to prevent transactions from exceeding the system [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data). If the number of mutations exceeds the limit, the server returns [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "CreateBackupMetadata": { "description": "Metadata type for the operation returned by CreateBackup.", "id": "CreateBackupMetadata", @@ -2151,6 +2183,12 @@ "readOnly": true, "type": "string" }, + "earliestVersionTime": { + "description": "Output only. Earliest timestamp at which older versions of the data can be read.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "name": { "description": "Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.", "type": "string" @@ -2176,6 +2214,11 @@ ], "readOnly": true, "type": "string" + }, + "versionRetentionPeriod": { + "description": "Output only. The period in which Cloud Spanner retains all versions of data for the database. This is same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -2333,7 +2376,7 @@ "id": "Field", "properties": { "name": { - "description": "The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `\"Word\"` in the query `\"SELECT 'hello' AS Word\"`), or the column name (e.g., `\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some columns might have an empty name (e.g., !\"SELECT UPPER(ColName)\"`). Note that a query result can contain multiple fields with the same name.", + "description": "The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `\"Word\"` in the query `\"SELECT 'hello' AS Word\"`), or the column name (e.g., `\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some columns might have an empty name (e.g., `\"SELECT UPPER(ColName)\"`). Note that a query result can contain multiple fields with the same name.", "type": "string" }, "type": { @@ -2622,6 +2665,13 @@ "nextPageToken": { "description": "`next_page_token` can be sent in a subsequent ListInstances call to fetch more of the matching instances.", "type": "string" + }, + "unreachable": { + "description": "The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3573,6 +3623,11 @@ "type": "string" }, "type": "array" + }, + "throttled": { + "description": "Output only. When true, indicates that the operation is throttled e.g due to resource constraints. When resources become available the operation will resume and this field will be false again.", + "readOnly": true, + "type": "boolean" } }, "type": "object"
diff --git a/discovery/googleapis/speech__v1.json b/discovery/googleapis/speech__v1.json index daab64f..98bf195 100644 --- a/discovery/googleapis/speech__v1.json +++ b/discovery/googleapis/speech__v1.json
@@ -282,7 +282,7 @@ } } }, - "revision": "20201001", + "revision": "20210121", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ListOperationsResponse": {
diff --git a/discovery/googleapis/storage__v1.json b/discovery/googleapis/storage__v1.json index e088447..4b87545 100644 --- a/discovery/googleapis/storage__v1.json +++ b/discovery/googleapis/storage__v1.json
@@ -26,7 +26,7 @@ "description": "Stores and retrieves potentially large, immutable data objects.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/storage/docs/json_api/", - "etag": "\"35303833373931373037353237393631383738\"", + "etag": "\"32333630343231393539393333303137343031\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -3229,7 +3229,7 @@ } } }, - "revision": "20201003", + "revision": "20210131", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { @@ -3336,6 +3336,10 @@ }, "type": "object" }, + "publicAccessPrevention": { + "description": "The bucket's Public Access Prevention configuration. Currently, 'unspecified' and 'enforced' are supported.", + "type": "string" + }, "uniformBucketLevelAccess": { "description": "The bucket's uniform bucket-level access configuration.", "properties": { @@ -3531,6 +3535,10 @@ }, "type": "object" }, + "satisfiesPZS": { + "description": "Reserved for future use.", + "type": "boolean" + }, "selfLink": { "description": "The URI of this bucket.", "type": "string"
diff --git a/discovery/googleapis/storagetransfer__v1.json b/discovery/googleapis/storagetransfer__v1.json index 9e0779c..c5d17e2 100644 --- a/discovery/googleapis/storagetransfer__v1.json +++ b/discovery/googleapis/storagetransfer__v1.json
@@ -153,7 +153,8 @@ "httpMethod": "GET", "id": "storagetransfer.transferJobs.get", "parameterOrder": [ - "jobName" + "jobName", + "projectId" ], "parameters": { "jobName": { @@ -166,6 +167,7 @@ "projectId": { "description": "Required. The ID of the Google Cloud Platform Console project that owns the job.", "location": "query", + "required": true, "type": "string" } }, @@ -181,11 +183,14 @@ "description": "Lists transfer jobs.", "httpMethod": "GET", "id": "storagetransfer.transferJobs.list", - "parameterOrder": [], + "parameterOrder": [ + "filter" + ], "parameters": { "filter": { - "description": "Required. A list of query parameters specified as JSON text in the form of: {\"project_id\":\"my_project_id\", \"job_names\":[\"jobid1\",\"jobid2\",...], \"job_statuses\":[\"status1\",\"status2\",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project``_``id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: ENABLED, DISABLED, and DELETED.", + "description": "Required. A list of query parameters specified as JSON text in the form of: `{\"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"jobStatuses\":[\"status1\",\"status2\",...]}` Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `projectId` is required. `jobNames` and `jobStatuses` are optional. The valid values for `jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED.", "location": "query", + "required": true, "type": "string" }, "pageSize": { @@ -209,7 +214,7 @@ ] }, "patch": { - "description": "Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating a job's schedule is not allowed. **Note:** The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).", + "description": "Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. **Note:** The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).", "httpMethod": "PATCH", "id": "storagetransfer.transferJobs.patch", "parameterOrder": [ @@ -295,12 +300,14 @@ "httpMethod": "GET", "id": "storagetransfer.transferOperations.list", "parameterOrder": [ - "name" + "name", + "filter" ], "parameters": { "filter": { - "description": "Required. A list of query parameters specified as JSON text in the form of: {\"project_id\":\"my_project_id\", \"job_names\":[\"jobid1\",\"jobid2\",...], \"operation_names\":[\"opid1\",\"opid2\",...], \"transfer_statuses\":[\"status1\",\"status2\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project``_``id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.", + "description": "Required. A list of query parameters specified as JSON text in the form of: `{\"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"operationNames\":[\"opid1\",\"opid2\",...], \"transferStatuses\":[\"status1\",\"status2\",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is required. `jobNames`, `operationNames`, and `transferStatuses` are optional. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.", "location": "query", + "required": true, "type": "string" }, "name": { @@ -387,11 +394,11 @@ } } }, - "revision": "20201001", + "revision": "20210121", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AwsAccessKey": { - "description": "AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).", + "description": "AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). For information on our data retention policy for user credentials, see [User credentials](data-retention#user-credentials).", "id": "AwsAccessKey", "properties": { "accessKeyId": { @@ -411,11 +418,15 @@ "properties": { "awsAccessKey": { "$ref": "AwsAccessKey", - "description": "Required. Input only. AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key." + "description": "Required. Input only. AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. For information on our data retention policy for user credentials, see [User credentials](data-retention#user-credentials)." }, "bucketName": { "description": "Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).", "type": "string" + }, + "path": { + "description": "Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.", + "type": "string" } }, "type": "object" @@ -426,12 +437,16 @@ "properties": { "azureCredentials": { "$ref": "AzureCredentials", - "description": "Required. Input only. Credentials used to authenticate API requests to Azure." + "description": "Required. Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see [User credentials](data-retention#user-credentials)." }, "container": { "description": "Required. The container to transfer from the Azure Storage account.", "type": "string" }, + "path": { + "description": "Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.", + "type": "string" + }, "storageAccount": { "description": "Required. The name of the Azure Storage account.", "type": "string" @@ -440,7 +455,7 @@ "type": "object" }, "AzureCredentials": { - "description": "Azure credentials", + "description": "Azure credentials For information on our data retention policy for user credentials, see [User credentials](data-retention#user-credentials).", "id": "AzureCredentials", "properties": { "sasToken": { @@ -457,21 +472,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -570,6 +585,10 @@ "bucketName": { "description": "Required. Cloud Storage bucket name (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/naming#requirements)).", "type": "string" + }, + "path": { + "description": "Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. (must meet Object Name Requirements](https://cloud.google.com/storage/docs/naming#objectnames)).", + "type": "string" } }, "type": "object" @@ -586,7 +605,7 @@ "type": "object" }, "HttpData": { - "description": "An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `\"TsvHttpData-1.0\"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see [Generating MD5 hashes](https://cloud.google.com/storage-transfer/docs/create-url-list#md5) * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer.", + "description": "An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `\"TsvHttpData-1.0\"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/` is transferred to a data sink, the name of the object at the data sink is `/`. * If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer.", "id": "HttpData", "properties": { "listUrl": { @@ -768,6 +787,15 @@ "description": "Transfers can be scheduled to recur or to run just once.", "id": "Schedule", "properties": { + "endTimeOfDay": { + "$ref": "TimeOfDay", + "description": "The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, `end_time_of_day` specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following: * If `end_time_of_day` is not set and `schedule_end_date` is set, then a default value of `23:59:59` is used for `end_time_of_day`. * If `end_time_of_day` is set and `schedule_end_date` is not set, then INVALID_ARGUMENT is returned." + }, + "repeatInterval": { + "description": "Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.", + "format": "google-duration", + "type": "string" + }, "scheduleEndDate": { "$ref": "Date", "description": "The last day a transfer runs. Date boundaries are determined relative to UTC time. A job will run once per 24 hours within the following guidelines: * If `schedule_end_date` and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * If `schedule_end_date` is later than `schedule_start_date` and `schedule_end_date` is in the future relative to UTC, the job will run each day at start_time_of_day through `schedule_end_date`." @@ -950,6 +978,10 @@ "readOnly": true, "type": "string" }, + "latestOperationName": { + "description": "The name of the most recently started TransferOperation of this JobConfig. Present if and only if at least one TransferOperation has been created for this JobConfig.", + "type": "string" + }, "name": { "description": "A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `\"transferJobs/\"` prefix and end with a letter or a number, and should be no more than 128 characters. Example: `\"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$\"` Invalid job names will fail with an INVALID_ARGUMENT error.", "type": "string" @@ -1072,7 +1104,7 @@ "type": "boolean" }, "overwriteObjectsAlreadyExistingInSink": { - "description": "Whether overwriting objects that already exist in the sink is allowed.", + "description": "When to overwrite objects that already exist in the sink. The default is that only objects that are different from the source are ovewritten. If true, all objects in the sink whose name matches an object in the source will be overwritten with the source object.", "type": "boolean" } },
diff --git a/discovery/googleapis/streetviewpublish__v1.json b/discovery/googleapis/streetviewpublish__v1.json index 9c06be5..f8ecc86 100644 --- a/discovery/googleapis/streetviewpublish__v1.json +++ b/discovery/googleapis/streetviewpublish__v1.json
@@ -187,7 +187,7 @@ ] }, "startUpload": { - "description": "Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo metadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry.", + "description": "Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo metadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry.", "httpMethod": "POST", "id": "streetviewpublish.photo.startUpload", "parameterOrder": [], @@ -364,7 +364,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { @@ -455,7 +455,7 @@ "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": { @@ -766,7 +766,7 @@ "id": "UploadRef", "properties": { "uploadUrl": { - "description": "Required. An upload reference should be unique for each user. It follows the form: \"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"", + "description": "An upload reference should be unique for each user. It follows the form: \"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"", "type": "string" } },
diff --git a/discovery/googleapis/sts__v1.json b/discovery/googleapis/sts__v1.json new file mode 100644 index 0000000..77ef191 --- /dev/null +++ b/discovery/googleapis/sts__v1.json
@@ -0,0 +1,183 @@ +{ + "basePath": "", + "baseUrl": "https://sts.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Security Token", + "description": "The Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources.", + "discoveryVersion": "v1", + "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "sts:v1", + "kind": "discovery#restDescription", + "name": "sts", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "v1": { + "methods": { + "token": { + "description": "Exchanges a credential for a Google OAuth 2.0 access token.", + "httpMethod": "POST", + "id": "sts.token", + "parameterOrder": [], + "parameters": {}, + "path": "v1/token", + "request": { + "$ref": "GoogleIdentityStsV1ExchangeTokenRequest" + }, + "response": { + "$ref": "GoogleIdentityStsV1ExchangeTokenResponse" + } + } + } + } + }, + "revision": "20210124", + "rootUrl": "https://sts.googleapis.com/", + "schemas": { + "GoogleIdentityStsV1ExchangeTokenRequest": { + "description": "Request message for ExchangeToken.", + "id": "GoogleIdentityStsV1ExchangeTokenRequest", + "properties": { + "audience": { + "description": "The full resource name of the identity provider; for example: `//iam.googleapis.com/projects//workloadIdentityPools//providers/`. Required when exchanging an external credential for a Google access token.", + "type": "string" + }, + "grantType": { + "description": "Required. The grant type. Must be `urn:ietf:params:oauth:grant-type:token-exchange`, which indicates a token exchange.", + "type": "string" + }, + "options": { + "description": "A set of features that Security Token Service supports, in addition to the standard OAuth 2.0 token exchange, formatted as a serialized JSON object of Options.", + "type": "string" + }, + "requestedTokenType": { + "description": "Required. An identifier for the type of requested security token. Must be `urn:ietf:params:oauth:token-type:access_token`.", + "type": "string" + }, + "scope": { + "description": "The OAuth 2.0 scopes to include on the resulting access token, formatted as a list of space-delimited, case-sensitive strings. Required when exchanging an external credential for a Google access token.", + "type": "string" + }, + "subjectToken": { + "description": "Required. The input token. You can use a Google-issued OAuth 2.0 access token with this field to obtain an access token with new security attributes applied, such as a Credential Access Boundary. If an access token already contains security attributes, you cannot apply additional security attributes.", + "type": "string" + }, + "subjectTokenType": { + "description": "Required. An identifier that indicates the type of the security token in the `subject_token` parameter. Must be `urn:ietf:params:oauth:token-type:access_token`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleIdentityStsV1ExchangeTokenResponse": { + "description": "Response message for ExchangeToken.", + "id": "GoogleIdentityStsV1ExchangeTokenResponse", + "properties": { + "access_token": { + "description": "An OAuth 2.0 security token, issued by Google, in response to the token exchange request.", + "type": "string" + }, + "expires_in": { + "description": "The amount of time, in seconds, between the time when the access token was issued and the time when the access token will expire. This field is absent when the `subject_token` in the request is a Google-issued, short-lived access token. In this case, the access token has the same expiration time as the `subject_token`.", + "format": "int32", + "type": "integer" + }, + "issued_token_type": { + "description": "The token type. Always matches the value of `requested_token_type` from the request.", + "type": "string" + }, + "token_type": { + "description": "The type of access token. Always has the value `Bearer`.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Security Token Service API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/tagmanager__v1.json b/discovery/googleapis/tagmanager__v1.json index c30f420..56c5501 100644 --- a/discovery/googleapis/tagmanager__v1.json +++ b/discovery/googleapis/tagmanager__v1.json
@@ -1882,7 +1882,7 @@ } } }, - "revision": "20201007", + "revision": "20210201", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": {
diff --git a/discovery/googleapis/tagmanager__v2.json b/discovery/googleapis/tagmanager__v2.json index 14f987b..fa2af86 100644 --- a/discovery/googleapis/tagmanager__v2.json +++ b/discovery/googleapis/tagmanager__v2.json
@@ -3044,7 +3044,7 @@ } } }, - "revision": "20201007", + "revision": "20210201", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -3714,6 +3714,10 @@ "description": "Container version display name.", "type": "string" }, + "numClients": { + "description": "Number of clients in the container version.", + "type": "string" + }, "numCustomTemplates": { "description": "Number of custom templates in the container version.", "type": "string" @@ -3869,9 +3873,13 @@ ], "type": "string" }, + "client": { + "$ref": "Client", + "description": "The client being represented by the entity." + }, "folder": { "$ref": "Folder", - "description": "The Folder being represented by the entity." + "description": "The folder being represented by the entity." }, "tag": { "$ref": "Tag",
diff --git a/discovery/googleapis/tasks__v1.json b/discovery/googleapis/tasks__v1.json index e6c5e7c..ba42e38 100644 --- a/discovery/googleapis/tasks__v1.json +++ b/discovery/googleapis/tasks__v1.json
@@ -550,11 +550,10 @@ } } }, - "revision": "20201006", + "revision": "20210202", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "Task": { - "description": "LINT.IfChange", "id": "Task", "properties": { "completed": {
diff --git a/discovery/googleapis/testing__v1.json b/discovery/googleapis/testing__v1.json index fd23079..3f31587 100644 --- a/discovery/googleapis/testing__v1.json +++ b/discovery/googleapis/testing__v1.json
@@ -161,7 +161,7 @@ ] }, "create": { - "description": "Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. Matrices are limited to at most 200 supported executions. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix expands to more than 200 supported executions", + "description": "Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. A test matrix is limited to use at most 2000 devices in parallel. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix tries to use too many simultaneous devices.", "httpMethod": "POST", "id": "testing.projects.testMatrices.create", "parameterOrder": [ @@ -276,7 +276,7 @@ } } }, - "revision": "20201001", + "revision": "20210201", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -547,7 +547,7 @@ "type": "object" }, "AndroidRoboTest": { - "description": "A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes. Next tag: 29", + "description": "A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes. Next tag: 30", "id": "AndroidRoboTest", "properties": { "appApk": { @@ -748,6 +748,13 @@ "description": "Specifies the API Level on which the application is designed to run.", "format": "int32", "type": "integer" + }, + "usesPermission": { + "description": "Permissions declared to be used by the application", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -834,21 +841,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -1134,7 +1141,7 @@ "type": "object" }, "IosModel": { - "description": "A description of an iOS device tests may be run on. Next tag: 13", + "description": "A description of an iOS device tests may be run on.", "id": "IosModel", "properties": { "deviceCapabilities": { @@ -1375,7 +1382,7 @@ "id": "ManualSharding", "properties": { "testTargetsForShard": { - "description": "Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 250.", + "description": "Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500.", "items": { "$ref": "TestTargetsForShard" }, @@ -1751,6 +1758,10 @@ "$ref": "EnvironmentMatrix", "description": "Required. The devices the tests are being executed on." }, + "failFast": { + "description": "If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation.", + "type": "boolean" + }, "flakyTestAttempts": { "description": "The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.", "format": "int32", @@ -2120,7 +2131,7 @@ "id": "UniformSharding", "properties": { "numShards": { - "description": "Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 250.", + "description": "Required. Total number of shards. When any physical devices are selected, the number must be >= 1 and <= 50. When no physical devices are selected, the number must be >= 1 and <= 500.", "format": "int32", "type": "integer" }
diff --git a/discovery/googleapis/texttospeech__v1.json b/discovery/googleapis/texttospeech__v1.json index a853e95..fa2054c 100644 --- a/discovery/googleapis/texttospeech__v1.json +++ b/discovery/googleapis/texttospeech__v1.json
@@ -149,7 +149,7 @@ } } }, - "revision": "20201002", + "revision": "20210122", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": {
diff --git a/discovery/googleapis/tpu__v1.json b/discovery/googleapis/tpu__v1.json index 3f6cf4f..346a799 100644 --- a/discovery/googleapis/tpu__v1.json +++ b/discovery/googleapis/tpu__v1.json
@@ -184,7 +184,7 @@ ], "parameters": { "name": { - "description": "The resource name.", + "description": "Required. The resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/acceleratorTypes/[^/]+$", "required": true, @@ -229,7 +229,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name.", + "description": "Required. The parent resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -262,7 +262,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name.", + "description": "Required. The parent resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -289,7 +289,7 @@ ], "parameters": { "name": { - "description": "The resource name.", + "description": "Required. The resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "required": true, @@ -313,7 +313,7 @@ ], "parameters": { "name": { - "description": "The resource name.", + "description": "Required. The resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", "required": true, @@ -348,7 +348,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name.", + "description": "Required. The parent resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -573,7 +573,7 @@ ], "parameters": { "name": { - "description": "The resource name.", + "description": "Required. The resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tensorflowVersions/[^/]+$", "required": true, @@ -618,7 +618,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name.", + "description": "Required. The parent resource name.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -640,7 +640,7 @@ } } }, - "revision": "20200909", + "revision": "20201023", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { @@ -830,7 +830,7 @@ "id": "Node", "properties": { "acceleratorType": { - "description": "The type of hardware accelerators associated with this node. Required.", + "description": "Required. The type of hardware accelerators associated with this node.", "type": "string" }, "cidrBlock": { @@ -840,6 +840,7 @@ "createTime": { "description": "Output only. The time when the node was created.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "description": { @@ -868,6 +869,7 @@ }, "healthDescription": { "description": "Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.", + "readOnly": true, "type": "string" }, "ipAddress": { @@ -882,7 +884,8 @@ "type": "object" }, "name": { - "description": "Output only. The immutable name of the TPU", + "description": "Output only. Immutable. The name of the TPU", + "readOnly": true, "type": "string" }, "network": { @@ -894,6 +897,7 @@ "items": { "$ref": "NetworkEndpoint" }, + "readOnly": true, "type": "array" }, "port": { @@ -901,10 +905,12 @@ "type": "string" }, "schedulingConfig": { - "$ref": "SchedulingConfig" + "$ref": "SchedulingConfig", + "description": "The scheduling options for this node." }, "serviceAccount": { "description": "Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.", + "readOnly": true, "type": "string" }, "state": { @@ -943,6 +949,7 @@ "TPU node has been hidden.", "TPU node is currently unhiding." ], + "readOnly": true, "type": "string" }, "symptoms": { @@ -954,7 +961,7 @@ "type": "array" }, "tensorflowVersion": { - "description": "The version of Tensorflow running in the Node. Required.", + "description": "Required. The version of Tensorflow running in the Node.", "type": "string" }, "useServiceNetworking": {
diff --git a/discovery/googleapis/trafficdirector__v2.json b/discovery/googleapis/trafficdirector__v2.json new file mode 100644 index 0000000..b254a5a --- /dev/null +++ b/discovery/googleapis/trafficdirector__v2.json
@@ -0,0 +1,950 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://trafficdirector.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Traffic Director Service", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/traffic-director", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "trafficdirector:v2", + "kind": "discovery#restDescription", + "name": "trafficdirector", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "discovery": { + "methods": { + "client_status": { + "description": "", + "httpMethod": "POST", + "id": "trafficdirector.discovery.client_status", + "parameterOrder": [], + "parameters": {}, + "path": "v2/discovery:client_status", + "request": { + "$ref": "ClientStatusRequest" + }, + "response": { + "$ref": "ClientStatusResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + }, + "revision": "20210121", + "rootUrl": "https://trafficdirector.googleapis.com/", + "schemas": { + "Address": { + "description": "Addresses specify either a logical or physical address and port, which are used to tell Envoy where to bind/listen, connect to upstream and find management servers.", + "id": "Address", + "properties": { + "pipe": { + "$ref": "Pipe" + }, + "socketAddress": { + "$ref": "SocketAddress" + } + }, + "type": "object" + }, + "BuildVersion": { + "description": "BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings.", + "id": "BuildVersion", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Free-form build information. Envoy defines several well known keys in the source/common/version/version.h file", + "type": "object" + }, + "version": { + "$ref": "SemanticVersion", + "description": "SemVer version of extension." + } + }, + "type": "object" + }, + "ClientConfig": { + "description": "All xds configs for a particular client.", + "id": "ClientConfig", + "properties": { + "node": { + "$ref": "Node", + "description": "Node for a particular client." + }, + "xdsConfig": { + "items": { + "$ref": "PerXdsConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClientStatusRequest": { + "description": "Request for client status of clients identified by a list of NodeMatchers.", + "id": "ClientStatusRequest", + "properties": { + "nodeMatchers": { + "description": "Management server can use these match criteria to identify clients. The match follows OR semantics.", + "items": { + "$ref": "NodeMatcher" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClientStatusResponse": { + "id": "ClientStatusResponse", + "properties": { + "config": { + "description": "Client configs for the clients specified in the ClientStatusRequest.", + "items": { + "$ref": "ClientConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ClustersConfigDump": { + "description": "Envoy's cluster manager fills this message with all currently known clusters. Cluster configuration information can be used to recreate an Envoy configuration by populating all clusters as static clusters or by returning them in a CDS response.", + "id": "ClustersConfigDump", + "properties": { + "dynamicActiveClusters": { + "description": "The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.", + "items": { + "$ref": "DynamicCluster" + }, + "type": "array" + }, + "dynamicWarmingClusters": { + "description": "The dynamically loaded warming clusters. These are clusters that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming clusters should generally be discarded.", + "items": { + "$ref": "DynamicCluster" + }, + "type": "array" + }, + "staticClusters": { + "description": "The statically loaded cluster configs.", + "items": { + "$ref": "StaticCluster" + }, + "type": "array" + }, + "versionInfo": { + "description": "This is the :ref:`version_info ` in the last processed CDS discovery response. If there are only static bootstrap clusters, this field will be \"\".", + "type": "string" + } + }, + "type": "object" + }, + "DoubleMatcher": { + "description": "Specifies the way to match a double value.", + "id": "DoubleMatcher", + "properties": { + "exact": { + "description": "If specified, the input double value must be equal to the value specified here.", + "format": "double", + "type": "number" + }, + "range": { + "$ref": "DoubleRange", + "description": "If specified, the input double value must be in the range specified here. Note: The range is using half-open interval semantics [start, end)." + } + }, + "type": "object" + }, + "DoubleRange": { + "description": "Specifies the double start and end of the range using half-open interval semantics [start, end).", + "id": "DoubleRange", + "properties": { + "end": { + "description": "end of the range (exclusive)", + "format": "double", + "type": "number" + }, + "start": { + "description": "start of the range (inclusive)", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "DynamicCluster": { + "description": "Describes a dynamically loaded cluster via the CDS API.", + "id": "DynamicCluster", + "properties": { + "cluster": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The cluster config.", + "type": "object" + }, + "lastUpdated": { + "description": "The timestamp when the Cluster was last updated.", + "format": "google-datetime", + "type": "string" + }, + "versionInfo": { + "description": "This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the cluster was loaded. In the future, discrete per-cluster versions may be supported by the API.", + "type": "string" + } + }, + "type": "object" + }, + "DynamicListener": { + "description": "Describes a dynamically loaded listener via the LDS API. [#next-free-field: 6]", + "id": "DynamicListener", + "properties": { + "activeState": { + "$ref": "DynamicListenerState", + "description": "The listener state for any active listener by this name. These are listeners that are available to service data plane traffic." + }, + "drainingState": { + "$ref": "DynamicListenerState", + "description": "The listener state for any draining listener by this name. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded." + }, + "errorState": { + "$ref": "UpdateFailureState", + "description": "Set if the last update failed, cleared after the next successful update." + }, + "name": { + "description": "The name or unique id of this listener, pulled from the DynamicListenerState config.", + "type": "string" + }, + "warmingState": { + "$ref": "DynamicListenerState", + "description": "The listener state for any warming listener by this name. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded." + } + }, + "type": "object" + }, + "DynamicListenerState": { + "id": "DynamicListenerState", + "properties": { + "lastUpdated": { + "description": "The timestamp when the Listener was last successfully updated.", + "format": "google-datetime", + "type": "string" + }, + "listener": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The listener config.", + "type": "object" + }, + "versionInfo": { + "description": "This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the listener was loaded. In the future, discrete per-listener versions may be supported by the API.", + "type": "string" + } + }, + "type": "object" + }, + "DynamicRouteConfig": { + "id": "DynamicRouteConfig", + "properties": { + "lastUpdated": { + "description": "The timestamp when the Route was last updated.", + "format": "google-datetime", + "type": "string" + }, + "routeConfig": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The route config.", + "type": "object" + }, + "versionInfo": { + "description": "This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the route configuration was loaded.", + "type": "string" + } + }, + "type": "object" + }, + "DynamicScopedRouteConfigs": { + "id": "DynamicScopedRouteConfigs", + "properties": { + "lastUpdated": { + "description": "The timestamp when the scoped route config set was last updated.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name assigned to the scoped route configurations.", + "type": "string" + }, + "scopedRouteConfigs": { + "description": "The scoped route configurations.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "versionInfo": { + "description": "This is the per-resource version information. This version is currently taken from the :ref:`version_info ` field at the time that the scoped routes configuration was loaded.", + "type": "string" + } + }, + "type": "object" + }, + "Extension": { + "description": "Version and identification for an Envoy extension. [#next-free-field: 6]", + "id": "Extension", + "properties": { + "category": { + "description": "Category of the extension. Extension category names use reverse DNS notation. For instance \"envoy.filters.listener\" for Envoy's built-in listener filters or \"com.acme.filters.http\" for HTTP filters from acme.com vendor. [#comment:", + "type": "string" + }, + "disabled": { + "description": "Indicates that the extension is present but was disabled via dynamic configuration.", + "type": "boolean" + }, + "name": { + "description": "This is the name of the Envoy filter as specified in the Envoy configuration, e.g. envoy.filters.http.router, com.acme.widget.", + "type": "string" + }, + "typeDescriptor": { + "description": "[#not-implemented-hide:] Type descriptor of extension configuration proto. [#comment:", + "type": "string" + }, + "version": { + "$ref": "BuildVersion", + "description": "The version is a property of the extension and maintained independently of other extensions and the Envoy API. This field is not set when extension did not provide version information." + } + }, + "type": "object" + }, + "GoogleRE2": { + "description": "Google's `RE2 `_ regex engine. The regex string must adhere to the documented `syntax `_. The engine is designed to complete execution in linear time as well as limit the amount of memory used. Envoy supports program size checking via runtime. The runtime keys `re2.max_program_size.error_level` and `re2.max_program_size.warn_level` can be set to integers as the maximum program size or complexity that a compiled regex can have before an exception is thrown or a warning is logged, respectively. `re2.max_program_size.error_level` defaults to 100, and `re2.max_program_size.warn_level` has no default if unset (will not check/log a warning). Envoy emits two stats for tracking the program size of regexes: the histogram `re2.program_size`, which records the program size, and the counter `re2.exceeded_warn_level`, which is incremented each time the program size exceeds the warn level threshold.", + "id": "GoogleRE2", + "properties": { + "maxProgramSize": { + "description": "This field controls the RE2 \"program size\" which is a rough estimate of how complex a compiled regex is to evaluate. A regex that has a program size greater than the configured value will fail to compile. In this case, the configured max program size can be increased or the regex can be simplified. If not specified, the default is 100. This field is deprecated; regexp validation should be performed on the management server instead of being done by each individual client.", + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, + "InlineScopedRouteConfigs": { + "id": "InlineScopedRouteConfigs", + "properties": { + "lastUpdated": { + "description": "The timestamp when the scoped route config set was last updated.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name assigned to the scoped route configurations.", + "type": "string" + }, + "scopedRouteConfigs": { + "description": "The scoped route configurations.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListMatcher": { + "description": "Specifies the way to match a list value.", + "id": "ListMatcher", + "properties": { + "oneOf": { + "$ref": "ValueMatcher", + "description": "If specified, at least one of the values in the list must match the value specified." + } + }, + "type": "object" + }, + "ListenersConfigDump": { + "description": "Envoy's listener manager fills this message with all currently known listeners. Listener configuration information can be used to recreate an Envoy configuration by populating all listeners as static listeners or by returning them in a LDS response.", + "id": "ListenersConfigDump", + "properties": { + "dynamicListeners": { + "description": "State for any warming, active, or draining listeners.", + "items": { + "$ref": "DynamicListener" + }, + "type": "array" + }, + "staticListeners": { + "description": "The statically loaded listener configs.", + "items": { + "$ref": "StaticListener" + }, + "type": "array" + }, + "versionInfo": { + "description": "This is the :ref:`version_info ` in the last processed LDS discovery response. If there are only static bootstrap listeners, this field will be \"\".", + "type": "string" + } + }, + "type": "object" + }, + "Locality": { + "description": "Identifies location of where either Envoy runs or where upstream hosts run.", + "id": "Locality", + "properties": { + "region": { + "description": "Region this :ref:`zone ` belongs to.", + "type": "string" + }, + "subZone": { + "description": "When used for locality of upstream hosts, this field further splits zone into smaller chunks of sub-zones so they can be load balanced independently.", + "type": "string" + }, + "zone": { + "description": "Defines the local service zone where Envoy is running. Though optional, it should be set if discovery service routing is used and the discovery service exposes :ref:`zone data `, either in this message or via :option:`--service-zone`. The meaning of zone is context dependent, e.g. `Availability Zone (AZ) `_ on AWS, `Zone `_ on GCP, etc.", + "type": "string" + } + }, + "type": "object" + }, + "Node": { + "description": "Identifies a specific Envoy instance. The node identifier is presented to the management server, which may use this identifier to distinguish per Envoy configuration for serving. [#next-free-field: 12]", + "id": "Node", + "properties": { + "buildVersion": { + "description": "This is motivated by informing a management server during canary which version of Envoy is being tested in a heterogeneous fleet. This will be set by Envoy in management server RPCs. This field is deprecated in favor of the user_agent_name and user_agent_version values.", + "type": "string" + }, + "clientFeatures": { + "description": "Client feature support list. These are well known features described in the Envoy API repository for a given major version of an API. Client features use reverse DNS naming scheme, for example `com.acme.feature`. See :ref:`the list of features ` that xDS client may support.", + "items": { + "type": "string" + }, + "type": "array" + }, + "cluster": { + "description": "Defines the local service cluster name where Envoy is running. Though optional, it should be set if any of the following features are used: :ref:`statsd `, :ref:`health check cluster verification `, :ref:`runtime override directory `, :ref:`user agent addition `, :ref:`HTTP global rate limiting `, :ref:`CDS `, and :ref:`HTTP tracing `, either in this message or via :option:`--service-cluster`.", + "type": "string" + }, + "extensions": { + "description": "List of extensions and their versions supported by the node.", + "items": { + "$ref": "Extension" + }, + "type": "array" + }, + "id": { + "description": "An opaque node identifier for the Envoy node. This also provides the local service node name. It should be set if any of the following features are used: :ref:`statsd `, :ref:`CDS `, and :ref:`HTTP tracing `, either in this message or via :option:`--service-node`.", + "type": "string" + }, + "listeningAddresses": { + "description": "Known listening ports on the node as a generic hint to the management server for filtering :ref:`listeners ` to be returned. For example, if there is a listener bound to port 80, the list can optionally contain the SocketAddress `(0.0.0.0,80)`. The field is optional and just a hint.", + "items": { + "$ref": "Address" + }, + "type": "array" + }, + "locality": { + "$ref": "Locality", + "description": "Locality specifying where the Envoy instance is running." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Opaque metadata extending the node identifier. Envoy will pass this directly to the management server.", + "type": "object" + }, + "userAgentBuildVersion": { + "$ref": "BuildVersion", + "description": "Structured version of the entity requesting config." + }, + "userAgentName": { + "description": "Free-form string that identifies the entity requesting config. E.g. \"envoy\" or \"grpc\"", + "type": "string" + }, + "userAgentVersion": { + "description": "Free-form string that identifies the version of the entity requesting config. E.g. \"1.12.2\" or \"abcd1234\", or \"SpecialEnvoyBuild\"", + "type": "string" + } + }, + "type": "object" + }, + "NodeMatcher": { + "description": "Specifies the way to match a Node. The match follows AND semantics.", + "id": "NodeMatcher", + "properties": { + "nodeId": { + "$ref": "StringMatcher", + "description": "Specifies match criteria on the node id." + }, + "nodeMetadatas": { + "description": "Specifies match criteria on the node metadata.", + "items": { + "$ref": "StructMatcher" + }, + "type": "array" + } + }, + "type": "object" + }, + "NullMatch": { + "description": "NullMatch is an empty message to specify a null value.", + "id": "NullMatch", + "properties": {}, + "type": "object" + }, + "PathSegment": { + "description": "Specifies the segment in a path to retrieve value from Struct.", + "id": "PathSegment", + "properties": { + "key": { + "description": "If specified, use the key to retrieve the value in a Struct.", + "type": "string" + } + }, + "type": "object" + }, + "PerXdsConfig": { + "description": "Detailed config (per xDS) with status. [#next-free-field: 6]", + "id": "PerXdsConfig", + "properties": { + "clusterConfig": { + "$ref": "ClustersConfigDump" + }, + "listenerConfig": { + "$ref": "ListenersConfigDump" + }, + "routeConfig": { + "$ref": "RoutesConfigDump" + }, + "scopedRouteConfig": { + "$ref": "ScopedRoutesConfigDump" + }, + "status": { + "enum": [ + "UNKNOWN", + "SYNCED", + "NOT_SENT", + "STALE", + "ERROR" + ], + "enumDescriptions": [ + "Status info is not available/unknown.", + "Management server has sent the config to client and received ACK.", + "Config is not sent.", + "Management server has sent the config to client but hasn’t received ACK/NACK.", + "Management server has sent the config to client but received NACK." + ], + "type": "string" + } + }, + "type": "object" + }, + "Pipe": { + "id": "Pipe", + "properties": { + "mode": { + "description": "The mode for the Pipe. Not applicable for abstract sockets.", + "format": "uint32", + "type": "integer" + }, + "path": { + "description": "Unix Domain Socket path. On Linux, paths starting with '@' will use the abstract namespace. The starting '@' is replaced by a null byte by Envoy. Paths starting with '@' will result in an error in environments other than Linux.", + "type": "string" + } + }, + "type": "object" + }, + "RegexMatcher": { + "description": "A regex matcher designed for safety when used with untrusted input.", + "id": "RegexMatcher", + "properties": { + "googleRe2": { + "$ref": "GoogleRE2", + "description": "Google's RE2 regex engine." + }, + "regex": { + "description": "The regex match string. The string must be supported by the configured engine.", + "type": "string" + } + }, + "type": "object" + }, + "RoutesConfigDump": { + "description": "Envoy's RDS implementation fills this message with all currently loaded routes, as described by their RouteConfiguration objects. Static routes that are either defined in the bootstrap configuration or defined inline while configuring listeners are separated from those configured dynamically via RDS. Route configuration information can be used to recreate an Envoy configuration by populating all routes as static routes or by returning them in RDS responses.", + "id": "RoutesConfigDump", + "properties": { + "dynamicRouteConfigs": { + "description": "The dynamically loaded route configs.", + "items": { + "$ref": "DynamicRouteConfig" + }, + "type": "array" + }, + "staticRouteConfigs": { + "description": "The statically loaded route configs.", + "items": { + "$ref": "StaticRouteConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ScopedRoutesConfigDump": { + "description": "Envoy's scoped RDS implementation fills this message with all currently loaded route configuration scopes (defined via ScopedRouteConfigurationsSet protos). This message lists both the scopes defined inline with the higher order object (i.e., the HttpConnectionManager) and the dynamically obtained scopes via the SRDS API.", + "id": "ScopedRoutesConfigDump", + "properties": { + "dynamicScopedRouteConfigs": { + "description": "The dynamically loaded scoped route configs.", + "items": { + "$ref": "DynamicScopedRouteConfigs" + }, + "type": "array" + }, + "inlineScopedRouteConfigs": { + "description": "The statically loaded scoped route configs.", + "items": { + "$ref": "InlineScopedRouteConfigs" + }, + "type": "array" + } + }, + "type": "object" + }, + "SemanticVersion": { + "description": "Envoy uses SemVer (https://semver.org/). Major/minor versions indicate expected behaviors and APIs, the patch version field is used only for security fixes and can be generally ignored.", + "id": "SemanticVersion", + "properties": { + "majorNumber": { + "format": "uint32", + "type": "integer" + }, + "minorNumber": { + "format": "uint32", + "type": "integer" + }, + "patch": { + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, + "SocketAddress": { + "description": "[#next-free-field: 7]", + "id": "SocketAddress", + "properties": { + "address": { + "description": "The address for this socket. :ref:`Listeners ` will bind to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::`` to bind to any address. [#comment:TODO(zuercher) reinstate when implemented: It is possible to distinguish a Listener address via the prefix/suffix matching in :ref:`FilterChainMatch `.] When used within an upstream :ref:`BindConfig `, the address controls the source address of outbound connections. For :ref:`clusters `, the cluster type determines whether the address must be an IP (*STATIC* or *EDS* clusters) or a hostname resolved by DNS (*STRICT_DNS* or *LOGICAL_DNS* clusters). Address resolution can be customized via :ref:`resolver_name `.", + "type": "string" + }, + "ipv4Compat": { + "description": "When binding to an IPv6 address above, this enables `IPv4 compatibility `_. Binding to ``::`` will allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into IPv6 space as ``::FFFF:``.", + "type": "boolean" + }, + "namedPort": { + "description": "This is only valid if :ref:`resolver_name ` is specified below and the named resolver is capable of named port resolution.", + "type": "string" + }, + "portValue": { + "format": "uint32", + "type": "integer" + }, + "protocol": { + "enum": [ + "TCP", + "UDP" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "resolverName": { + "description": "The name of the custom resolver. This must have been registered with Envoy. If this is empty, a context dependent default applies. If the address is a concrete IP address, no resolution will occur. If address is a hostname this should be set for resolution other than DNS. Specifying a custom resolver with *STRICT_DNS* or *LOGICAL_DNS* will generate an error at runtime.", + "type": "string" + } + }, + "type": "object" + }, + "StaticCluster": { + "description": "Describes a statically loaded cluster.", + "id": "StaticCluster", + "properties": { + "cluster": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The cluster config.", + "type": "object" + }, + "lastUpdated": { + "description": "The timestamp when the Cluster was last updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "StaticListener": { + "description": "Describes a statically loaded listener.", + "id": "StaticListener", + "properties": { + "lastUpdated": { + "description": "The timestamp when the Listener was last successfully updated.", + "format": "google-datetime", + "type": "string" + }, + "listener": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The listener config.", + "type": "object" + } + }, + "type": "object" + }, + "StaticRouteConfig": { + "id": "StaticRouteConfig", + "properties": { + "lastUpdated": { + "description": "The timestamp when the Route was last updated.", + "format": "google-datetime", + "type": "string" + }, + "routeConfig": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The route config.", + "type": "object" + } + }, + "type": "object" + }, + "StringMatcher": { + "description": "Specifies the way to match a string. [#next-free-field: 7]", + "id": "StringMatcher", + "properties": { + "exact": { + "description": "The input string must match exactly the string specified here. Examples: * *abc* only matches the value *abc*.", + "type": "string" + }, + "ignoreCase": { + "description": "If true, indicates the exact/prefix/suffix matching should be case insensitive. This has no effect for the safe_regex match. For example, the matcher *data* will match both input string *Data* and *data* if set to true.", + "type": "boolean" + }, + "prefix": { + "description": "The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * *abc* matches the value *abc.xyz*", + "type": "string" + }, + "regex": { + "description": "The input string must match the regular expression specified here. The regex grammar is defined `here `_. Examples: * The regex ``\\d{3}`` matches the value *123* * The regex ``\\d{3}`` does not match the value *1234* * The regex ``\\d{3}`` does not match the value *123.456* .. attention:: This field has been deprecated in favor of `safe_regex` as it is not safe for use with untrusted input in all cases.", + "type": "string" + }, + "safeRegex": { + "$ref": "RegexMatcher", + "description": "The input string must match the regular expression specified here." + }, + "suffix": { + "description": "The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * *abc* matches the value *xyz.abc*", + "type": "string" + } + }, + "type": "object" + }, + "StructMatcher": { + "description": "StructMatcher provides a general interface to check if a given value is matched in google.protobuf.Struct. It uses `path` to retrieve the value from the struct and then check if it's matched to the specified value. For example, for the following Struct: .. code-block:: yaml fields: a: struct_value: fields: b: struct_value: fields: c: string_value: pro t: list_value: values: - string_value: m - string_value: n The following MetadataMatcher is matched as the path [a, b, c] will retrieve a string value \"pro\" from the Metadata which is matched to the specified prefix match. .. code-block:: yaml path: - key: a - key: b - key: c value: string_match: prefix: pr The following StructMatcher is matched as the code will match one of the string values in the list at the path [a, t]. .. code-block:: yaml path: - key: a - key: t value: list_match: one_of: string_match: exact: m An example use of StructMatcher is to match metadata in envoy.v*.core.Node.", + "id": "StructMatcher", + "properties": { + "path": { + "description": "The path to retrieve the Value from the Struct.", + "items": { + "$ref": "PathSegment" + }, + "type": "array" + }, + "value": { + "$ref": "ValueMatcher", + "description": "The StructMatcher is matched if the value retrieved by path is matched to this value." + } + }, + "type": "object" + }, + "UpdateFailureState": { + "id": "UpdateFailureState", + "properties": { + "details": { + "description": "Details about the last failed update attempt.", + "type": "string" + }, + "failedConfiguration": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "What the component configuration would have been if the update had succeeded.", + "type": "object" + }, + "lastUpdateAttempt": { + "description": "Time of the latest failed update attempt.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ValueMatcher": { + "description": "Specifies the way to match a ProtobufWkt::Value. Primitive values and ListValue are supported. StructValue is not supported and is always not matched. [#next-free-field: 7]", + "id": "ValueMatcher", + "properties": { + "boolMatch": { + "description": "If specified, a match occurs if and only if the target value is a bool value and is equal to this field.", + "type": "boolean" + }, + "doubleMatch": { + "$ref": "DoubleMatcher", + "description": "If specified, a match occurs if and only if the target value is a double value and is matched to this field." + }, + "listMatch": { + "$ref": "ListMatcher", + "description": "If specified, a match occurs if and only if the target value is a list value and is matched to this field." + }, + "nullMatch": { + "$ref": "NullMatch", + "description": "If specified, a match occurs if and only if the target value is a NullValue." + }, + "presentMatch": { + "description": "If specified, value match will be performed based on whether the path is referring to a valid primitive value in the metadata. If the path is referring to a non-primitive value, the result is always not matched.", + "type": "boolean" + }, + "stringMatch": { + "$ref": "StringMatcher", + "description": "If specified, a match occurs if and only if the target value is a string value and is matched to this field." + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Traffic Director API", + "version": "v2", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/translate__v3.json b/discovery/googleapis/translate__v3.json index 168ef17..337b9be 100644 --- a/discovery/googleapis/translate__v3.json +++ b/discovery/googleapis/translate__v3.json
@@ -667,7 +667,7 @@ } } }, - "revision": "20200925", + "revision": "20201230", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchTranslateTextRequest": { @@ -682,7 +682,7 @@ "type": "object" }, "inputConfigs": { - "description": "Required. Input configurations. The total number of files matched should be <= 1000. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.", + "description": "Required. Input configurations. The total number of files matched should be <= 100. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding.", "items": { "$ref": "InputConfig" }, @@ -1035,7 +1035,7 @@ "properties": { "gcsDestination": { "$ref": "GcsDestination", - "description": "Google Cloud Storage destination for output content. For every single input file (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateTextRequest). Output files (tsv) generated are compliant with RFC 4180 except that record delimiters are '\\n' instead of '\\r\\n'. We don't provide any way to change record delimiters. While the input files are being processed, we write/update an index file 'index.csv' under 'output_uri_prefix' (for example, gs://translation-test/index.csv) The index file is generated/updated as new files are being translated. The format is: input_file,target_language_code,translations_file,errors_file, glossary_translations_file,glossary_errors_file input_file is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translations_file contains the translations. (details provided below) errors_file contains the errors during processing of the file. (details below). Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translations_file and glossary_errors_file are always empty strings if the input_file is tsv. They could also be empty if we have no content to output. Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written). The format of translations_file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_translations.[extension] If the input file extension is tsv, the output has the following columns: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: translation without applying a glossary. Empty string if there is an error. Column 4 (only present if a glossary is provided in the request): translation after applying the glossary. Empty string if there is an error applying the glossary. Could be same string as column 3 if there is no glossary applied. If input file extension is a txt or html, the translation is directly written to the output file. If glossary is requested, a separate glossary_translations_file has format of gs://translation_test/a_b_c_'trg'_glossary_translations.[extension] The format of errors file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_errors.[extension] If the input file extension is tsv, errors_file contains the following: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: Error detail for the translation. Could be empty. Column 4 (only present if a glossary is provided in the request): Error when applying the glossary. If the input file extension is txt or html, glossary_error_file will be generated that contains error details. glossary_error_file has format of gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]" + "description": "Google Cloud Storage destination for output content. For every single input file (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateTextRequest). Output files (tsv) generated are compliant with RFC 4180 except that record delimiters are '\\n' instead of '\\r\\n'. We don't provide any way to change record delimiters. While the input files are being processed, we write/update an index file 'index.csv' under 'output_uri_prefix' (for example, gs://translation-test/index.csv) The index file is generated/updated as new files are being translated. The format is: input_file,target_language_code,translations_file,errors_file, glossary_translations_file,glossary_errors_file input_file is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translations_file contains the translations. (details provided below) errors_file contains the errors during processing of the file. (details below). Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translations_file and glossary_errors_file are always empty strings if the input_file is tsv. They could also be empty if we have no content to output. Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written). Since index.csv will be keeping updated during the process, please make sure there is no custom retention policy applied on the output bucket that may avoid file updating. (https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy) The format of translations_file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_translations.[extension] If the input file extension is tsv, the output has the following columns: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: translation without applying a glossary. Empty string if there is an error. Column 4 (only present if a glossary is provided in the request): translation after applying the glossary. Empty string if there is an error applying the glossary. Could be same string as column 3 if there is no glossary applied. If input file extension is a txt or html, the translation is directly written to the output file. If glossary is requested, a separate glossary_translations_file has format of gs://translation_test/a_b_c_'trg'_glossary_translations.[extension] The format of errors file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_errors.[extension] If the input file extension is tsv, errors_file contains the following: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: Error detail for the translation. Could be empty. Column 4 (only present if a glossary is provided in the request): Error when applying the glossary. If the input file extension is txt or html, glossary_error_file will be generated that contains error details. glossary_error_file has format of gs://translation_test/a_b_c_'trg'_glossary_errors.[extension]" } }, "type": "object" @@ -1124,7 +1124,7 @@ "id": "TranslateTextRequest", "properties": { "contents": { - "description": "Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. Use BatchTranslateText for larger text.", + "description": "Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. The max length of this field is 1024. Use BatchTranslateText for larger text.", "items": { "type": "string" },
diff --git a/discovery/googleapis/vault__v1.json b/discovery/googleapis/vault__v1.json index f7ef368..4cd54fb 100644 --- a/discovery/googleapis/vault__v1.json +++ b/discovery/googleapis/vault__v1.json
@@ -160,6 +160,32 @@ "https://www.googleapis.com/auth/ediscovery" ] }, + "count": { + "description": "Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.", + "httpMethod": "POST", + "id": "vault.matters.count", + "parameterOrder": [ + "matterId" + ], + "parameters": { + "matterId": { + "description": "The matter ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/matters/{matterId}:count", + "request": { + "$ref": "CountArtifactsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ] + }, "create": { "description": "Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.", "httpMethod": "POST", @@ -1022,6 +1048,30 @@ }, "operations": { "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "vault.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + } + }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "httpMethod": "DELETE", @@ -1042,13 +1092,122 @@ "response": { "$ref": "Empty" } + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "vault.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery", + "https://www.googleapis.com/auth/ediscovery.readonly" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "vault.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^operations$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ListOperationsResponse" + } } } } }, - "revision": "20200917", + "revision": "20210129", "rootUrl": "https://vault.googleapis.com/", "schemas": { + "AccountCount": { + "description": "Count number for each account.", + "id": "AccountCount", + "properties": { + "account": { + "$ref": "UserInfo", + "description": "Account owner." + }, + "count": { + "description": "The number of artifacts found for this account.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AccountCountError": { + "description": "An error that occurred when querying a specific account", + "id": "AccountCountError", + "properties": { + "account": { + "$ref": "UserInfo", + "description": "Account owner." + }, + "errorType": { + "description": "Account query error.", + "enum": [ + "ERROR_TYPE_UNSPECIFIED", + "WILDCARD_TOO_BROAD", + "TOO_MANY_TERMS", + "LOCATION_UNAVAILABLE", + "UNKNOWN", + "DEADLINE_EXCEEDED" + ], + "enumDescriptions": [ + "Default.", + "Permanent - prefix terms expanded to too many query terms.", + "Permanent - query contains too many terms.", + "Transient - data in transit between storage replicas, temporarily unavailable.", + "Unrecognized error.", + "Deadline exceeded when querying the account." + ], + "type": "string" + } + }, + "type": "object" + }, "AccountInfo": { "description": "Accounts to search", "id": "AccountInfo", @@ -1132,6 +1291,12 @@ }, "type": "object" }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, "CloseMatterRequest": { "description": "Close a matter by ID.", "id": "CloseMatterRequest", @@ -1206,6 +1371,80 @@ "mailQuery": { "$ref": "HeldMailQuery", "description": "Details pertaining to mail holds. If set, corpus must be mail." + }, + "voiceQuery": { + "$ref": "HeldVoiceQuery", + "description": "Details pertaining to Voice holds. If set, corpus must be Voice." + } + }, + "type": "object" + }, + "CountArtifactsMetadata": { + "description": "Long running operation metadata for CountArtifacts.", + "id": "CountArtifactsMetadata", + "properties": { + "endTime": { + "description": "End time of count operation. Available when operation is done.", + "format": "google-datetime", + "type": "string" + }, + "matterId": { + "description": "The matter ID of the associated matter.", + "type": "string" + }, + "query": { + "$ref": "Query", + "description": "The search query from the request." + }, + "startTime": { + "description": "Creation time of count operation.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CountArtifactsRequest": { + "description": "Count artifacts request.", + "id": "CountArtifactsRequest", + "properties": { + "query": { + "$ref": "Query", + "description": "The search query." + }, + "view": { + "description": "Specifies the granularity of the count result returned in response.", + "enum": [ + "COUNT_RESULT_VIEW_UNSPECIFIED", + "TOTAL_COUNT", + "ALL" + ], + "enumDescriptions": [ + "Default. It works the same as TOTAL_COUNT.", + "Response includes: total count, queried accounts count, matching accounts count, non-queryable accounts, queried account errors.", + "Response includes additional breakdown of account count." + ], + "type": "string" + } + }, + "type": "object" + }, + "CountArtifactsResponse": { + "description": "Definition of the response for method CountArtifacts.", + "id": "CountArtifactsResponse", + "properties": { + "groupsCountResult": { + "$ref": "GroupsCountResult", + "description": "Count metrics of Groups." + }, + "mailCountResult": { + "$ref": "MailCountResult", + "description": "Count metrics of Mail." + }, + "totalCount": { + "description": "Total count of artifacts. For mail and groups, artifacts refers to messages.", + "format": "int64", + "type": "string" } }, "type": "object" @@ -1342,6 +1581,10 @@ "Europe region." ], "type": "string" + }, + "voiceOptions": { + "$ref": "VoiceExportOptions", + "description": "Option available for voice export." } }, "type": "object" @@ -1368,6 +1611,44 @@ }, "type": "object" }, + "GroupsCountResult": { + "description": "Groups specific count metrics.", + "id": "GroupsCountResult", + "properties": { + "accountCountErrors": { + "description": "Error occurred when querying these accounts.", + "items": { + "$ref": "AccountCountError" + }, + "type": "array" + }, + "accountCounts": { + "description": "Subtotal count per matching account that have more than zero messages.", + "items": { + "$ref": "AccountCount" + }, + "type": "array" + }, + "matchingAccountsCount": { + "description": "Total number of accounts that can be queried and have more than zero messages.", + "format": "int64", + "type": "string" + }, + "nonQueryableAccounts": { + "description": "When data scope is HELD_DATA in the request Query, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "queriedAccountsCount": { + "description": "Total number of accounts involved in this count operation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GroupsExportOptions": { "description": "The options for groups export.", "id": "GroupsExportOptions", @@ -1547,6 +1828,32 @@ }, "type": "object" }, + "HeldVoiceQuery": { + "description": "Query options for Voice holds.", + "id": "HeldVoiceQuery", + "properties": { + "coveredData": { + "description": "Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.", + "items": { + "enum": [ + "COVERED_DATA_UNSPECIFIED", + "TEXT_MESSAGES", + "VOICEMAILS", + "CALL_LOGS" + ], + "enumDescriptions": [ + "Covered data unspecified.", + "Voice text message will be covered.", + "Voicemail will be covered.", + "Call logs will be covered." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Hold": { "description": "Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.", "id": "Hold", @@ -1565,14 +1872,16 @@ "DRIVE", "MAIL", "GROUPS", - "HANGOUTS_CHAT" + "HANGOUTS_CHAT", + "VOICE" ], "enumDescriptions": [ "No corpus specified.", "Drive.", "Mail.", "Groups.", - "Hangouts Chat." + "Hangouts Chat.", + "Google Voice." ], "type": "string" }, @@ -1668,6 +1977,24 @@ }, "type": "object" }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, "ListSavedQueriesResponse": { "description": "Definition of the response for method ListSaveQuery.", "id": "ListSavedQueriesResponse", @@ -1686,6 +2013,44 @@ }, "type": "object" }, + "MailCountResult": { + "description": "Mail specific count metrics.", + "id": "MailCountResult", + "properties": { + "accountCountErrors": { + "description": "Error occurred when querying these accounts.", + "items": { + "$ref": "AccountCountError" + }, + "type": "array" + }, + "accountCounts": { + "description": "Subtotal count per matching account that have more than zero messages.", + "items": { + "$ref": "AccountCount" + }, + "type": "array" + }, + "matchingAccountsCount": { + "description": "Total number of accounts that can be queried and have more than zero messages.", + "format": "int64", + "type": "string" + }, + "nonQueryableAccounts": { + "description": "When data scope is HELD_DATA in the request Query, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "queriedAccountsCount": { + "description": "Total number of accounts involved in this count operation.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "MailExportOptions": { "description": "The options for mail export.", "id": "MailExportOptions", @@ -1789,6 +2154,41 @@ }, "type": "object" }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, "OrgUnitInfo": { "description": "Org Unit to search", "id": "OrgUnitInfo", @@ -1815,14 +2215,16 @@ "DRIVE", "MAIL", "GROUPS", - "HANGOUTS_CHAT" + "HANGOUTS_CHAT", + "VOICE" ], "enumDescriptions": [ "No corpus specified.", "Drive.", "Mail.", "Groups.", - "Hangouts Chat." + "Hangouts Chat.", + "Google Voice." ], "type": "string" }, @@ -1879,7 +2281,7 @@ "Will search all accounts provided in account_info.", "Will search all accounts in the OU specified in org_unit_info.", "Will search for all accounts in the Team Drive specified in team_drive_info.", - "Will search for all accounts in the organization. No need to set account_info or org_unit_info.", + "Will search for all accounts in the organization. No need to set account_info or org_unit_info. Not all CORPUS_TYPE support this scope. Supported by MAIL.", "Will search in the Room specified in hangout_chats_info. (read-only)", "Will search for all accounts in the shared drive specified in shared_drive_info." ], @@ -1905,7 +2307,7 @@ "Will search all accounts provided in account_info.", "Will search all accounts in the OU specified in org_unit_info.", "Will search for all accounts in the Team Drive specified in team_drive_info.", - "Will search for all accounts in the organization. No need to set account_info or org_unit_info.", + "Will search for all accounts in the organization. No need to set account_info or org_unit_info. Not all CORPUS_TYPE support this scope. Supported by MAIL.", "Will search in the Room specified in hangout_chats_info. (read-only)", "Will search for all accounts in the shared drive specified in shared_drive_info." ], @@ -1931,6 +2333,10 @@ "timeZone": { "description": "The time zone name. It should be an IANA TZ name, such as \"America/Los_Angeles\". For more information, see Time Zone.", "type": "string" + }, + "voiceOptions": { + "$ref": "VoiceOptions", + "description": "For voice search, specify more options in this field." } }, "type": "object" @@ -2094,6 +2500,53 @@ } }, "type": "object" + }, + "VoiceExportOptions": { + "description": "The options for voice export.", + "id": "VoiceExportOptions", + "properties": { + "exportFormat": { + "description": "The export format for voice export.", + "enum": [ + "EXPORT_FORMAT_UNSPECIFIED", + "MBOX", + "PST" + ], + "enumDescriptions": [ + "No export format specified.", + "MBOX as export format.", + "PST as export format" + ], + "type": "string" + } + }, + "type": "object" + }, + "VoiceOptions": { + "description": "Voice search options", + "id": "VoiceOptions", + "properties": { + "coveredData": { + "description": "Datatypes to search", + "items": { + "enum": [ + "COVERED_DATA_UNSPECIFIED", + "TEXT_MESSAGES", + "VOICEMAILS", + "CALL_LOGS" + ], + "enumDescriptions": [ + "Covered data unspecified.", + "Voice text message will be covered.", + "Voicemail will be covered.", + "Call logs will be covered." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "",
diff --git a/discovery/googleapis/vectortile__v1.json b/discovery/googleapis/vectortile__v1.json new file mode 100644 index 0000000..273d967 --- /dev/null +++ b/discovery/googleapis/vectortile__v1.json
@@ -0,0 +1,903 @@ +{ + "basePath": "", + "baseUrl": "https://vectortile.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Semantic Tile", + "description": "Serves vector tiles containing geospatial data. ", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/maps/contact-sales/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "vectortile:v1", + "kind": "discovery#restDescription", + "name": "vectortile", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "featuretiles": { + "methods": { + "get": { + "description": "Gets a feature tile by its tile resource name.", + "httpMethod": "GET", + "id": "vectortile.featuretiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "alwaysIncludeBuildingFootprints": { + "description": "Flag indicating whether the returned tile will always contain 2.5D footprints for structures. If enabled_modeled_volumes is set, this will mean that structures will have both their 3D models and 2.5D footprints returned.", + "location": "query", + "type": "boolean" + }, + "clientInfo.apiClient": { + "description": "API client name and version. For example, the SDK calling the API. The exact format is up to the client.", + "location": "query", + "type": "string" + }, + "clientInfo.applicationId": { + "description": "Application ID, such as the package name on Android and the bundle identifier on iOS platforms.", + "location": "query", + "type": "string" + }, + "clientInfo.applicationVersion": { + "description": "Application version number, such as \"1.2.3\". The exact format is application-dependent.", + "location": "query", + "type": "string" + }, + "clientInfo.deviceModel": { + "description": "Device model as reported by the device. The exact format is platform-dependent.", + "location": "query", + "type": "string" + }, + "clientInfo.operatingSystem": { + "description": "Operating system name and version as reported by the OS. For example, \"Mac OS X 10.10.4\". The exact format is platform-dependent.", + "location": "query", + "type": "string" + }, + "clientInfo.platform": { + "description": "Platform where the application is running.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "EDITOR", + "MAC_OS", + "WINDOWS", + "LINUX", + "ANDROID", + "IOS", + "WEB_GL" + ], + "enumDescriptions": [ + "Unspecified or unknown OS.", + "Development environment.", + "macOS.", + "Windows.", + "Linux", + "Android", + "iOS", + "WebGL." + ], + "location": "query", + "type": "string" + }, + "clientInfo.userId": { + "description": "Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info).", + "location": "query", + "type": "string" + }, + "clientTileVersionId": { + "description": "Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead.", + "location": "query", + "type": "string" + }, + "enableDetailedHighwayTypes": { + "description": "Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons.", + "location": "query", + "type": "boolean" + }, + "enableFeatureNames": { + "description": "Flag indicating whether human-readable names should be returned for features. If this is set, the display_name field on the feature will be filled out.", + "location": "query", + "type": "boolean" + }, + "enableModeledVolumes": { + "description": "Flag indicating whether 3D building models should be enabled. If this is set structures will be returned as 3D modeled volumes rather than 2.5D extruded areas where possible.", + "location": "query", + "type": "boolean" + }, + "enablePoliticalFeatures": { + "description": "Flag indicating whether political features should be returned.", + "location": "query", + "type": "boolean" + }, + "enablePrivateRoads": { + "description": "Flag indicating whether the returned tile will contain road features that are marked private. Private roads are indicated by the Feature.segment_info.road_info.is_private field.", + "location": "query", + "type": "boolean" + }, + "enableUnclippedBuildings": { + "description": "Flag indicating whether unclipped buildings should be returned. If this is set, building render ops will extend beyond the tile boundary. Buildings will only be returned on the tile that contains their centroid.", + "location": "query", + "type": "boolean" + }, + "languageCode": { + "description": "Required. The BCP-47 language code corresponding to the language in which the name was requested, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`.", + "location": "path", + "pattern": "^featuretiles/[^/]+$", + "required": true, + "type": "string" + }, + "regionCode": { + "description": "Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as \"US\" and \"419\". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "FeatureTile" + } + } + } + }, + "terraintiles": { + "methods": { + "get": { + "description": "Gets a terrain tile by its tile resource name.", + "httpMethod": "GET", + "id": "vectortile.terraintiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "altitudePrecisionCentimeters": { + "description": "The precision of terrain altitudes in centimeters. Possible values: between 1 (cm level precision) and 1,000,000 (10-kilometer level precision).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "clientInfo.apiClient": { + "description": "API client name and version. For example, the SDK calling the API. The exact format is up to the client.", + "location": "query", + "type": "string" + }, + "clientInfo.applicationId": { + "description": "Application ID, such as the package name on Android and the bundle identifier on iOS platforms.", + "location": "query", + "type": "string" + }, + "clientInfo.applicationVersion": { + "description": "Application version number, such as \"1.2.3\". The exact format is application-dependent.", + "location": "query", + "type": "string" + }, + "clientInfo.deviceModel": { + "description": "Device model as reported by the device. The exact format is platform-dependent.", + "location": "query", + "type": "string" + }, + "clientInfo.operatingSystem": { + "description": "Operating system name and version as reported by the OS. For example, \"Mac OS X 10.10.4\". The exact format is platform-dependent.", + "location": "query", + "type": "string" + }, + "clientInfo.platform": { + "description": "Platform where the application is running.", + "enum": [ + "PLATFORM_UNSPECIFIED", + "EDITOR", + "MAC_OS", + "WINDOWS", + "LINUX", + "ANDROID", + "IOS", + "WEB_GL" + ], + "enumDescriptions": [ + "Unspecified or unknown OS.", + "Development environment.", + "macOS.", + "Windows.", + "Linux", + "Android", + "iOS", + "WebGL." + ], + "location": "query", + "type": "string" + }, + "clientInfo.userId": { + "description": "Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info).", + "location": "query", + "type": "string" + }, + "maxElevationResolutionCells": { + "description": "The maximum allowed resolution for the returned elevation heightmap. Possible values: between 1 and 1024 (and not less than min_elevation_resolution_cells). Over-sized heightmaps will be non-uniformly down-sampled such that each edge is no longer than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 100px (width) * 30px (height) max_elevation_resolution: 30 New resolution: 30px (width) * 30px (height)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "minElevationResolutionCells": { + "description": "The minimum allowed resolution for the returned elevation heightmap. Possible values: between 0 and 1024 (and not more than max_elevation_resolution_cells). Zero is supported for backward compatibility. Under-sized heightmaps will be non-uniformly up-sampled such that each edge is no shorter than this value. Non-uniformity is chosen to maximise the amount of preserved data. For example: Original resolution: 30px (width) * 10px (height) min_elevation_resolution: 30 New resolution: 30px (width) * 30px (height)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "name": { + "description": "Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `terraintiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terraintiles/@1,2,3z`.", + "location": "path", + "pattern": "^terraintiles/[^/]+$", + "required": true, + "type": "string" + }, + "terrainFormats": { + "description": "Terrain formats that the client understands.", + "enum": [ + "TERRAIN_FORMAT_UNKNOWN", + "FIRST_DERIVATIVE", + "SECOND_DERIVATIVE" + ], + "enumDescriptions": [ + "An unknown or unspecified terrain format.", + "Terrain elevation data encoded as a FirstDerivativeElevationGrid. .", + "Terrain elevation data encoded as a SecondDerivativeElevationGrid." + ], + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "TerrainTile" + } + } + } + } + }, + "revision": "20210203", + "rootUrl": "https://vectortile.googleapis.com/", + "schemas": { + "Area": { + "description": "Represents an area. Used to represent regions such as water, parks, etc. Next ID: 10", + "id": "Area", + "properties": { + "basemapZOrder": { + "$ref": "BasemapZOrder", + "description": "The z-order of this geometry when rendered on a flat basemap. Geometry with a lower z-order should be rendered beneath geometry with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting. Unlike Area.z_order this can be used to compare with Line.basemap_z_order, and in fact may yield more accurate rendering (where a line may be rendered beneath an area)." + }, + "hasExternalEdges": { + "description": "True if the polygon is not entirely internal to the feature that it belongs to: that is, some of the edges are bordering another feature.", + "type": "boolean" + }, + "internalEdges": { + "description": "When has_external_edges is true, the polygon has some edges that border another feature. This field indicates the internal edges that do not border another feature. Each value is an index into the vertices array, and denotes the start vertex of the internal edge (the next vertex in the boundary loop is the end of the edge). If the selected vertex is the last vertex in the boundary loop, then the edge between that vertex and the starting vertex of the loop is internal. This field may be used for styling. For example, building parapets could be placed only on the external edges of a building polygon, or water could be lighter colored near the external edges of a body of water. If has_external_edges is false, all edges are internal and this field will be empty.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "loopBreaks": { + "description": "Identifies the boundary loops of the polygon. Only set for INDEXED_TRIANGLE polygons. Each value is an index into the vertices array indicating the beginning of a loop. For instance, values of [2, 5] would indicate loop_data contained 3 loops with indices 0-1, 2-4, and 5-end. This may be used in conjunction with the internal_edges field for styling polygon boundaries. Note that an edge may be on a polygon boundary but still internal to the feature. For example, a feature split across multiple tiles will have an internal polygon boundary edge along the edge of the tile.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "triangleIndices": { + "description": "When the polygon encoding is of type INDEXED_TRIANGLES, this contains the indices of the triangle vertices in the vertex_offsets field. There are 3 vertex indices per triangle.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "type": { + "description": "The polygon encoding type used for this area.", + "enum": [ + "TRIANGLE_FAN", + "INDEXED_TRIANGLES", + "TRIANGLE_STRIP" + ], + "enumDescriptions": [ + "The first vertex in vertex_offset is the center of a triangle fan. The other vertices are arranged around this vertex in a fan shape. The following diagram showes a triangle fan polygon with the vertices labelled with their indices in the vertex_offset list. Triangle fan polygons always have a single boundary loop. Vertices may be in either a clockwise or counterclockwise order. (1) / \\ / \\ / \\ (0)-----(2) / \\ / / \\ / / \\ / (4)-----(3)", + "The polygon is a set of triangles with three vertex indices per triangle. The vertex indices can be found in the triangle_indices field. Indexed triangle polygons also contain information about boundary loops. These identify the loops at the boundary of the polygon and may be used in conjunction with the internal_edges field for styling. Boundary loops may represent either a hole or a disconnected component of the polygon. The following diagram shows an indexed triangle polygon with two boundary loops. (0) (4) / \\ / \\ / \\ / \\ (1)----(2) (3)----(5)", + "A strip of triangles, where each triangle uses the last edge of the previous triangle. Vertices may be in either a clockwise or counterclockwise order. Only polygons without the has_external_edges flag set will use triangle strips. (0) / \\ / \\ / \\ (2)-----(1) / \\ / / \\ / / \\ / (4)-----(3)" + ], + "type": "string" + }, + "vertexOffsets": { + "$ref": "Vertex2DList", + "description": "The vertices present in the polygon defining the area." + }, + "zOrder": { + "description": "The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero. Prefer Area.basemap_z_order.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "BasemapZOrder": { + "description": "Metadata necessary to determine the ordering of a particular basemap element relative to others. To render the basemap correctly, sort by z-plane, then z-grade, then z-within-grade.", + "id": "BasemapZOrder", + "properties": { + "zGrade": { + "description": "The second most significant component of the ordering of a component to be rendered onto the basemap.", + "format": "int32", + "type": "integer" + }, + "zPlane": { + "description": "The most significant component of the ordering of a component to be rendered onto the basemap.", + "format": "int32", + "type": "integer" + }, + "zWithinGrade": { + "description": "The least significant component of the ordering of a component to be rendered onto the basemap.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ExtrudedArea": { + "description": "Represents a height-extruded area: a 3D prism with a constant X-Y plane cross section. Used to represent extruded buildings. A single building may consist of several extruded areas. The min_z and max_z fields are scaled to the size of the tile. An extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on.", + "id": "ExtrudedArea", + "properties": { + "area": { + "$ref": "Area", + "description": "The area representing the footprint of the extruded area." + }, + "maxZ": { + "description": "The z-value in local tile coordinates where the extruded area ends.", + "format": "int32", + "type": "integer" + }, + "minZ": { + "description": "The z-value in local tile coordinates where the extruded area begins. This is non-zero for extruded areas that begin off the ground. For example, a building with a skybridge may have an extruded area component with a non-zero min_z.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Feature": { + "description": "A feature representing a single geographic entity.", + "id": "Feature", + "properties": { + "displayName": { + "description": "The localized name of this feature. Currently only returned for roads.", + "type": "string" + }, + "geometry": { + "$ref": "Geometry", + "description": "The geometry of this feature, representing the space that it occupies in the world." + }, + "placeId": { + "description": "Place ID of this feature, suitable for use in Places API details requests.", + "type": "string" + }, + "relations": { + "description": "Relations to other features.", + "items": { + "$ref": "Relation" + }, + "type": "array" + }, + "segmentInfo": { + "$ref": "SegmentInfo", + "description": "Metadata for features with the SEGMENT FeatureType." + }, + "type": { + "description": "The type of this feature.", + "enum": [ + "FEATURE_TYPE_UNSPECIFIED", + "STRUCTURE", + "BAR", + "BANK", + "LODGING", + "CAFE", + "RESTAURANT", + "EVENT_VENUE", + "TOURIST_DESTINATION", + "SHOPPING", + "SCHOOL", + "SEGMENT", + "ROAD", + "LOCAL_ROAD", + "ARTERIAL_ROAD", + "HIGHWAY", + "CONTROLLED_ACCESS_HIGHWAY", + "FOOTPATH", + "RAIL", + "FERRY", + "REGION", + "PARK", + "BEACH", + "FOREST", + "POLITICAL", + "ADMINISTRATIVE_AREA1", + "LOCALITY", + "SUBLOCALITY", + "WATER" + ], + "enumDescriptions": [ + "Unknown feature type.", + "Structures such as buildings and bridges.", + "A business serving alcoholic drinks to be consumed onsite.", + "A financial institution that offers services to the general public.", + "A place that provides any type of lodging for travelers.", + "A business that sells coffee, tea, and sometimes small meals.", + "A business that prepares meals on-site for service to customers.", + "A venue for private and public events.", + "Place of interest to tourists, typically for natural or cultural value.", + "A structure containing a business or businesses that sell goods.", + "Institution where young people receive general (not vocation or professional) education.", + "Segments such as roads and train lines.", + "A way leading from one place to another intended for use by vehicles.", + "A small city street, typically for travel in a residential neighborhood.", + "Major through road that's expected to carry large volumes of traffic.", + "A major road including freeways and state highways.", + "A highway with grade-separated crossings that is accessed exclusively by ramps. These are usually called \"freeways\" or \"motorways\". The enable_detailed_highway_types request flag must be set in order for this type to be returned.", + "A path that's primarily intended for use by pedestrians and/or cyclists.", + "Tracks intended for use by trains.", + "Services which are part of the road network but are not roads.", + "Non-water areas such as parks and forest.", + "Outdoor areas such as parks and botanical gardens.", + "A pebbly or sandy shore along the edge of a sea or lake.", + "Area of land covered by trees.", + "Political entities, such as provinces and districts.", + "Top-level divisions within a country, such as prefectures or states.", + "Cities, towns, and other municipalities.", + "Divisions within a locality like a borough or ward.", + "Water features such as rivers and lakes." + ], + "type": "string" + } + }, + "type": "object" + }, + "FeatureTile": { + "description": "A tile containing information about the map features located in the region it covers.", + "id": "FeatureTile", + "properties": { + "coordinates": { + "$ref": "TileCoordinates", + "description": "The global tile coordinates that uniquely identify this tile." + }, + "features": { + "description": "Features present on this map tile.", + "items": { + "$ref": "Feature" + }, + "type": "array" + }, + "name": { + "description": "Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`.", + "type": "string" + }, + "providers": { + "description": "Data providers for the data contained in this tile.", + "items": { + "$ref": "ProviderInfo" + }, + "type": "array" + }, + "status": { + "description": "Tile response status code to support tile caching.", + "enum": [ + "STATUS_OK", + "STATUS_OK_DATA_UNCHANGED" + ], + "enumDescriptions": [ + "Everything worked out OK. The cache-control header determines how long this Tile response may be cached by the client. See also version_id and STATUS_OK_DATA_UNCHANGED.", + "Indicates that the request was processed successfully and that the tile data that would have been returned are identical to the data already in the client's cache, as specified by the value of client_tile_version_id contained in GetFeatureTileRequest. In particular, the tile's features and providers will not be populated when the tile data is identical. However, the cache-control header and version_id can still change even when the tile contents itself does not, so clients should always use the most recent values returned by the API." + ], + "type": "string" + }, + "versionId": { + "description": "An opaque value, usually less than 30 characters, that contains version info about this tile and the data that was used to generate it. The client should store this value in its tile cache and pass it back to the API in the client_tile_version_id field of subsequent tile requests in order to enable the API to detect when the new tile would be the same as the one the client already has in its cache. Also see STATUS_OK_DATA_UNCHANGED.", + "type": "string" + } + }, + "type": "object" + }, + "FirstDerivativeElevationGrid": { + "description": "A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs between them as integers at some requested level of precision to take advantage of integer packing. The actual altitude values a[] can be reconstructed using the scale and each row's first_altitude and altitude_diff fields.", + "id": "FirstDerivativeElevationGrid", + "properties": { + "altitudeMultiplier": { + "description": "A multiplier applied to the altitude fields below to extract the actual altitudes in meters from the elevation grid.", + "format": "float", + "type": "number" + }, + "rows": { + "description": "Rows of points containing altitude data making up the elevation grid. Each row is the same length. Rows are ordered from north to south. E.g: rows[0] is the north-most row, and rows[n] is the south-most row.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "Geometry": { + "description": "Represents the geometry of a feature, that is, the shape that it has on the map. The local tile coordinate system has the origin at the north-west (upper-left) corner of the tile, and is scaled to 4096 units across each edge. The height (Z) axis has the same scale factor: an extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. There is no clipping boundary, so it is possible that some coordinates will lie outside the tile boundaries.", + "id": "Geometry", + "properties": { + "areas": { + "description": "The areas present in this geometry.", + "items": { + "$ref": "Area" + }, + "type": "array" + }, + "extrudedAreas": { + "description": "The extruded areas present in this geometry. Not populated if modeled_volumes are included in this geometry unless always_include_building_footprints is set in GetFeatureTileRequest, in which case the client should decide which (extruded areas or modeled volumes) should be used (they should not be rendered together).", + "items": { + "$ref": "ExtrudedArea" + }, + "type": "array" + }, + "lines": { + "description": "The lines present in this geometry.", + "items": { + "$ref": "Line" + }, + "type": "array" + }, + "modeledVolumes": { + "description": "The modeled volumes present in this geometry. Not populated unless enable_modeled_volumes has been set in GetFeatureTileRequest.", + "items": { + "$ref": "ModeledVolume" + }, + "type": "array" + } + }, + "type": "object" + }, + "Line": { + "description": "Represents a 2D polyline. Used to represent segments such as roads, train tracks, etc.", + "id": "Line", + "properties": { + "basemapZOrder": { + "$ref": "BasemapZOrder", + "description": "The z-order of this geometry when rendered on a flat basemap. Geometry with a lower z-order should be rendered beneath geometry with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting. Unlike Line.z_order this can be used to compare with Area.basemap_z_order, and in fact may yield more accurate rendering (where a line may be rendered beneath an area)." + }, + "vertexOffsets": { + "$ref": "Vertex2DList", + "description": "The vertices present in the polyline." + }, + "zOrder": { + "description": "The z-order of the line. Lines with a lower z-order should be rendered beneath lines with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting during rendering on the client. In general, larger and more important road features will have a higher z-order line associated with them. This z-ordering can only be used to compare lines, and cannot be compared with the z_order field in the Area message. The z-order may be negative or zero. Prefer Line.basemap_z_order.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ModeledVolume": { + "description": "Represents a modeled volume in 3D space. Used to represent 3D buildings.", + "id": "ModeledVolume", + "properties": { + "strips": { + "description": "The triangle strips present in this mesh.", + "items": { + "$ref": "TriangleStrip" + }, + "type": "array" + }, + "vertexOffsets": { + "$ref": "Vertex3DList", + "description": "The vertices present in the mesh defining the modeled volume." + } + }, + "type": "object" + }, + "ProviderInfo": { + "description": "Information about the data providers that should be included in the attribution string shown by the client.", + "id": "ProviderInfo", + "properties": { + "description": { + "description": "Attribution string for this provider. This string is not localized.", + "type": "string" + } + }, + "type": "object" + }, + "Relation": { + "description": "Represents a relation to another feature in the tile. For example, a building might be occupied by a given POI. The related feature can be retrieved using the related feature index.", + "id": "Relation", + "properties": { + "relatedFeatureIndex": { + "description": "Zero-based index to look up the related feature from the list of features in the tile.", + "format": "int32", + "type": "integer" + }, + "relationType": { + "description": "Relation type between the origin feature to the related feature.", + "enum": [ + "RELATION_TYPE_UNSPECIFIED", + "OCCUPIES", + "PRIMARILY_OCCUPIED_BY" + ], + "enumDescriptions": [ + "Unspecified relation type. Should never happen.", + "The origin feature occupies the related feature.", + "The origin feature is primarily occupied by the related feature." + ], + "type": "string" + } + }, + "type": "object" + }, + "RoadInfo": { + "description": "Extra metadata relating to roads.", + "id": "RoadInfo", + "properties": { + "isPrivate": { + "description": "Road has signage discouraging or prohibiting use by the general public. E.g., roads with signs that say \"Private\", or \"No trespassing.\"", + "type": "boolean" + } + }, + "type": "object" + }, + "Row": { + "description": "A row of altitude points in the elevation grid, ordered from west to east.", + "id": "Row", + "properties": { + "altitudeDiffs": { + "description": "The difference between each successive pair of altitudes, from west to east. The first, westmost point, is just the altitude rather than a diff. The units are specified by the altitude_multiplier parameter above; the value in meters is given by altitude_multiplier * altitude_diffs[n]. The altitude row (in metres above sea level) can be reconstructed with: a[0] = altitude_diffs[0] * altitude_multiplier when n > 0, a[n] = a[n-1] + altitude_diffs[n-1] * altitude_multiplier.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecondDerivativeElevationGrid": { + "description": "A packed representation of a 2D grid of uniformly spaced points containing elevation data. Each point within the grid represents the altitude in meters above average sea level at that location within the tile. Elevations provided are (generally) relative to the EGM96 geoid, however some areas will be relative to NAVD88. EGM96 and NAVD88 are off by no more than 2 meters. The grid is oriented north-west to south-east, as illustrated: rows[0].a[0] rows[0].a[m] +-----------------+ | | | N | | ^ | | | | | W <-----> E | | | | | v | | S | | | +-----------------+ rows[n].a[0] rows[n].a[m] Rather than storing the altitudes directly, we store the diffs of the diffs between them as integers at some requested level of precision to take advantage of integer packing. Note that the data is packed in such a way that is fast to decode in Unity and that further optimizes wire size.", + "id": "SecondDerivativeElevationGrid", + "properties": { + "altitudeMultiplier": { + "description": "A multiplier applied to the elements in the encoded data to extract the actual altitudes in meters.", + "format": "float", + "type": "number" + }, + "columnCount": { + "description": "The number of columns included in the encoded elevation data (i.e. the horizontal resolution of the grid).", + "format": "int32", + "type": "integer" + }, + "encodedData": { + "description": "A stream of elements each representing a point on the tile running across each row from left to right, top to bottom. There will be precisely horizontal_resolution * vertical_resolution elements in the stream. The elements are not the heights, rather the second order derivative of the values one would expect in a stream of height data. Each element is a varint with the following encoding: ------------------------------------------------------------------------| | Head Nibble | ------------------------------------------------------------------------| | Bit 0 | Bit 1 | Bits 2-3 | | Terminator| Sign (1=neg) | Least significant 2 bits of absolute error | ------------------------------------------------------------------------| | Tail Nibble #1 | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------| | ... | Tail Nibble #n | ------------------------------------------------------------------------| | Bit 0 | Bit 1-3 | | Terminator| Least significant 3 bits of absolute error | ------------------------------------------------------------------------|", + "format": "byte", + "type": "string" + }, + "rowCount": { + "description": "The number of rows included in the encoded elevation data (i.e. the vertical resolution of the grid).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SegmentInfo": { + "description": "Extra metadata relating to segments.", + "id": "SegmentInfo", + "properties": { + "roadInfo": { + "$ref": "RoadInfo", + "description": "Metadata for features with the ROAD FeatureType." + } + }, + "type": "object" + }, + "TerrainTile": { + "description": "A tile containing information about the terrain located in the region it covers.", + "id": "TerrainTile", + "properties": { + "coordinates": { + "$ref": "TileCoordinates", + "description": "The global tile coordinates that uniquely identify this tile." + }, + "firstDerivative": { + "$ref": "FirstDerivativeElevationGrid", + "description": "Terrain elevation data encoded as a FirstDerivativeElevationGrid." + }, + "name": { + "description": "Resource name of the tile. The tile resource name is prefixed by its collection ID `terrain/` followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as `@,,z`. For example, `terrain/@1,2,3z`.", + "type": "string" + }, + "secondDerivative": { + "$ref": "SecondDerivativeElevationGrid", + "description": "Terrain elevation data encoded as a SecondDerivativeElevationGrid. ." + } + }, + "type": "object" + }, + "TileCoordinates": { + "description": "Global tile coordinates. Global tile coordinates reference a specific tile on the map at a specific zoom level. The origin of this coordinate system is always at the northwest corner of the map, with x values increasing from west to east and y values increasing from north to south. Tiles are indexed using x, y coordinates from that origin. The zoom level containing the entire world in a tile is 0, and it increases as you zoom in. Zoom level n + 1 will contain 4 times as many tiles as zoom level n. The zoom level controls the level of detail of the data that is returned. In particular, this affects the set of feature types returned, their density, and geometry simplification. The exact tile contents may change over time, but care will be taken to keep supporting the most important use cases. For example, zoom level 15 shows roads for orientation and planning in the local neighborhood and zoom level 17 shows buildings to give users on foot a sense of situational awareness.", + "id": "TileCoordinates", + "properties": { + "x": { + "description": "Required. The x coordinate.", + "format": "int32", + "type": "integer" + }, + "y": { + "description": "Required. The y coordinate.", + "format": "int32", + "type": "integer" + }, + "zoom": { + "description": "Required. The Google Maps API zoom level.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TriangleStrip": { + "description": "Represents a strip of triangles. Each triangle uses the last edge of the previous one. The following diagram shows an example of a triangle strip, with each vertex labeled with its index in the vertex_index array. (1)-----(3) / \\ / \\ / \\ / \\ / \\ / \\ (0)-----(2)-----(4) Vertices may be in either clockwise or counter-clockwise order.", + "id": "TriangleStrip", + "properties": { + "vertexIndices": { + "description": "Index into the vertex_offset array representing the next vertex in the triangle strip.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "Vertex2DList": { + "description": "2D vertex list used for lines and areas. Each entry represents an offset from the previous one in local tile coordinates. The first entry is offset from (0, 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded in vertex offsets as [(1, 1), (1, 1), (-1, 0)].", + "id": "Vertex2DList", + "properties": { + "xOffsets": { + "description": "List of x-offsets in local tile coordinates.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "yOffsets": { + "description": "List of y-offsets in local tile coordinates.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "Vertex3DList": { + "description": "3D vertex list used for modeled volumes. Each entry represents an offset from the previous one in local tile coordinates. The first coordinate is offset from (0, 0, 0).", + "id": "Vertex3DList", + "properties": { + "xOffsets": { + "description": "List of x-offsets in local tile coordinates.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "yOffsets": { + "description": "List of y-offsets in local tile coordinates.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "zOffsets": { + "description": "List of z-offsets in local tile coordinates.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Semantic Tile API", + "version": "v1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis/videointelligence__v1.json b/discovery/googleapis/videointelligence__v1.json index fa3b7e4..49dc6d4 100644 --- a/discovery/googleapis/videointelligence__v1.json +++ b/discovery/googleapis/videointelligence__v1.json
@@ -195,70 +195,6 @@ "resources": { "locations": { "resources": { - "corpora": { - "resources": { - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "videointelligence.projects.locations.corpora.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/corpora/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunning_Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "corpura": { - "resources": { - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "videointelligence.projects.locations.corpura.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/corpura/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunning_Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, "operations": { "methods": { "cancel": { @@ -404,7 +340,7 @@ } } }, - "revision": "20200911", + "revision": "20210128", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -433,20 +369,24 @@ "LABEL_DETECTION", "SHOT_CHANGE_DETECTION", "EXPLICIT_CONTENT_DETECTION", + "FACE_DETECTION", "SPEECH_TRANSCRIPTION", "TEXT_DETECTION", "OBJECT_TRACKING", - "LOGO_RECOGNITION" + "LOGO_RECOGNITION", + "PERSON_DETECTION" ], "enumDescriptions": [ "Unspecified.", "Label detection. Detect objects, such as dog or flower.", "Shot change detection.", "Explicit content detection.", + "Human face detection.", "Speech transcription.", "OCR text detection and tracking.", "Object detection and tracking.", - "Logo detection, tracking, and recognition." + "Logo detection, tracking, and recognition.", + "Person detection." ], "type": "string" }, @@ -610,6 +550,104 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1_FaceAnnotation": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1_FaceAnnotation", + "properties": { + "frames": { + "description": "All video frames where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_FaceFrame" + }, + "type": "array" + }, + "segments": { + "description": "All video segments where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_FaceSegment" + }, + "type": "array" + }, + "thumbnail": { + "description": "Thumbnail of a representative face view (in JPEG format).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1_FaceDetectionAnnotation": { + "description": "Face detection annotation.", + "id": "GoogleCloudVideointelligenceV1_FaceDetectionAnnotation", + "properties": { + "thumbnail": { + "description": "The thumbnail of a person's face.", + "format": "byte", + "type": "string" + }, + "tracks": { + "description": "The face tracks with attributes.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1_FaceDetectionConfig": { + "description": "Config for FACE_DETECTION.", + "id": "GoogleCloudVideointelligenceV1_FaceDetectionConfig", + "properties": { + "includeAttributes": { + "description": "Whether to enable face attributes detection, such as glasses, dark_glasses, mouth_open etc. Ignored if 'include_bounding_boxes' is set to false.", + "type": "boolean" + }, + "includeBoundingBoxes": { + "description": "Whether bounding boxes are included in the face annotation output.", + "type": "boolean" + }, + "model": { + "description": "Model to use for face detection. Supported values: \"builtin/stable\" (the default if unset) and \"builtin/latest\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1_FaceFrame": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1_FaceFrame", + "properties": { + "normalizedBoundingBoxes": { + "description": "Normalized Bounding boxes in a frame. There can be more than one boxes if the same face is detected in multiple locations within the current frame.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_NormalizedBoundingBox" + }, + "type": "array" + }, + "timeOffset": { + "description": "Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1_FaceSegment": { + "description": "Video segment level annotation results for face detection.", + "id": "GoogleCloudVideointelligenceV1_FaceSegment", + "properties": { + "segment": { + "$ref": "GoogleCloudVideointelligenceV1_VideoSegment", + "description": "Video segment where a face was detected." + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1_LabelAnnotation": { "description": "Label annotation.", "id": "GoogleCloudVideointelligenceV1_LabelAnnotation", @@ -866,6 +904,43 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1_PersonDetectionAnnotation": { + "description": "Person detection annotation per video.", + "id": "GoogleCloudVideointelligenceV1_PersonDetectionAnnotation", + "properties": { + "tracks": { + "description": "The detected tracks of a person.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1_PersonDetectionConfig": { + "description": "Config for PERSON_DETECTION.", + "id": "GoogleCloudVideointelligenceV1_PersonDetectionConfig", + "properties": { + "includeAttributes": { + "description": "Whether to enable person attributes detection, such as cloth color (black, blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair, etc. Ignored if 'include_bounding_boxes' is set to false.", + "type": "boolean" + }, + "includeBoundingBoxes": { + "description": "Whether bounding boxes are included in the person detection annotation output.", + "type": "boolean" + }, + "includePoseLandmarks": { + "description": "Whether to enable pose landmarks detection. Ignored if 'include_bounding_boxes' is set to false.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig": { "description": "Config for SHOT_CHANGE_DETECTION.", "id": "GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig", @@ -1137,20 +1212,24 @@ "LABEL_DETECTION", "SHOT_CHANGE_DETECTION", "EXPLICIT_CONTENT_DETECTION", + "FACE_DETECTION", "SPEECH_TRANSCRIPTION", "TEXT_DETECTION", "OBJECT_TRACKING", - "LOGO_RECOGNITION" + "LOGO_RECOGNITION", + "PERSON_DETECTION" ], "enumDescriptions": [ "Unspecified.", "Label detection. Detect objects, such as dog or flower.", "Shot change detection.", "Explicit content detection.", + "Human face detection.", "Speech transcription.", "OCR text detection and tracking.", "Object detection and tracking.", - "Logo detection, tracking, and recognition." + "Logo detection, tracking, and recognition.", + "Person detection." ], "type": "string" }, @@ -1192,6 +1271,20 @@ "$ref": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation", "description": "Explicit content annotation." }, + "faceAnnotations": { + "description": "Deprecated. Please use `face_detection_annotations` instead.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_FaceAnnotation" + }, + "type": "array" + }, + "faceDetectionAnnotations": { + "description": "Face detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_FaceDetectionAnnotation" + }, + "type": "array" + }, "frameLabelAnnotations": { "description": "Label annotations on frame level. There is exactly one element for each unique label.", "items": { @@ -1217,6 +1310,13 @@ }, "type": "array" }, + "personDetectionAnnotations": { + "description": "Person detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_PersonDetectionAnnotation" + }, + "type": "array" + }, "segment": { "$ref": "GoogleCloudVideointelligenceV1_VideoSegment", "description": "Video segment on which the annotation is run." @@ -1281,6 +1381,10 @@ "$ref": "GoogleCloudVideointelligenceV1_ExplicitContentDetectionConfig", "description": "Config for EXPLICIT_CONTENT_DETECTION." }, + "faceDetectionConfig": { + "$ref": "GoogleCloudVideointelligenceV1_FaceDetectionConfig", + "description": "Config for FACE_DETECTION." + }, "labelDetectionConfig": { "$ref": "GoogleCloudVideointelligenceV1_LabelDetectionConfig", "description": "Config for LABEL_DETECTION." @@ -1289,6 +1393,10 @@ "$ref": "GoogleCloudVideointelligenceV1_ObjectTrackingConfig", "description": "Config for OBJECT_TRACKING." }, + "personDetectionConfig": { + "$ref": "GoogleCloudVideointelligenceV1_PersonDetectionConfig", + "description": "Config for PERSON_DETECTION." + }, "segments": { "description": "Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.", "items": { @@ -1498,6 +1606,85 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1beta2_FaceAnnotation": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1beta2_FaceAnnotation", + "properties": { + "frames": { + "description": "All video frames where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_FaceFrame" + }, + "type": "array" + }, + "segments": { + "description": "All video segments where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_FaceSegment" + }, + "type": "array" + }, + "thumbnail": { + "description": "Thumbnail of a representative face view (in JPEG format).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1beta2_FaceDetectionAnnotation": { + "description": "Face detection annotation.", + "id": "GoogleCloudVideointelligenceV1beta2_FaceDetectionAnnotation", + "properties": { + "thumbnail": { + "description": "The thumbnail of a person's face.", + "format": "byte", + "type": "string" + }, + "tracks": { + "description": "The face tracks with attributes.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1beta2_FaceFrame": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1beta2_FaceFrame", + "properties": { + "normalizedBoundingBoxes": { + "description": "Normalized Bounding boxes in a frame. There can be more than one boxes if the same face is detected in multiple locations within the current frame.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_NormalizedBoundingBox" + }, + "type": "array" + }, + "timeOffset": { + "description": "Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1beta2_FaceSegment": { + "description": "Video segment level annotation results for face detection.", + "id": "GoogleCloudVideointelligenceV1beta2_FaceSegment", + "properties": { + "segment": { + "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment", + "description": "Video segment where a face was detected." + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1beta2_LabelAnnotation": { "description": "Label annotation.", "id": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation", @@ -1702,6 +1889,24 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1beta2_PersonDetectionAnnotation": { + "description": "Person detection annotation per video.", + "id": "GoogleCloudVideointelligenceV1beta2_PersonDetectionAnnotation", + "properties": { + "tracks": { + "description": "The detected tracks of a person.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative": { "description": "Alternative hypotheses (a.k.a. n-best list).", "id": "GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative", @@ -1878,20 +2083,24 @@ "LABEL_DETECTION", "SHOT_CHANGE_DETECTION", "EXPLICIT_CONTENT_DETECTION", + "FACE_DETECTION", "SPEECH_TRANSCRIPTION", "TEXT_DETECTION", "OBJECT_TRACKING", - "LOGO_RECOGNITION" + "LOGO_RECOGNITION", + "PERSON_DETECTION" ], "enumDescriptions": [ "Unspecified.", "Label detection. Detect objects, such as dog or flower.", "Shot change detection.", "Explicit content detection.", + "Human face detection.", "Speech transcription.", "OCR text detection and tracking.", "Object detection and tracking.", - "Logo detection, tracking, and recognition." + "Logo detection, tracking, and recognition.", + "Person detection." ], "type": "string" }, @@ -1933,6 +2142,20 @@ "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation", "description": "Explicit content annotation." }, + "faceAnnotations": { + "description": "Deprecated. Please use `face_detection_annotations` instead.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_FaceAnnotation" + }, + "type": "array" + }, + "faceDetectionAnnotations": { + "description": "Face detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_FaceDetectionAnnotation" + }, + "type": "array" + }, "frameLabelAnnotations": { "description": "Label annotations on frame level. There is exactly one element for each unique label.", "items": { @@ -1958,6 +2181,13 @@ }, "type": "array" }, + "personDetectionAnnotations": { + "description": "Person detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_PersonDetectionAnnotation" + }, + "type": "array" + }, "segment": { "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment", "description": "Video segment on which the annotation is run." @@ -2201,6 +2431,85 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation", + "properties": { + "frames": { + "description": "All video frames where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_FaceFrame" + }, + "type": "array" + }, + "segments": { + "description": "All video segments where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_FaceSegment" + }, + "type": "array" + }, + "thumbnail": { + "description": "Thumbnail of a representative face view (in JPEG format).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAnnotation": { + "description": "Face detection annotation.", + "id": "GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAnnotation", + "properties": { + "thumbnail": { + "description": "The thumbnail of a person's face.", + "format": "byte", + "type": "string" + }, + "tracks": { + "description": "The face tracks with attributes.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1p1beta1_FaceFrame": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1p1beta1_FaceFrame", + "properties": { + "normalizedBoundingBoxes": { + "description": "Normalized Bounding boxes in a frame. There can be more than one boxes if the same face is detected in multiple locations within the current frame.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_NormalizedBoundingBox" + }, + "type": "array" + }, + "timeOffset": { + "description": "Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1p1beta1_FaceSegment": { + "description": "Video segment level annotation results for face detection.", + "id": "GoogleCloudVideointelligenceV1p1beta1_FaceSegment", + "properties": { + "segment": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_VideoSegment", + "description": "Video segment where a face was detected." + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation": { "description": "Label annotation.", "id": "GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation", @@ -2405,6 +2714,24 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1p1beta1_PersonDetectionAnnotation": { + "description": "Person detection annotation per video.", + "id": "GoogleCloudVideointelligenceV1p1beta1_PersonDetectionAnnotation", + "properties": { + "tracks": { + "description": "The detected tracks of a person.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative": { "description": "Alternative hypotheses (a.k.a. n-best list).", "id": "GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative", @@ -2581,20 +2908,24 @@ "LABEL_DETECTION", "SHOT_CHANGE_DETECTION", "EXPLICIT_CONTENT_DETECTION", + "FACE_DETECTION", "SPEECH_TRANSCRIPTION", "TEXT_DETECTION", "OBJECT_TRACKING", - "LOGO_RECOGNITION" + "LOGO_RECOGNITION", + "PERSON_DETECTION" ], "enumDescriptions": [ "Unspecified.", "Label detection. Detect objects, such as dog or flower.", "Shot change detection.", "Explicit content detection.", + "Human face detection.", "Speech transcription.", "OCR text detection and tracking.", "Object detection and tracking.", - "Logo detection, tracking, and recognition." + "Logo detection, tracking, and recognition.", + "Person detection." ], "type": "string" }, @@ -2636,6 +2967,20 @@ "$ref": "GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation", "description": "Explicit content annotation." }, + "faceAnnotations": { + "description": "Deprecated. Please use `face_detection_annotations` instead.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation" + }, + "type": "array" + }, + "faceDetectionAnnotations": { + "description": "Face detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_FaceDetectionAnnotation" + }, + "type": "array" + }, "frameLabelAnnotations": { "description": "Label annotations on frame level. There is exactly one element for each unique label.", "items": { @@ -2661,6 +3006,13 @@ }, "type": "array" }, + "personDetectionAnnotations": { + "description": "Person detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p1beta1_PersonDetectionAnnotation" + }, + "type": "array" + }, "segment": { "$ref": "GoogleCloudVideointelligenceV1p1beta1_VideoSegment", "description": "Video segment on which the annotation is run." @@ -2904,6 +3256,85 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation", + "properties": { + "frames": { + "description": "All video frames where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_FaceFrame" + }, + "type": "array" + }, + "segments": { + "description": "All video segments where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_FaceSegment" + }, + "type": "array" + }, + "thumbnail": { + "description": "Thumbnail of a representative face view (in JPEG format).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1p2beta1_FaceDetectionAnnotation": { + "description": "Face detection annotation.", + "id": "GoogleCloudVideointelligenceV1p2beta1_FaceDetectionAnnotation", + "properties": { + "thumbnail": { + "description": "The thumbnail of a person's face.", + "format": "byte", + "type": "string" + }, + "tracks": { + "description": "The face tracks with attributes.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1p2beta1_FaceFrame": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1p2beta1_FaceFrame", + "properties": { + "normalizedBoundingBoxes": { + "description": "Normalized Bounding boxes in a frame. There can be more than one boxes if the same face is detected in multiple locations within the current frame.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox" + }, + "type": "array" + }, + "timeOffset": { + "description": "Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1p2beta1_FaceSegment": { + "description": "Video segment level annotation results for face detection.", + "id": "GoogleCloudVideointelligenceV1p2beta1_FaceSegment", + "properties": { + "segment": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_VideoSegment", + "description": "Video segment where a face was detected." + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation": { "description": "Label annotation.", "id": "GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation", @@ -3108,6 +3539,24 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1p2beta1_PersonDetectionAnnotation": { + "description": "Person detection annotation per video.", + "id": "GoogleCloudVideointelligenceV1p2beta1_PersonDetectionAnnotation", + "properties": { + "tracks": { + "description": "The detected tracks of a person.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_Track" + }, + "type": "array" + }, + "version": { + "description": "Feature version.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative": { "description": "Alternative hypotheses (a.k.a. n-best list).", "id": "GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative", @@ -3284,20 +3733,24 @@ "LABEL_DETECTION", "SHOT_CHANGE_DETECTION", "EXPLICIT_CONTENT_DETECTION", + "FACE_DETECTION", "SPEECH_TRANSCRIPTION", "TEXT_DETECTION", "OBJECT_TRACKING", - "LOGO_RECOGNITION" + "LOGO_RECOGNITION", + "PERSON_DETECTION" ], "enumDescriptions": [ "Unspecified.", "Label detection. Detect objects, such as dog or flower.", "Shot change detection.", "Explicit content detection.", + "Human face detection.", "Speech transcription.", "OCR text detection and tracking.", "Object detection and tracking.", - "Logo detection, tracking, and recognition." + "Logo detection, tracking, and recognition.", + "Person detection." ], "type": "string" }, @@ -3339,6 +3792,20 @@ "$ref": "GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation", "description": "Explicit content annotation." }, + "faceAnnotations": { + "description": "Deprecated. Please use `face_detection_annotations` instead.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation" + }, + "type": "array" + }, + "faceDetectionAnnotations": { + "description": "Face detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_FaceDetectionAnnotation" + }, + "type": "array" + }, "frameLabelAnnotations": { "description": "Label annotations on frame level. There is exactly one element for each unique label.", "items": { @@ -3364,6 +3831,13 @@ }, "type": "array" }, + "personDetectionAnnotations": { + "description": "Person detection annotations.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p2beta1_PersonDetectionAnnotation" + }, + "type": "array" + }, "segment": { "$ref": "GoogleCloudVideointelligenceV1p2beta1_VideoSegment", "description": "Video segment on which the annotation is run." @@ -3662,6 +4136,32 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation", + "properties": { + "frames": { + "description": "All video frames where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p3beta1_FaceFrame" + }, + "type": "array" + }, + "segments": { + "description": "All video segments where a face was detected.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p3beta1_FaceSegment" + }, + "type": "array" + }, + "thumbnail": { + "description": "Thumbnail of a representative face view (in JPEG format).", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation": { "description": "Face detection annotation.", "id": "GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation", @@ -3685,6 +4185,36 @@ }, "type": "object" }, + "GoogleCloudVideointelligenceV1p3beta1_FaceFrame": { + "description": "Deprecated. No effect.", + "id": "GoogleCloudVideointelligenceV1p3beta1_FaceFrame", + "properties": { + "normalizedBoundingBoxes": { + "description": "Normalized Bounding boxes in a frame. There can be more than one boxes if the same face is detected in multiple locations within the current frame.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p3beta1_NormalizedBoundingBox" + }, + "type": "array" + }, + "timeOffset": { + "description": "Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudVideointelligenceV1p3beta1_FaceSegment": { + "description": "Video segment level annotation results for face detection.", + "id": "GoogleCloudVideointelligenceV1p3beta1_FaceSegment", + "properties": { + "segment": { + "$ref": "GoogleCloudVideointelligenceV1p3beta1_VideoSegment", + "description": "Video segment where a face was detected." + } + }, + "type": "object" + }, "GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation": { "description": "Label annotation.", "id": "GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation", @@ -3987,13 +4517,18 @@ "type": "object" }, "GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults": { - "description": "Streaming annotation results corresponding to a portion of the video that is currently being processed.", + "description": "Streaming annotation results corresponding to a portion of the video that is currently being processed. Only ONE type of annotation will be specified in the response.", "id": "GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults", "properties": { "explicitAnnotation": { "$ref": "GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation", "description": "Explicit content annotation results." }, + "frameTimestamp": { + "description": "Timestamp of the processed frame in microseconds.", + "format": "google-duration", + "type": "string" + }, "labelAnnotations": { "description": "Label annotation results.", "items": { @@ -4215,6 +4750,13 @@ "$ref": "GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation", "description": "Explicit content annotation." }, + "faceAnnotations": { + "description": "Deprecated. Please use `face_detection_annotations` instead.", + "items": { + "$ref": "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation" + }, + "type": "array" + }, "faceDetectionAnnotations": { "description": "Face detection annotations.", "items": {
diff --git a/discovery/googleapis/vision__v1.json b/discovery/googleapis/vision__v1.json index 68b306d..b232e0c 100644 --- a/discovery/googleapis/vision__v1.json +++ b/discovery/googleapis/vision__v1.json
@@ -1242,7 +1242,7 @@ } } }, - "revision": "20201003", + "revision": "20210124", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { @@ -8338,7 +8338,7 @@ "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", + "description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", "id": "LatLng", "properties": { "latitude": {
diff --git a/discovery/googleapis/webfonts__v1.json b/discovery/googleapis/webfonts__v1.json index bbf20fb..6e81aba 100644 --- a/discovery/googleapis/webfonts__v1.json +++ b/discovery/googleapis/webfonts__v1.json
@@ -132,7 +132,7 @@ } } }, - "revision": "20200915", + "revision": "20210120", "rootUrl": "https://webfonts.googleapis.com/", "schemas": { "Webfont": {
diff --git a/discovery/googleapis/webmasters__v3.json b/discovery/googleapis/webmasters__v3.json index f6ec022..42e340f 100644 --- a/discovery/googleapis/webmasters__v3.json +++ b/discovery/googleapis/webmasters__v3.json
@@ -373,6 +373,10 @@ "description": "[Optional; Default is \"auto\"] How data is aggregated. If aggregated by property, all data for the same property is aggregated; if aggregated by page, all data is aggregated by canonical URI. If you filter or group by page, choose AUTO; otherwise you can aggregate either by property or by page, depending on how you want your data calculated; see the help documentation to learn how data is calculated differently by site versus by page.\n\nNote: If you group or filter by page, you cannot aggregate by property.\n\nIf you specify any value other than AUTO, the aggregation type in the result will match the requested type, or if you request an invalid type, you will get an error. The API will never change your aggregation type if the requested type is invalid.", "type": "string" }, + "dataState": { + "description": "[Optional] If \"all\" (case-insensitive), data will include fresh data. If \"final\" (case-insensitive) or if this parameter is omitted, the returned data will include only finalized data.", + "type": "string" + }, "dimensionFilterGroups": { "description": "[Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \"buy\"' to see only data where the query string contains the substring \"buy\" (not case-sensitive). You can filter by a dimension without grouping by it.", "items": {
diff --git a/discovery/googleapis/websecurityscanner__v1.json b/discovery/googleapis/websecurityscanner__v1.json index 0327793..f728031 100644 --- a/discovery/googleapis/websecurityscanner__v1.json +++ b/discovery/googleapis/websecurityscanner__v1.json
@@ -511,7 +511,7 @@ } } }, - "revision": "20201003", + "revision": "20210118", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": {
diff --git a/discovery/googleapis/youtubeAnalytics__v2.json b/discovery/googleapis/youtubeAnalytics__v2.json index cbf22e8..10b086f 100644 --- a/discovery/googleapis/youtubeAnalytics__v2.json +++ b/discovery/googleapis/youtubeAnalytics__v2.json
@@ -411,7 +411,7 @@ } } }, - "revision": "20201007", + "revision": "20210203", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": { "EmptyResponse": {
diff --git a/discovery/googleapis/youtube__v3.json b/discovery/googleapis/youtube__v3.json index 86d9b15..ab0da26 100644 --- a/discovery/googleapis/youtube__v3.json +++ b/discovery/googleapis/youtube__v3.json
@@ -27,8 +27,8 @@ } }, "basePath": "", - "baseUrl": "https://www.googleapis.com/", - "batchPath": "batch/youtube/v3", + "baseUrl": "https://youtube.googleapis.com/", + "batchPath": "batch", "canonicalName": "YouTube", "description": "The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.", "discoveryVersion": "v1", @@ -176,6 +176,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "mine": { @@ -363,8 +365,8 @@ "httpMethod": "GET", "id": "youtube.captions.list", "parameterOrder": [ - "videoId", - "part" + "part", + "videoId" ], "parameters": { "id": { @@ -725,6 +727,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "mine": { @@ -861,6 +865,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "100", + "minimum": "1", "type": "integer" }, "moderationStatus": { @@ -1039,6 +1045,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "100", + "minimum": "1", "type": "integer" }, "pageToken": { @@ -1300,65 +1308,6 @@ "https://www.googleapis.com/auth/youtube.force-ssl" ] }, - "control": { - "description": "Slate and recording control of the live broadcast. Support actions: slate on/off, recording start/stop/pause/resume. Design doc: goto/yt-api-liveBroadcast-control", - "httpMethod": "POST", - "id": "youtube.liveBroadcasts.control", - "parameterOrder": [ - "id", - "part" - ], - "parameters": { - "displaySlate": { - "description": "Whether display or hide slate.", - "location": "query", - "type": "boolean" - }, - "id": { - "description": "Broadcast to operate.", - "location": "query", - "required": true, - "type": "string" - }, - "offsetTimeMs": { - "description": "The exact time when the actions (e.g. slate on) are executed. It is an offset from the first frame of the monitor stream. If not set, it means \"now\" or ASAP. This field should not be set if the monitor stream is disabled, otherwise an error will be returned.", - "format": "uint64", - "location": "query", - "type": "string" - }, - "onBehalfOfContentOwner": { - "description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.", - "location": "query", - "type": "string" - }, - "onBehalfOfContentOwnerChannel": { - "description": "This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.", - "location": "query", - "type": "string" - }, - "part": { - "description": "The *part* parameter specifies a comma-separated list of one or more liveBroadcast resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, and status.", - "location": "query", - "repeated": true, - "required": true, - "type": "string" - }, - "walltime": { - "description": "The wall clock time at which the action should be executed. Only one of offset_time_ms and walltime may be set at a time.", - "format": "google-datetime", - "location": "query", - "type": "string" - } - }, - "path": "youtube/v3/liveBroadcasts/control", - "response": { - "$ref": "LiveBroadcast" - }, - "scopes": [ - "https://www.googleapis.com/auth/youtube", - "https://www.googleapis.com/auth/youtube.force-ssl" - ] - }, "delete": { "description": "Delete a given broadcast.", "httpMethod": "DELETE", @@ -1484,6 +1433,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "mine": { @@ -1528,8 +1479,8 @@ "httpMethod": "POST", "id": "youtube.liveBroadcasts.transition", "parameterOrder": [ - "id", "broadcastStatus", + "id", "part" ], "parameters": { @@ -1751,6 +1702,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "2000", + "minimum": "200", "type": "integer" }, "pageToken": { @@ -1769,6 +1722,8 @@ "description": "Specifies the size of the profile image that should be returned for each user.", "format": "uint32", "location": "query", + "maximum": "720", + "minimum": "16", "type": "integer" } }, @@ -1854,6 +1809,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "pageToken": { @@ -1932,7 +1889,7 @@ "type": "string" }, "part": { - "description": "The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status.", + "description": "The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, content_details, and status.", "location": "query", "repeated": true, "required": true, @@ -1970,6 +1927,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "mine": { @@ -2074,6 +2033,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "1000", + "minimum": "0", "type": "integer" }, "mode": { @@ -2110,11 +2071,7 @@ "$ref": "MemberListResponse" }, "scopes": [ - "https://www.googleapis.com/auth/youtube", - "https://www.googleapis.com/auth/youtube.channel-memberships.creator", - "https://www.googleapis.com/auth/youtube.force-ssl", - "https://www.googleapis.com/auth/youtube.readonly", - "https://www.googleapis.com/auth/youtubepartner" + "https://www.googleapis.com/auth/youtube.channel-memberships.creator" ] } } @@ -2142,11 +2099,7 @@ "$ref": "MembershipsLevelListResponse" }, "scopes": [ - "https://www.googleapis.com/auth/youtube", - "https://www.googleapis.com/auth/youtube.channel-memberships.creator", - "https://www.googleapis.com/auth/youtube.force-ssl", - "https://www.googleapis.com/auth/youtube.readonly", - "https://www.googleapis.com/auth/youtubepartner" + "https://www.googleapis.com/auth/youtube.channel-memberships.creator" ] } } @@ -2231,6 +2184,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "onBehalfOfContentOwner": { @@ -2404,6 +2359,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "mine": { @@ -2558,6 +2515,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "onBehalfOfContentOwner": { @@ -2810,64 +2769,6 @@ } } }, - "sponsors": { - "methods": { - "list": { - "description": "Retrieves a list of sponsors that match the request criteria for a channel.", - "httpMethod": "GET", - "id": "youtube.sponsors.list", - "parameterOrder": [ - "part" - ], - "parameters": { - "filter": { - "default": "newest", - "description": "Parameter that specifies which channel sponsors to return.", - "enum": [ - "sponsorFilterUnknown", - "newest", - "all" - ], - "enumDescriptions": [ - "", - "Return the most recent sponsors, from newest to oldest.", - "Return all sponsors, from newest to oldest." - ], - "location": "query", - "type": "string" - }, - "maxResults": { - "default": "5", - "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", - "format": "uint32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.", - "location": "query", - "type": "string" - }, - "part": { - "description": "The *part* parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet.", - "location": "query", - "repeated": true, - "required": true, - "type": "string" - } - }, - "path": "youtube/v3/sponsors", - "response": { - "$ref": "SponsorListResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/youtube", - "https://www.googleapis.com/auth/youtube.force-ssl", - "https://www.googleapis.com/auth/youtube.readonly" - ] - } - } - }, "subscriptions": { "methods": { "delete": { @@ -2949,6 +2850,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "0", "type": "integer" }, "mine": { @@ -3039,6 +2942,8 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "1", "type": "integer" }, "pageToken": { @@ -3290,7 +3195,7 @@ ], "parameters": { "hl": { - "default": "en_US", + "default": "en-US", "location": "query", "type": "string" }, @@ -3531,6 +3436,8 @@ "maxHeight": { "format": "int32", "location": "query", + "maximum": "8192", + "minimum": "72", "type": "integer" }, "maxResults": { @@ -3538,12 +3445,16 @@ "description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. *Note:* This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter.", "format": "uint32", "location": "query", + "maximum": "50", + "minimum": "1", "type": "integer" }, "maxWidth": { "description": "Return the player with maximum height specified in", "format": "int32", "location": "query", + "maximum": "8192", + "minimum": "72", "type": "integer" }, "myRating": { @@ -3776,8 +3687,8 @@ } } }, - "revision": "20201007", - "rootUrl": "https://www.googleapis.com/", + "revision": "20210203", + "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { "id": "AbuseReport", @@ -4201,7 +4112,8 @@ "type": "string" }, "publishedAt": { - "description": "The date and time that the video was uploaded. The value is specified in ISO 8601 format.", + "description": "The date and time that the video was uploaded.", + "format": "date-time", "type": "string" }, "thumbnails": { @@ -4365,7 +4277,8 @@ "type": "string" }, "lastUpdated": { - "description": "The date and time when the caption track was last updated. The value is specified in ISO 8601 format.", + "description": "The date and time when the caption track was last updated.", + "format": "date-time", "type": "string" }, "name": { @@ -4649,7 +4562,8 @@ "type": "string" }, "timeLinked": { - "description": "The date and time of when the channel was linked to the content owner. The value is specified in ISO 8601 format.", + "description": "The date and time when the channel was linked to the content owner.", + "format": "date-time", "type": "string" } }, @@ -5077,7 +4991,8 @@ "description": "Localized title and description, read-only." }, "publishedAt": { - "description": "The date and time that the channel was created. The value is specified in < a href=\"//www.w3.org/TR/NOTE-datetime\">ISO 8601 format.", + "description": "The date and time that the channel was created.", + "format": "date-time", "type": "string" }, "thumbnails": { @@ -5323,7 +5238,8 @@ "type": "string" }, "publishedAt": { - "description": "The date and time when the comment was orignally published. The value is specified in ISO 8601 format.", + "description": "The date and time when the comment was originally published.", + "format": "date-time", "type": "string" }, "textDisplay": { @@ -5335,7 +5251,8 @@ "type": "string" }, "updatedAt": { - "description": "The date and time when was last updated . The value is specified in ISO 8601 format.", + "description": "The date and time when the comment was last updated.", + "format": "date-time", "type": "string" }, "videoId": { @@ -7407,7 +7324,7 @@ "description": "The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k." }, "bannerExternalUrl": { - "description": "This is used only in update requests; if it's set, we use this URL to generate all of the above banner URLs.", + "description": "This is generated when a ChannelBanner.Insert request has succeeded for the given channel.", "type": "string" }, "bannerImageUrl": { @@ -7674,6 +7591,7 @@ }, "boundStreamLastUpdateTimeMs": { "description": "The date and time that the live stream referenced by boundStreamId was last updated.", + "format": "date-time", "type": "string" }, "closedCaptionsType": { @@ -7792,6 +7710,22 @@ }, "description": "This setting indicates whether the broadcast should automatically begin with an in-stream slate when you update the broadcast's status to live. After updating the status, you then need to send a liveCuepoints.insert request that sets the cuepoint's eventState to end to remove the in-stream slate and make your broadcast stream visible to viewers.", "type": "boolean" + }, + "stereoLayout": { + "description": "The 3D stereo layout of this broadcast. This defaults to mono.", + "enum": [ + "stereoLayoutUnspecified", + "mono", + "leftRight", + "topBottom" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -7846,11 +7780,13 @@ "id": "LiveBroadcastSnippet", "properties": { "actualEndTime": { - "description": "The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete. The value is specified in ISO 8601 format.", + "description": "The date and time that the broadcast actually ended. This information is only available once the broadcast's state is complete.", + "format": "date-time", "type": "string" }, "actualStartTime": { - "description": "The date and time that the broadcast actually started. This information is only available once the broadcast's state is live. The value is specified in ISO 8601 format.", + "description": "The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.", + "format": "date-time", "type": "string" }, "channelId": { @@ -7870,15 +7806,18 @@ "type": "string" }, "publishedAt": { - "description": "The date and time that the broadcast was added to YouTube's live broadcast schedule. The value is specified in ISO 8601 format.", + "description": "The date and time that the broadcast was added to YouTube's live broadcast schedule.", + "format": "date-time", "type": "string" }, "scheduledEndTime": { - "description": "The date and time that the broadcast is scheduled to end. The value is specified in ISO 8601 format.", + "description": "The date and time that the broadcast is scheduled to start.", + "format": "date-time", "type": "string" }, "scheduledStartTime": { - "description": "The date and time that the broadcast is scheduled to start. The value is specified in ISO 8601 format.", + "description": "The date and time that the broadcast is scheduled to end.", + "format": "date-time", "type": "string" }, "thumbnails": { @@ -8171,7 +8110,8 @@ "type": "string" }, "offlineAt": { - "description": "The date and time when the underlying stream went offline. The value is specified in ISO 8601 format.", + "description": "The date and time when the underlying stream went offline.", + "format": "date-time", "type": "string" }, "pageInfo": { @@ -8231,7 +8171,8 @@ "$ref": "LiveChatMessageRetractedDetails" }, "publishedAt": { - "description": "The date and time when the message was orignally published. The value is specified in ISO 8601 format.", + "description": "The date and time when the message was orignally published.", + "format": "date-time", "type": "string" }, "superChatDetails": { @@ -8712,7 +8653,8 @@ "type": "boolean" }, "publishedAt": { - "description": "The date and time that the stream was created. The value is specified in ISO 8601 format.", + "description": "The date and time that the stream was created.", + "format": "date-time", "type": "string" }, "title": { @@ -9146,7 +9088,8 @@ "type": "string" }, "videoPublishedAt": { - "description": "The date and time that the video was published to YouTube. The value is specified in ISO 8601 format.", + "description": "The date and time that the video was published to YouTube.", + "format": "date-time", "type": "string" } }, @@ -9222,7 +9165,8 @@ "type": "integer" }, "publishedAt": { - "description": "The date and time that the item was added to the playlist. The value is specified in ISO 8601 format.", + "description": "The date and time that the item was added to the playlist.", + "format": "date-time", "type": "string" }, "resourceId": { @@ -9356,7 +9300,8 @@ "description": "Localized title and description, read-only." }, "publishedAt": { - "description": "The date and time that the playlist was created. The value is specified in ISO 8601 format.", + "description": "The date and time that the playlist was created.", + "format": "date-time", "type": "string" }, "tags": { @@ -9549,7 +9494,8 @@ "type": "string" }, "publishedAt": { - "description": "The creation date and time of the resource that the search result identifies. The value is specified in ISO 8601 format.", + "description": "The creation date and time of the resource that the search result identifies.", + "format": "date-time", "type": "string" }, "thumbnails": { @@ -9563,89 +9509,6 @@ }, "type": "object" }, - "Sponsor": { - "description": "A `__sponsor__` resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits.", - "id": "Sponsor", - "properties": { - "etag": { - "description": "Etag of this resource.", - "type": "string" - }, - "kind": { - "default": "youtube#sponsor", - "description": "Identifies what kind of resource this is. Value: the fixed string `\"youtube#sponsor\"`.", - "type": "string" - }, - "snippet": { - "$ref": "SponsorSnippet", - "description": "The `snippet` object contains basic details about the sponsor." - } - }, - "type": "object" - }, - "SponsorListResponse": { - "id": "SponsorListResponse", - "properties": { - "etag": { - "description": "Etag of this resource.", - "type": "string" - }, - "eventId": { - "description": "Serialized EventId of the request which produced this response.", - "type": "string" - }, - "items": { - "description": "A list of sponsors that match the request criteria.", - "items": { - "$ref": "Sponsor" - }, - "type": "array" - }, - "kind": { - "default": "youtube#sponsorListResponse", - "description": "Identifies what kind of resource this is. Value: the fixed string `\"youtube#sponsorListResponse\".", - "type": "string" - }, - "nextPageToken": { - "description": "The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set.", - "type": "string" - }, - "pageInfo": { - "$ref": "PageInfo" - }, - "tokenPagination": { - "$ref": "TokenPagination" - }, - "visitorId": { - "description": "The `visitorId` identifies the visitor.", - "type": "string" - } - }, - "type": "object" - }, - "SponsorSnippet": { - "id": "SponsorSnippet", - "properties": { - "channelId": { - "description": "The id of the channel being sponsored.", - "type": "string" - }, - "cumulativeDurationMonths": { - "description": "The cumulative time a user has been a sponsor in months.", - "format": "int32", - "type": "integer" - }, - "sponsorDetails": { - "$ref": "ChannelProfileDetails", - "description": "Details about the sponsor." - }, - "sponsorSince": { - "description": "The date and time when the user became a sponsor. The value is specified in ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`) format.", - "type": "string" - } - }, - "type": "object" - }, "Subscription": { "description": "A *subscription* resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.", "id": "Subscription", @@ -9770,7 +9633,8 @@ "type": "string" }, "publishedAt": { - "description": "The date and time that the subscription was created. The value is specified in ISO 8601 format.", + "description": "The date and time that the subscription was created.", + "format": "date-time", "type": "string" }, "resourceId": { @@ -9897,7 +9761,8 @@ "type": "string" }, "createdAt": { - "description": "The date and time when the event occurred. The value is specified in ISO 8601 format.", + "description": "The date and time when the event occurred.", + "format": "date-time", "type": "string" }, "currency": { @@ -10178,7 +10043,7 @@ }, "projectDetails": { "$ref": "VideoProjectDetails", - "description": "The projectDetails object contains information about the project specific video metadata." + "description": "The projectDetails object contains information about the project specific video metadata. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [1] https://developers.google.com/resources/api-libraries/documentation/youtube/v3/csharp/latest/classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569&rcl=344141677" }, "recordingDetails": { "$ref": "VideoRecordingDetails", @@ -10735,11 +10600,13 @@ "type": "string" }, "actualEndTime": { - "description": "The time that the broadcast actually ended. The value is specified in ISO 8601 format. This value will not be available until the broadcast is over.", + "description": "The time that the broadcast actually ended. This value will not be available until the broadcast is over.", + "format": "date-time", "type": "string" }, "actualStartTime": { - "description": "The time that the broadcast actually started. The value is specified in ISO 8601 format. This value will not be available until the broadcast begins.", + "description": "The time that the broadcast actually started. This value will not be available until the broadcast begins.", + "format": "date-time", "type": "string" }, "concurrentViewers": { @@ -10748,11 +10615,13 @@ "type": "string" }, "scheduledEndTime": { - "description": "The time that the broadcast is scheduled to end. The value is specified in ISO 8601 format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.", + "description": "The time that the broadcast is scheduled to end. If the value is empty or the property is not present, then the broadcast is scheduled to contiue indefinitely.", + "format": "date-time", "type": "string" }, "scheduledStartTime": { - "description": "The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 format.", + "description": "The time that the broadcast is scheduled to begin.", + "format": "date-time", "type": "string" } }, @@ -10890,17 +10759,9 @@ "type": "object" }, "VideoProjectDetails": { - "description": "Project specific details about the content of a YouTube Video.", + "description": "DEPRECATED. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [1] https://developers.google.com/resources/api-libraries/documentation/youtube/v3/csharp/latest/classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569&rcl=344141677", "id": "VideoProjectDetails", - "properties": { - "tags": { - "description": "A list of project tags associated with the video during the upload.", - "items": { - "type": "string" - }, - "type": "array" - } - }, + "properties": {}, "type": "object" }, "VideoRating": { @@ -10971,7 +10832,8 @@ "type": "string" }, "recordingDate": { - "description": "The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.", + "description": "The date and time when the video was recorded.", + "format": "date-time", "type": "string" } }, @@ -11026,7 +10888,8 @@ "description": "Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)" }, "publishedAt": { - "description": "The date and time that the video was uploaded. The value is specified in ISO 8601 format.", + "description": "The date and time when the video was uploaded.", + "format": "date-time", "type": "string" }, "tags": { @@ -11141,7 +11004,8 @@ "type": "boolean" }, "publishAt": { - "description": "The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 format.", + "description": "The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private..", + "format": "date-time", "type": "string" }, "rejectionReason": {
diff --git a/discovery/googleapis/youtubereporting__v1.json b/discovery/googleapis/youtubereporting__v1.json index ecdcac2..c2252cd 100644 --- a/discovery/googleapis/youtubereporting__v1.json +++ b/discovery/googleapis/youtubereporting__v1.json
@@ -402,7 +402,7 @@ } } }, - "revision": "20201007", + "revision": "20210203", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": {
diff --git a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json index 4225912..85a7b09 100644 --- a/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json +++ b/discovery/googleapis_beta/adexchangebuyer2__v2beta1.json
@@ -958,7 +958,7 @@ "proposals": { "methods": { "accept": { - "description": "Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`.", + "description": "Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an `ABORTED` error message will be returned. This call updates the proposal_state from `PROPOSED` to `BUYER_ACCEPTED`, or from `SELLER_ACCEPTED` to `FINALIZED`. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.", "httpMethod": "POST", "id": "adexchangebuyer2.accounts.proposals.accept", "parameterOrder": [ @@ -2437,7 +2437,7 @@ } } }, - "revision": "20201008", + "revision": "20210203", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { @@ -3397,21 +3397,21 @@ "type": "object" }, "Date": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "Date", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -3495,7 +3495,7 @@ "type": "string" }, "availableStartTime": { - "description": "Optional proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.", + "description": "Optional. Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (e.g., in milliseconds) will be truncated towards the start of time in seconds.", "format": "google-datetime", "type": "string" }, @@ -3508,13 +3508,14 @@ "type": "string" }, "createProductRevision": { - "description": "Optional revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced sinced the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", + "description": "Optional. Revision number of the product that the deal was created from. If present on create, and the server `product_revision` has advanced since the passed-in `create_product_revision`, an `ABORTED` error will be returned. Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", "format": "int64", "type": "string" }, "createTime": { "description": "Output only. The time of the deal creation.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "creativePreApprovalPolicy": { @@ -3529,11 +3530,13 @@ "The seller needs to approve each creative before it can serve.", "The seller does not need to approve each creative before it can serve." ], + "readOnly": true, "type": "string" }, "creativeRestrictions": { "$ref": "CreativeRestrictions", - "description": "Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager." + "description": "Output only. Restricitions about the creatives associated with the deal (i.e., size) This is available for Programmatic Guaranteed/Preferred Deals in Ad Manager.", + "readOnly": true }, "creativeSafeFrameCompatibility": { "description": "Output only. Specifies whether the creative is safeFrame compatible.", @@ -3547,15 +3550,18 @@ "The creatives need to be compatible with the safe frame option.", "The creatives can be incompatible with the safe frame option." ], + "readOnly": true, "type": "string" }, "dealId": { "description": "Output only. A unique deal ID for the deal (server-assigned).", + "readOnly": true, "type": "string" }, "dealServingMetadata": { "$ref": "DealServingMetadata", - "description": "Output only. Metadata about the serving status of this deal." + "description": "Output only. Metadata about the serving status of this deal.", + "readOnly": true }, "dealTerms": { "$ref": "DealTerms", @@ -3575,10 +3581,12 @@ }, "externalDealId": { "description": "Output only. The external deal ID assigned to this deal once the deal is finalized. This is the deal ID that shows up in serving/reporting etc.", + "readOnly": true, "type": "string" }, "isSetupComplete": { "description": "Output only. True, if the buyside inventory setup is complete for this deal.", + "readOnly": true, "type": "boolean" }, "programmaticCreativeSource": { @@ -3593,10 +3601,12 @@ "The advertiser provides the creatives.", "The publisher provides the creatives to be served." ], + "readOnly": true, "type": "string" }, "proposalId": { "description": "Output only. ID of the proposal that this deal is part of.", + "readOnly": true, "type": "string" }, "sellerContacts": { @@ -3604,6 +3614,7 @@ "items": { "$ref": "ContactInformation" }, + "readOnly": true, "type": "array" }, "syndicationProduct": { @@ -3626,7 +3637,8 @@ }, "targeting": { "$ref": "MarketplaceTargeting", - "description": "Output only. Specifies the subset of inventory targeted by the deal." + "description": "Output only. Specifies the subset of inventory targeted by the deal.", + "readOnly": true }, "targetingCriterion": { "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together.", @@ -3638,6 +3650,7 @@ "updateTime": { "description": "Output only. The time when the deal was last updated.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "webPropertyCode": { @@ -3690,7 +3703,8 @@ "properties": { "dealPauseStatus": { "$ref": "DealPauseStatus", - "description": "Output only. Tracks which parties (if any) have paused a deal." + "description": "Output only. Tracks which parties (if any) have paused a deal.", + "readOnly": true } }, "type": "object" @@ -3761,6 +3775,7 @@ "Publisher blocking rules will be applied.", "The Ad Exchange policy blocking rules will be applied." ], + "readOnly": true, "type": "string" }, "deliveryRateType": { @@ -3777,6 +3792,7 @@ "Impressions are served front-loaded.", "Impressions are served as fast as possible." ], + "readOnly": true, "type": "string" }, "frequencyCaps": { @@ -3784,6 +3800,7 @@ "items": { "$ref": "FrequencyCap" }, + "readOnly": true, "type": "array" } }, @@ -4531,16 +4548,20 @@ "SENSITIVE_CATEGORY", "PRODUCT_CATEGORY", "DISAPPROVAL_REASON", - "POLICY_TOPIC" + "POLICY_TOPIC", + "ATP_VENDOR", + "VENDOR_DOMAIN" ], "enumDescriptions": [ "A placeholder for an undefined status. This value will never be returned in responses.", "Indicates that the detail ID refers to a creative attribute; see [publisher-excludable-creative-attributes](https://developers.google.com/authorized-buyers/rtb/downloads/publisher-excludable-creative-attributes).", - "Indicates that the detail ID refers to a vendor; see [vendors](https://developers.google.com/authorized-buyers/rtb/downloads/vendors).", + "Indicates that the detail ID refers to a vendor; see [vendors](https://developers.google.com/authorized-buyers/rtb/downloads/vendors). This namespace is different from that of the `ATP_VENDOR` detail type.", "Indicates that the detail ID refers to a sensitive category; see [ad-sensitive-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-sensitive-categories).", "Indicates that the detail ID refers to a product category; see [ad-product-categories](https://developers.google.com/authorized-buyers/rtb/downloads/ad-product-categories).", "Indicates that the detail ID refers to a disapproval reason; see DisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/authorized-buyers/rtb/downloads/snippet-status-report-proto).", - "Indicates that the detail ID refers to a policy topic." + "Indicates that the detail ID refers to a policy topic.", + "Indicates that the detail ID refers to an ad technology provider (ATP); see [providers] (https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv). This namespace is different from the `VENDOR` detail type; see [ad technology providers](https://support.google.com/admanager/answer/9012903) for more information.", + "Indicates that the detail string refers the domain of an unknown vendor." ], "type": "string" }, @@ -4831,7 +4852,7 @@ "id": "Money", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { @@ -4979,6 +5000,7 @@ "createTime": { "description": "Output only. The timestamp for when this note was created.", "format": "google-datetime", + "readOnly": true, "type": "string" }, "creatorRole": { @@ -4993,6 +5015,7 @@ "Specifies the role as buyer.", "Specifies the role as seller." ], + "readOnly": true, "type": "string" }, "note": { @@ -5001,11 +5024,13 @@ }, "noteId": { "description": "Output only. The unique ID for the note.", + "readOnly": true, "type": "string" }, "proposalRevision": { "description": "Output only. The revision number of the proposal when the note is created.", "format": "int64", + "readOnly": true, "type": "string" } }, @@ -5232,7 +5257,8 @@ "properties": { "billedBuyer": { "$ref": "Buyer", - "description": "Output only. Reference to the buyer that will get billed for this proposal." + "description": "Output only. Reference to the buyer that will get billed for this proposal.", + "readOnly": true }, "buyer": { "$ref": "Buyer", @@ -5262,10 +5288,12 @@ }, "isRenegotiating": { "description": "Output only. True if the proposal is being renegotiated.", + "readOnly": true, "type": "boolean" }, "isSetupComplete": { "description": "Output only. True, if the buyside inventory setup is complete for this proposal.", + "readOnly": true, "type": "boolean" }, "lastUpdaterOrCommentorRole": { @@ -5280,6 +5308,7 @@ "Specifies the role as buyer.", "Specifies the role as seller." ], + "readOnly": true, "type": "string" }, "notes": { @@ -5287,6 +5316,7 @@ "items": { "$ref": "Note" }, + "readOnly": true, "type": "array" }, "originatorRole": { @@ -5301,19 +5331,23 @@ "Specifies the role as buyer.", "Specifies the role as seller." ], + "readOnly": true, "type": "string" }, "privateAuctionId": { "description": "Output only. Private auction ID if this proposal is a private auction proposal.", + "readOnly": true, "type": "string" }, "proposalId": { "description": "Output only. The unique ID of the proposal.", + "readOnly": true, "type": "string" }, "proposalRevision": { "description": "Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", "format": "int64", + "readOnly": true, "type": "string" }, "proposalState": { @@ -5334,6 +5368,7 @@ "The negotiations on the proposal were canceled and the proposal was never finalized.", "The proposal is finalized. During renegotiation, the proposal may not be in this state." ], + "readOnly": true, "type": "string" }, "seller": { @@ -5345,11 +5380,18 @@ "items": { "$ref": "ContactInformation" }, + "readOnly": true, "type": "array" }, + "termsAndConditions": { + "description": "Output only. The terms and conditions set by the publisher for this proposal.", + "readOnly": true, + "type": "string" + }, "updateTime": { "description": "Output only. The time when the proposal was last revised.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -5398,6 +5440,13 @@ "description": "URL to additional marketing and sales materials.", "type": "string" }, + "mobileApps": { + "description": "The list of apps represented in this publisher profile. Empty if this is a parent profile.", + "items": { + "$ref": "PublisherProfileMobileApplication" + }, + "type": "array" + }, "overview": { "description": "Overview of the publisher.", "type": "string" @@ -5432,6 +5481,55 @@ }, "type": "object" }, + "PublisherProfileMobileApplication": { + "description": "A mobile application that contains a external app ID, name, and app store.", + "id": "PublisherProfileMobileApplication", + "properties": { + "appStore": { + "description": "The app store the app belongs to.", + "enum": [ + "APP_STORE_TYPE_UNSPECIFIED", + "APPLE_ITUNES", + "GOOGLE_PLAY", + "ROKU", + "AMAZON_FIRETV", + "PLAYSTATION", + "XBOX", + "SAMSUNG_TV", + "AMAZON", + "OPPO", + "SAMSUNG", + "VIVO", + "XIAOMI" + ], + "enumDescriptions": [ + "A placeholder for an unknown app store.", + "Apple iTunes", + "Google Play", + "Roku", + "Amazon Fire TV", + "Playstation", + "Xbox", + "Samsung TV", + "Amazon Appstore", + "OPPO App Market", + "Samsung Galaxy Store", + "VIVO App Store", + "Xiaomi GetApps" + ], + "type": "string" + }, + "externalAppId": { + "description": "The external ID for the app from its app store.", + "type": "string" + }, + "name": { + "description": "The name of the app.", + "type": "string" + } + }, + "type": "object" + }, "RealtimeTimeRange": { "description": "An open-ended realtime time range specified by the start timestamp. For filter sets that specify a realtime time range RTB metrics continue to be aggregated throughout the lifetime of the filter set.", "id": "RealtimeTimeRange",
diff --git a/discovery/googleapis_beta/alertcenter__v1beta1.json b/discovery/googleapis_beta/alertcenter__v1beta1.json index c8f9737..a27fd69 100644 --- a/discovery/googleapis_beta/alertcenter__v1beta1.json +++ b/discovery/googleapis_beta/alertcenter__v1beta1.json
@@ -154,7 +154,7 @@ "type": "string" }, "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" } @@ -182,7 +182,7 @@ "type": "string" }, "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" } @@ -210,7 +210,7 @@ "type": "string" }, "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" } @@ -230,7 +230,7 @@ "parameterOrder": [], "parameters": { "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" }, @@ -309,7 +309,7 @@ "type": "string" }, "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" } @@ -340,7 +340,7 @@ "type": "string" }, "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" }, @@ -371,7 +371,7 @@ "parameterOrder": [], "parameters": { "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" } @@ -391,7 +391,7 @@ "parameterOrder": [], "parameters": { "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.", "location": "query", "type": "string" } @@ -410,7 +410,7 @@ } } }, - "revision": "20200925", + "revision": "20210130", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AccountWarning": { @@ -548,7 +548,7 @@ "type": "string" }, "type": { - "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types).", + "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](/admin-sdk/alertcenter/reference/alert-types).", "type": "string" }, "updateTime": { @@ -702,7 +702,7 @@ "type": "array" }, "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.", "type": "string" } }, @@ -741,7 +741,7 @@ "type": "array" }, "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.", "type": "string" } }, @@ -984,6 +984,10 @@ "description": "A detailed, freeform incident description.", "type": "string" }, + "header": { + "description": "A header to display above the incident message. Typcially used to attach a localized notice on the timeline for followup comms translations.", + "type": "string" + }, "title": { "description": "A one-line incident description.", "type": "string" @@ -1114,7 +1118,7 @@ "type": "object" }, "Notification": { - "description": "Settings for callback notifications. For more details see [G Suite Alert Notification](/admin-sdk/alertcenter/guides/notifications).", + "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](/admin-sdk/alertcenter/guides/notifications).", "id": "Notification", "properties": { "cloudPubsubTopic": { @@ -1259,13 +1263,17 @@ "ACTION_TYPE_UNSPECIFIED", "DRIVE_BLOCK_EXTERNAL_SHARING", "DRIVE_WARN_ON_EXTERNAL_SHARING", - "ALERT" + "ALERT", + "RULE_ACTIVATE", + "RULE_DEACTIVATE" ], "enumDescriptions": [ "Action type is unspecified.", "Block sharing a file externally.", "Show a warning message when sharing a file externally.", - "Send alert." + "Send alert.", + "Activate Rule Action", + "Deactivate Rule Action" ], "type": "string" }, @@ -1290,13 +1298,17 @@ "ACTION_TYPE_UNSPECIFIED", "DRIVE_BLOCK_EXTERNAL_SHARING", "DRIVE_WARN_ON_EXTERNAL_SHARING", - "ALERT" + "ALERT", + "RULE_ACTIVATE", + "RULE_DEACTIVATE" ], "enumDescriptions": [ "Action type is unspecified.", "Block sharing a file externally.", "Show a warning message when sharing a file externally.", - "Send alert." + "Send alert.", + "Activate Rule Action", + "Deactivate Rule Action" ], "type": "string" }, @@ -1427,7 +1439,7 @@ "id": "UndeleteAlertRequest", "properties": { "customerId": { - "description": "Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", + "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.", "type": "string" } }, @@ -1465,7 +1477,7 @@ } }, "servicePath": "", - "title": "G Suite Alert Center API", + "title": "Google Workspace Alert Center API", "version": "v1beta1", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis_beta/analyticsadmin__v1alpha.json b/discovery/googleapis_beta/analyticsadmin__v1alpha.json new file mode 100644 index 0000000..750685b --- /dev/null +++ b/discovery/googleapis_beta/analyticsadmin__v1alpha.json
@@ -0,0 +1,2710 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/analytics.edit": { + "description": "Edit Google Analytics management entities" + }, + "https://www.googleapis.com/auth/analytics.manage.users": { + "description": "Manage Google Analytics Account users by email address" + }, + "https://www.googleapis.com/auth/analytics.manage.users.readonly": { + "description": "View Google Analytics user permissions" + }, + "https://www.googleapis.com/auth/analytics.readonly": { + "description": "See and download your Google Analytics data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://analyticsadmin.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Google Analytics Admin", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "analyticsadmin:v1alpha", + "kind": "discovery#restDescription", + "name": "analyticsadmin", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "accountSummaries": { + "methods": { + "list": { + "description": "Returns summaries of all accounts accessible by the caller.", + "httpMethod": "GET", + "id": "analyticsadmin.accountSummaries.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/accountSummaries", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListAccountSummariesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + } + } + }, + "accounts": { + "methods": { + "delete": { + "description": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", + "httpMethod": "DELETE", + "id": "analyticsadmin.accounts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Account to soft-delete. Format: accounts/{account} Example: \"accounts/100\"", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single Account.", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the account to lookup. Format: accounts/{account} Example: \"accounts/100\"", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "getDataSharingSettings": { + "description": "Get data sharing settings on an account. Data sharing settings are singletons.", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.getDataSharingSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", + "location": "path", + "pattern": "^accounts/[^/]+/dataSharingSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaDataSharingSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found.", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "showDeleted": { + "description": "Whether to include soft-deleted (ie: \"trashed\") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/accounts", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates an account.", + "httpMethod": "PATCH", + "id": "analyticsadmin.accounts.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaAccount" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAccount" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "provisionAccountTicket": { + "description": "Requests a ticket for creating an account.", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.provisionAccountTicket", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha/accounts:provisionAccountTicket", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + }, + "resources": { + "userLinks": { + "methods": { + "audit": { + "description": "Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.userLinks.audit", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: accounts/1234", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:audit", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "batchCreate": { + "description": "Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.userLinks.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchCreate", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "batchDelete": { + "description": "Deletes information about multiple users' links to an account or property.", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.userLinks.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchDelete", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "batchGet": { + "description": "Gets information about multiple users' links to an account or property.", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.userLinks.batchGet", + "parameterOrder": [ + "parent" + ], + "parameters": { + "names": { + "description": "Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchGet", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "batchUpdate": { + "description": "Updates information about multiple users' links to an account or property.", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.userLinks.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchUpdate", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "create": { + "description": "Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.", + "httpMethod": "POST", + "id": "analyticsadmin.accounts.userLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notifyNewUser": { + "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. Example format: accounts/1234", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "delete": { + "description": "Deletes a user link on an account or property.", + "httpMethod": "DELETE", + "id": "analyticsadmin.accounts.userLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: accounts/1234/userLinks/5678", + "location": "path", + "pattern": "^accounts/[^/]+/userLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "get": { + "description": "Gets information about a user's link to an account or property.", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.userLinks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: accounts/1234/userLinks/5678", + "location": "path", + "pattern": "^accounts/[^/]+/userLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "list": { + "description": "Lists all user links on an account or property.", + "httpMethod": "GET", + "id": "analyticsadmin.accounts.userLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: accounts/1234", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "patch": { + "description": "Updates a user link on an account or property.", + "httpMethod": "PATCH", + "id": "analyticsadmin.accounts.userLinks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Example format: properties/1234/userLinks/5678", + "location": "path", + "pattern": "^accounts/[^/]+/userLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + } + } + } + } + }, + "properties": { + "methods": { + "create": { + "description": "Creates an \"GA4\" property with the specified location and attributes.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha/properties", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single \"GA4\" Property.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the property to lookup. Format: properties/{property_id} Example: \"properties/1000\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child Properties under the specified parent Account. Only \"GA4\" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "showDeleted": { + "description": "Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/properties", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListPropertiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a property.", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + }, + "resources": { + "androidAppDataStreams": { + "methods": { + "create": { + "description": "Creates an Android app stream with the specified location and attributes. Note that an Android app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).", + "httpMethod": "POST", + "id": "analyticsadmin.properties.androidAppDataStreams.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this android app data stream will be created. Format: properties/123", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/androidAppDataStreams", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes an android app stream on a property.", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.androidAppDataStreams.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/123/androidAppDataStreams/456\"", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single AndroidAppDataStream", + "httpMethod": "GET", + "id": "analyticsadmin.properties.androidAppDataStreams.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/123/androidAppDataStreams/456\"", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child android app streams under the specified parent property. Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.androidAppDataStreams.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAndroidAppDataStreams` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: \"properties/123\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/androidAppDataStreams", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates an android app stream on a property.", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.androidAppDataStreams.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/1000/androidAppDataStreams/2000\"", + "location": "path", + "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, + "firebaseLinks": { + "methods": { + "create": { + "description": "Creates a FirebaseLink. Properties can have at most one FirebaseLink.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.firebaseLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Format: properties/{property_id} Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/firebaseLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a FirebaseLink on a property", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.firebaseLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "list": { + "description": "Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.firebaseLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: properties/{property_id} Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/firebaseLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a FirebaseLink on a property", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.firebaseLinks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Example format: properties/1234/firebaseLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, + "googleAdsLinks": { + "methods": { + "create": { + "description": "Creates a GoogleAdsLink.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.googleAdsLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/googleAdsLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a GoogleAdsLink on a property", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.googleAdsLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: properties/1234/googleAdsLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "list": { + "description": "Lists GoogleAdsLinks on a property.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.googleAdsLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/googleAdsLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a GoogleAdsLink on a property", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.googleAdsLinks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", + "location": "path", + "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, + "iosAppDataStreams": { + "methods": { + "create": { + "description": "Creates an iOS app stream with the specified location and attributes. Note that an iOS app stream must be linked to a Firebase app to receive traffic. To create a working app stream, make sure your property is linked to a Firebase project. Then, use the Firebase API to create a Firebase app, which will also create an appropriate data stream in Analytics (may take up to 24 hours).", + "httpMethod": "POST", + "id": "analyticsadmin.properties.iosAppDataStreams.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this ios app data stream will be created. Format: properties/123", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/iosAppDataStreams", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes an iOS app stream on a property.", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.iosAppDataStreams.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/123/iosAppDataStreams/456\"", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single IosAppDataStream", + "httpMethod": "GET", + "id": "analyticsadmin.properties.iosAppDataStreams.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/123/iosAppDataStreams/456\"", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.iosAppDataStreams.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListIosAppDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIosAppDataStreams` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: \"properties/123\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/iosAppDataStreams", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates an iOS app stream on a property.", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.iosAppDataStreams.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/1000/iosAppDataStreams/2000\"", + "location": "path", + "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + }, + "userLinks": { + "methods": { + "audit": { + "description": "Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.userLinks.audit", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: accounts/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:audit", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "batchCreate": { + "description": "Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.userLinks.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchCreate", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "batchDelete": { + "description": "Deletes information about multiple users' links to an account or property.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.userLinks.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchDelete", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "batchGet": { + "description": "Gets information about multiple users' links to an account or property.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.userLinks.batchGet", + "parameterOrder": [ + "parent" + ], + "parameters": { + "names": { + "description": "Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchGet", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "batchUpdate": { + "description": "Updates information about multiple users' links to an account or property.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.userLinks.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks:batchUpdate", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "create": { + "description": "Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.userLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notifyNewUser": { + "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", + "location": "query", + "type": "boolean" + }, + "parent": { + "description": "Required. Example format: accounts/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "delete": { + "description": "Deletes a user link on an account or property.", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.userLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: accounts/1234/userLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/userLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + }, + "get": { + "description": "Gets information about a user's link to an account or property.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.userLinks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: accounts/1234/userLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/userLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "list": { + "description": "Lists all user links on an account or property.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.userLinks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: accounts/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userLinks", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListUserLinksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users", + "https://www.googleapis.com/auth/analytics.manage.users.readonly" + ] + }, + "patch": { + "description": "Updates a user link on an account or property.", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.userLinks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Example format: properties/1234/userLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/userLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.manage.users" + ] + } + } + }, + "webDataStreams": { + "methods": { + "create": { + "description": "Creates a web stream with the specified location and attributes.", + "httpMethod": "POST", + "id": "analyticsadmin.properties.webDataStreams.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this web data stream will be created. Format: properties/123", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/webDataStreams", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a web stream on a property.", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.webDataStreams.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/123/webDataStreams/456\"", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single WebDataStream", + "httpMethod": "GET", + "id": "analyticsadmin.properties.webDataStreams.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/123/webDataStreams/456\"", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "getEnhancedMeasurementSettings": { + "description": "Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.webDataStreams.getEnhancedMeasurementSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: \"properties/1000/webDataStreams/2000/enhancedMeasurementSettings\"", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+/enhancedMeasurementSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "getGlobalSiteTag": { + "description": "Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.webDataStreams.getGlobalSiteTag", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/webDataStreams/{stream_id}/globalSiteTag Example: \"properties/123/webDataStreams/456/globalSiteTag\"", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+/globalSiteTag$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaGlobalSiteTag" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.", + "httpMethod": "GET", + "id": "analyticsadmin.properties.webDataStreams.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListWebDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebDataStreams` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: \"properties/123\"", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/webDataStreams", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates a web stream on a property.", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.webDataStreams.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/1000/webDataStreams/2000\"", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "updateEnhancedMeasurementSettings": { + "description": "Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.webDataStreams.updateEnhancedMeasurementSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: \"properties/1000/webDataStreams/2000/enhancedMeasurementSettings\"", + "location": "path", + "pattern": "^properties/[^/]+/webDataStreams/[^/]+/enhancedMeasurementSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + } + } + } + } + } + }, + "revision": "20210203", + "rootUrl": "https://analyticsadmin.googleapis.com/", + "schemas": { + "GoogleAnalyticsAdminV1alphaAccount": { + "description": "A resource message representing a Google Analytics account.", + "id": "GoogleAnalyticsAdminV1alphaAccount", + "properties": { + "createTime": { + "description": "Output only. Time when this account was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleted": { + "description": "Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.", + "readOnly": true, + "type": "boolean" + }, + "displayName": { + "description": "Required. Human-readable display name for this account.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", + "readOnly": true, + "type": "string" + }, + "regionCode": { + "description": "Country of business. Must be a Unicode CLDR region code.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when account payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaAccountSummary": { + "description": "A virtual resource representing an overview of an account and all its child GA4 properties.", + "id": "GoogleAnalyticsAdminV1alphaAccountSummary", + "properties": { + "account": { + "description": "Resource name of account referred to by this account summary Format: accounts/{account_id} Example: \"accounts/1000\"", + "type": "string" + }, + "displayName": { + "description": "Display name for the account referred to in this account summary.", + "type": "string" + }, + "name": { + "description": "Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"", + "type": "string" + }, + "propertySummaries": { + "description": "List of summaries for child accounts of this account.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaPropertySummary" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaAndroidAppDataStream": { + "description": "A resource message representing a Google Analytics Android app stream.", + "id": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream", + "properties": { + "createTime": { + "description": "Output only. Time when this stream was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.", + "type": "string" + }, + "firebaseAppId": { + "description": "Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/1000/androidAppDataStreams/2000\"", + "readOnly": true, + "type": "string" + }, + "packageName": { + "description": "Immutable. The package name for the app being measured. Example: \"com.example.myandroidapp\"", + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when stream payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaAuditUserLink": { + "description": "Read-only resource used to summarize a principal's effective roles.", + "id": "GoogleAnalyticsAdminV1alphaAuditUserLink", + "properties": { + "directRoles": { + "description": "Roles directly assigned to this user for this entity. Format: predefinedRoles/read Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.", + "items": { + "type": "string" + }, + "type": "array" + }, + "effectiveRoles": { + "description": "Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/read", + "items": { + "type": "string" + }, + "type": "array" + }, + "emailAddress": { + "description": "Email address of the linked user", + "type": "string" + }, + "name": { + "description": "Example format: properties/1234/userLinks/5678", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest": { + "description": "Request message for AuditUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest", + "properties": { + "pageSize": { + "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `AuditUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `AuditUserLinks` must match the call that provided the page token.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse": { + "description": "Response message for AuditUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse", + "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" + }, + "userLinks": { + "description": "List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLink" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest": { + "description": "Request message for BatchCreateUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest", + "properties": { + "notifyNewUsers": { + "description": "Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.", + "type": "boolean" + }, + "requests": { + "description": "Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse": { + "description": "Response message for BatchCreateUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse", + "properties": { + "userLinks": { + "description": "The user links created.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest": { + "description": "Request message for BatchDeleteUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest", + "properties": { + "requests": { + "description": "Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse": { + "description": "Response message for BatchGetUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse", + "properties": { + "userLinks": { + "description": "The requested user links.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest": { + "description": "Request message for BatchUpdateUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest", + "properties": { + "requests": { + "description": "Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse": { + "description": "Response message for BatchUpdateUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse", + "properties": { + "userLinks": { + "description": "The user links updated.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest": { + "description": "Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the \"primary\" email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the \"primary\" email address. As a result, the input and output email address for this request may differ.", + "id": "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest", + "properties": { + "notifyNewUser": { + "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", + "type": "boolean" + }, + "parent": { + "description": "Required. Example format: accounts/1234", + "type": "string" + }, + "userLink": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink", + "description": "Required. The user link to create." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaDataSharingSettings": { + "description": "A resource message representing data sharing settings of a Google Analytics account.", + "id": "GoogleAnalyticsAdminV1alphaDataSharingSettings", + "properties": { + "name": { + "description": "Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", + "readOnly": true, + "type": "string" + }, + "sharingWithGoogleAnySalesEnabled": { + "description": "Allows any of Google sales to access the data in order to suggest configuration changes to improve results.", + "type": "boolean" + }, + "sharingWithGoogleAssignedSalesEnabled": { + "description": "Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.", + "type": "boolean" + }, + "sharingWithGoogleProductsEnabled": { + "description": "Allows Google to use the data to improve other Google products or services.", + "type": "boolean" + }, + "sharingWithGoogleSupportEnabled": { + "description": "Allows Google support to access the data in order to help troubleshoot issues.", + "type": "boolean" + }, + "sharingWithOthersEnabled": { + "description": "Allows Google to share the data anonymously in aggregate form with others.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest": { + "description": "Request message for DeleteUserLink RPC.", + "id": "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest", + "properties": { + "name": { + "description": "Required. Example format: accounts/1234/userLinks/5678", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings": { + "description": "Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.", + "id": "GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings", + "properties": { + "fileDownloadsEnabled": { + "description": "If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.", + "type": "boolean" + }, + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: \"properties/1000/webDataStreams/2000/enhancedMeasurementSettings\"", + "readOnly": true, + "type": "string" + }, + "outboundClicksEnabled": { + "description": "If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.", + "type": "boolean" + }, + "pageChangesEnabled": { + "description": "If enabled, capture a page view event each time the website changes the browser history state.", + "type": "boolean" + }, + "pageLoadsEnabled": { + "description": "Output only. If enabled, capture a page view event each time a page loads.", + "readOnly": true, + "type": "boolean" + }, + "pageViewsEnabled": { + "description": "Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.", + "readOnly": true, + "type": "boolean" + }, + "scrollsEnabled": { + "description": "If enabled, capture scroll events each time a visitor gets to the bottom of a page.", + "type": "boolean" + }, + "searchQueryParameter": { + "description": "Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.", + "type": "string" + }, + "siteSearchEnabled": { + "description": "If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).", + "type": "boolean" + }, + "streamEnabled": { + "description": "Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.", + "type": "boolean" + }, + "uriQueryParameter": { + "description": "Additional URL query parameters. Max length is 1024 characters.", + "type": "string" + }, + "videoEngagementEnabled": { + "description": "If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaFirebaseLink": { + "description": "A link between an GA4 property and a Firebase project.", + "id": "GoogleAnalyticsAdminV1alphaFirebaseLink", + "properties": { + "createTime": { + "description": "Output only. Time when this FirebaseLink was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "maximumUserAccess": { + "description": "Maximum user access to the GA4 property allowed to admins of the linked Firebase project.", + "enum": [ + "MAXIMUM_USER_ACCESS_UNSPECIFIED", + "NO_ACCESS", + "READ_AND_ANALYZE", + "EDITOR_WITHOUT_LINK_MANAGEMENT", + "EDITOR_INCLUDING_LINK_MANAGEMENT" + ], + "enumDescriptions": [ + "Unspecified maximum user access.", + "Firebase users have no access to the Analytics property.", + "Firebase users have Read & Analyze access to the Analytics property.", + "Firebase users have edit access to the Analytics property, but may not manage the Firebase link.", + "Firebase users have edit access to the Analytics property and may manage the Firebase link." + ], + "type": "string" + }, + "name": { + "description": "Output only. Example format: properties/1234/firebaseLinks/5678", + "readOnly": true, + "type": "string" + }, + "project": { + "description": "Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaGlobalSiteTag": { + "description": "Read-only resource with the tag for sending data from a website to a WebDataStream.", + "id": "GoogleAnalyticsAdminV1alphaGlobalSiteTag", + "properties": { + "name": { + "description": "Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/globalSiteTag", + "readOnly": true, + "type": "string" + }, + "snippet": { + "description": "Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaGoogleAdsLink": { + "description": "A link between an GA4 property and a Google Ads account.", + "id": "GoogleAnalyticsAdminV1alphaGoogleAdsLink", + "properties": { + "adsPersonalizationEnabled": { + "description": "Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update it will be defaulted to true.", + "type": "boolean" + }, + "canManageClients": { + "description": "Output only. If true, this link is for a Google Ads manager account.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. Time when this link was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customerId": { + "description": "Immutable. Google Ads customer ID.", + "type": "string" + }, + "emailAddress": { + "description": "Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when this link was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaIosAppDataStream": { + "description": "A resource message representing a Google Analytics IOS app stream.", + "id": "GoogleAnalyticsAdminV1alphaIosAppDataStream", + "properties": { + "bundleId": { + "description": "Required. Immutable. The Apple App Store Bundle ID for the app Example: \"com.example.myiosapp\"", + "type": "string" + }, + "createTime": { + "description": "Output only. Time when this stream was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.", + "type": "string" + }, + "firebaseAppId": { + "description": "Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/1000/iosAppDataStreams/2000\"", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when stream payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListAccountSummariesResponse": { + "description": "Response message for ListAccountSummaries RPC.", + "id": "GoogleAnalyticsAdminV1alphaListAccountSummariesResponse", + "properties": { + "accountSummaries": { + "description": "Account summaries of all accounts the caller has access to.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaAccountSummary" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListAccountsResponse": { + "description": "Request message for ListAccounts RPC.", + "id": "GoogleAnalyticsAdminV1alphaListAccountsResponse", + "properties": { + "accounts": { + "description": "Results that were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaAccount" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse": { + "description": "Request message for ListAndroidDataStreams RPC.", + "id": "GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse", + "properties": { + "androidAppDataStreams": { + "description": "Results that matched the filter criteria and were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse": { + "description": "Response message for ListFirebaseLinks RPC", + "id": "GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse", + "properties": { + "firebaseLinks": { + "description": "List of FirebaseLinks. This will have at most one value.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" + }, + "type": "array" + }, + "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. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse": { + "description": "Response message for ListGoogleAdsLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse", + "properties": { + "googleAdsLinks": { + "description": "List of GoogleAdsLinks.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse": { + "description": "Request message for ListIosAppDataStreams RPC.", + "id": "GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse", + "properties": { + "iosAppDataStreams": { + "description": "Results that matched the filter criteria and were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListPropertiesResponse": { + "description": "Response message for ListProperties RPC.", + "id": "GoogleAnalyticsAdminV1alphaListPropertiesResponse", + "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" + }, + "properties": { + "description": "Results that matched the filter criteria and were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListUserLinksResponse": { + "description": "Response message for ListUserLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaListUserLinksResponse", + "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" + }, + "userLinks": { + "description": "List of UserLinks. These will be ordered stably, but in an arbitrary order.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse": { + "description": "Request message for ListWebDataStreams RPC.", + "id": "GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse", + "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" + }, + "webDataStreams": { + "description": "Results that matched the filter criteria and were accessible to the caller.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaProperty": { + "description": "A resource message representing a Google Analytics GA4 property.", + "id": "GoogleAnalyticsAdminV1alphaProperty", + "properties": { + "createTime": { + "description": "Output only. Time when the entity was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "currencyCode": { + "description": "The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: \"USD\", \"EUR\", \"JPY\"", + "type": "string" + }, + "deleted": { + "description": "Output only. Indicates whether this Property is soft-deleted or not. Deleted properties are excluded from List results unless specifically requested.", + "readOnly": true, + "type": "boolean" + }, + "displayName": { + "description": "Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.", + "type": "string" + }, + "industryCategory": { + "description": "Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK", + "enum": [ + "INDUSTRY_CATEGORY_UNSPECIFIED", + "AUTOMOTIVE", + "BUSINESS_AND_INDUSTRIAL_MARKETS", + "FINANCE", + "HEALTHCARE", + "TECHNOLOGY", + "TRAVEL", + "OTHER", + "ARTS_AND_ENTERTAINMENT", + "BEAUTY_AND_FITNESS", + "BOOKS_AND_LITERATURE", + "FOOD_AND_DRINK", + "GAMES", + "HOBBIES_AND_LEISURE", + "HOME_AND_GARDEN", + "INTERNET_AND_TELECOM", + "LAW_AND_GOVERNMENT", + "NEWS", + "ONLINE_COMMUNITIES", + "PEOPLE_AND_SOCIETY", + "PETS_AND_ANIMALS", + "REAL_ESTATE", + "REFERENCE", + "SCIENCE", + "SPORTS", + "JOBS_AND_EDUCATION", + "SHOPPING" + ], + "enumDescriptions": [ + "Industry category unspecified", + "Automotive", + "Business and industrial markets", + "Finance", + "Healthcare", + "Technology", + "Travel", + "Other", + "Arts and entertainment", + "Beauty and fitness", + "Books and literature", + "Food and drink", + "Games", + "Hobbies and leisure", + "Home and garden", + "Internet and telecom", + "Law and government", + "News", + "Online communities", + "People and society", + "Pets and animals", + "Real estate", + "Reference", + "Science", + "Sports", + "Jobs and education", + "Shopping" + ], + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", + "readOnly": true, + "type": "string" + }, + "parent": { + "description": "Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: \"accounts/100\"", + "type": "string" + }, + "timeZone": { + "description": "Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: \"America/Los_Angeles\"", + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when entity payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaPropertySummary": { + "description": "A virtual resource representing metadata for an GA4 property.", + "id": "GoogleAnalyticsAdminV1alphaPropertySummary", + "properties": { + "displayName": { + "description": "Display name for the property referred to in this account summary.", + "type": "string" + }, + "property": { + "description": "Resource name of property referred to by this property summary Format: properties/{property_id} Example: \"properties/1000\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest": { + "description": "Request message for ProvisionAccountTicket RPC.", + "id": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest", + "properties": { + "account": { + "$ref": "GoogleAnalyticsAdminV1alphaAccount", + "description": "The account to create." + }, + "redirectUri": { + "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse": { + "description": "Response message for ProvisionAccountTicket RPC.", + "id": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse", + "properties": { + "accountTicketId": { + "description": "The param to be passed in the ToS link.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest": { + "description": "Request message for UpdateUserLink RPC.", + "id": "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest", + "properties": { + "userLink": { + "$ref": "GoogleAnalyticsAdminV1alphaUserLink", + "description": "Required. The user link to update." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaUserLink": { + "description": "A resource message representing a user's permissions on an Account or Property resource.", + "id": "GoogleAnalyticsAdminV1alphaUserLink", + "properties": { + "directRoles": { + "description": "Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit predefinedRoles/manage-users Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.", + "items": { + "type": "string" + }, + "type": "array" + }, + "emailAddress": { + "description": "Email address of the user to link", + "type": "string" + }, + "name": { + "description": "Example format: properties/1234/userLinks/5678", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaWebDataStream": { + "description": "A resource message representing a Google Analytics web stream.", + "id": "GoogleAnalyticsAdminV1alphaWebDataStream", + "properties": { + "createTime": { + "description": "Output only. Time when this stream was originally created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultUri": { + "description": "Immutable. Domain name of the web app being measured, or empty. Example: \"http://www.google.com\", \"https://www.google.com\"", + "type": "string" + }, + "displayName": { + "description": "Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.", + "type": "string" + }, + "firebaseAppId": { + "description": "Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.", + "readOnly": true, + "type": "string" + }, + "measurementId": { + "description": "Output only. Analytics \"Measurement ID\", without the \"G-\" prefix. Example: \"G-1A2BCD345E\" would just be \"1A2BCD345E\"", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/1000/webDataStreams/2000\"", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time when stream payload fields were last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "Google Analytics Admin API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/analyticsdata__v1alpha.json b/discovery/googleapis_beta/analyticsdata__v1alpha.json new file mode 100644 index 0000000..2bbce20 --- /dev/null +++ b/discovery/googleapis_beta/analyticsdata__v1alpha.json
@@ -0,0 +1,1543 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/analytics": { + "description": "View and manage your Google Analytics data" + }, + "https://www.googleapis.com/auth/analytics.readonly": { + "description": "See and download your Google Analytics data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://analyticsdata.googleapis.com/", + "batchPath": "batch", + "canonicalName": "AnalyticsData", + "description": "Accesses report data in Google Analytics.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/v1/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "analyticsdata:v1alpha", + "kind": "discovery#restDescription", + "name": "analyticsdata", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "properties": { + "methods": { + "getMetadata": { + "description": "Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`.", + "httpMethod": "GET", + "id": "analyticsdata.properties.getMetadata", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics GA4 Property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.", + "location": "path", + "pattern": "^properties/[^/]+/metadata$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Metadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "runRealtimeReport": { + "description": "The Google Analytics Realtime API returns a customized report of realtime event data for your property. These reports show events and usage from the last 30 minutes.", + "httpMethod": "POST", + "id": "analyticsdata.properties.runRealtimeReport", + "parameterOrder": [ + "property" + ], + "parameters": { + "property": { + "description": "A Google Analytics GA4 property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+property}:runRealtimeReport", + "request": { + "$ref": "RunRealtimeReportRequest" + }, + "response": { + "$ref": "RunRealtimeReportResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics", + "https://www.googleapis.com/auth/analytics.readonly" + ] + } + } + }, + "v1alpha": { + "methods": { + "batchRunPivotReports": { + "description": "Returns multiple pivot reports in a batch. All reports must be for the same Entity.", + "httpMethod": "POST", + "id": "analyticsdata.batchRunPivotReports", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha:batchRunPivotReports", + "request": { + "$ref": "BatchRunPivotReportsRequest" + }, + "response": { + "$ref": "BatchRunPivotReportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "batchRunReports": { + "description": "Returns multiple reports in a batch. All reports must be for the same Entity.", + "httpMethod": "POST", + "id": "analyticsdata.batchRunReports", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha:batchRunReports", + "request": { + "$ref": "BatchRunReportsRequest" + }, + "response": { + "$ref": "BatchRunReportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "runPivotReport": { + "description": "Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data.", + "httpMethod": "POST", + "id": "analyticsdata.runPivotReport", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha:runPivotReport", + "request": { + "$ref": "RunPivotReportRequest" + }, + "response": { + "$ref": "RunPivotReportResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "runReport": { + "description": "Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name.", + "httpMethod": "POST", + "id": "analyticsdata.runReport", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha:runReport", + "request": { + "$ref": "RunReportRequest" + }, + "response": { + "$ref": "RunReportResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics", + "https://www.googleapis.com/auth/analytics.readonly" + ] + } + } + } + }, + "revision": "20210202", + "rootUrl": "https://analyticsdata.googleapis.com/", + "schemas": { + "BatchRunPivotReportsRequest": { + "description": "The batch request containing multiple pivot report requests.", + "id": "BatchRunPivotReportsRequest", + "properties": { + "entity": { + "$ref": "Entity", + "description": "A property whose events are tracked. This entity must be specified for the batch. The entity within RunPivotReportRequest may either be unspecified or consistent with this entity." + }, + "requests": { + "description": "Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests.", + "items": { + "$ref": "RunPivotReportRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchRunPivotReportsResponse": { + "description": "The batch response containing multiple pivot reports.", + "id": "BatchRunPivotReportsResponse", + "properties": { + "pivotReports": { + "description": "Individual responses. Each response has a separate pivot report request.", + "items": { + "$ref": "RunPivotReportResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchRunReportsRequest": { + "description": "The batch request containing multiple report requests.", + "id": "BatchRunReportsRequest", + "properties": { + "entity": { + "$ref": "Entity", + "description": "A property whose events are tracked. This entity must be specified for the batch. The entity within RunReportRequest may either be unspecified or consistent with this entity." + }, + "requests": { + "description": "Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests.", + "items": { + "$ref": "RunReportRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchRunReportsResponse": { + "description": "The batch response containing multiple reports.", + "id": "BatchRunReportsResponse", + "properties": { + "reports": { + "description": "Individual responses. Each response has a separate report request.", + "items": { + "$ref": "RunReportResponse" + }, + "type": "array" + } + }, + "type": "object" + }, + "BetweenFilter": { + "description": "To express that the result needs to be between two numbers (inclusive).", + "id": "BetweenFilter", + "properties": { + "fromValue": { + "$ref": "NumericValue", + "description": "Begins with this number." + }, + "toValue": { + "$ref": "NumericValue", + "description": "Ends with this number." + } + }, + "type": "object" + }, + "CaseExpression": { + "description": "Used to convert a dimension value to a single case.", + "id": "CaseExpression", + "properties": { + "dimensionName": { + "description": "Name of a dimension. The name must refer back to a name in dimensions field of the request.", + "type": "string" + } + }, + "type": "object" + }, + "Cohort": { + "description": "Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort.", + "id": "Cohort", + "properties": { + "dateRange": { + "$ref": "DateRange", + "description": "The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`. This `dateRange` does not specify the full date range of event data that is present in a cohort report. In a cohort report, this `dateRange` is extended by the granularity and offset present in the `cohortsRange`; event data for the extended reporting date range is present in a cohort report. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. This `dateRange` should generally be aligned with the cohort's granularity. If `CohortsRange` uses daily granularity, this `dateRange` can be a single day. If `CohortsRange` uses weekly granularity, this `dateRange` can be aligned to a week boundary, starting at Sunday and ending Saturday. If `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to a month, starting at the first and ending on the last day of the month." + }, + "dimension": { + "description": "Dimension used by the cohort. Required and only supports `firstSessionDate`.", + "type": "string" + }, + "name": { + "description": "Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc.", + "type": "string" + } + }, + "type": "object" + }, + "CohortReportSettings": { + "description": "Optional settings of a cohort report.", + "id": "CohortReportSettings", + "properties": { + "accumulate": { + "description": "If true, accumulates the result from first touch day to the end day. Not supported in `RunReportRequest`.", + "type": "boolean" + } + }, + "type": "object" + }, + "CohortSpec": { + "description": "The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object. For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report.", + "id": "CohortSpec", + "properties": { + "cohortReportSettings": { + "$ref": "CohortReportSettings", + "description": "Optional settings for a cohort report." + }, + "cohorts": { + "description": "Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name.", + "items": { + "$ref": "Cohort" + }, + "type": "array" + }, + "cohortsRange": { + "$ref": "CohortsRange", + "description": "Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over." + } + }, + "type": "object" + }, + "CohortsRange": { + "description": "Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over.", + "id": "CohortsRange", + "properties": { + "endOffset": { + "description": "Required. `endOffset` specifies the end date of the extended reporting date range for a cohort report. `endOffset` can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If `granularity` is `DAILY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 30` days.", + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report.", + "enum": [ + "GRANULARITY_UNSPECIFIED", + "DAILY", + "WEEKLY", + "MONTHLY" + ], + "enumDescriptions": [ + "Should never be specified.", + "Daily granularity. Commonly used if the cohort's `dateRange` is a single day and the request contains `cohortNthDay`.", + "Weekly granularity. Commonly used if the cohort's `dateRange` is a week in duration (starting on Sunday and ending on Saturday) and the request contains `cohortNthWeek`.", + "Monthly granularity. Commonly used if the cohort's `dateRange` is a month in duration and the request contains `cohortNthMonth`." + ], + "type": "string" + }, + "startOffset": { + "description": "`startOffset` specifies the start date of the extended reporting date range for a cohort report. `startOffset` is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If `granularity` is `DAILY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is `MONTHLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ConcatenateExpression": { + "description": "Used to combine dimension values to a single dimension.", + "id": "ConcatenateExpression", + "properties": { + "delimiter": { + "description": "The delimiter placed between dimension names. Delimiters are often single characters such as \"|\" or \",\" but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = \"US,FR\", dimension 2 value = \"JP\", and delimiter = \",\", then the response will contain \"US,FR,JP\".", + "type": "string" + }, + "dimensionNames": { + "description": "Names of dimensions. The names must refer back to names in the dimensions field of the request.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DateRange": { + "description": "A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.", + "id": "DateRange", + "properties": { + "endDate": { + "description": "The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.", + "type": "string" + }, + "name": { + "description": "Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.", + "type": "string" + }, + "startDate": { + "description": "The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone.", + "type": "string" + } + }, + "type": "object" + }, + "Dimension": { + "description": "Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, city could be \"Paris\" or \"New York\". Requests are allowed up to 8 dimensions.", + "id": "Dimension", + "properties": { + "dimensionExpression": { + "$ref": "DimensionExpression", + "description": "One dimension can be the result of an expression of multiple dimensions. For example, dimension \"country, city\": concatenate(country, \", \", city)." + }, + "name": { + "description": "The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. If `dimensionExpression` is specified, `name` can be any string that you would like. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`.", + "type": "string" + } + }, + "type": "object" + }, + "DimensionExpression": { + "description": "Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).", + "id": "DimensionExpression", + "properties": { + "concatenate": { + "$ref": "ConcatenateExpression", + "description": "Used to combine dimension values to a single dimension. For example, dimension \"country, city\": concatenate(country, \", \", city)." + }, + "lowerCase": { + "$ref": "CaseExpression", + "description": "Used to convert a dimension value to lower case." + }, + "upperCase": { + "$ref": "CaseExpression", + "description": "Used to convert a dimension value to upper case." + } + }, + "type": "object" + }, + "DimensionHeader": { + "description": "Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.", + "id": "DimensionHeader", + "properties": { + "name": { + "description": "The dimension's name.", + "type": "string" + } + }, + "type": "object" + }, + "DimensionMetadata": { + "description": "Explains a dimension.", + "id": "DimensionMetadata", + "properties": { + "apiName": { + "description": "This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`.", + "type": "string" + }, + "customDefinition": { + "description": "True if the dimension is a custom dimension for this property.", + "type": "boolean" + }, + "deprecatedApiNames": { + "description": "Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Description of how this dimension is used and calculated.", + "type": "string" + }, + "uiName": { + "description": "This dimension's name within the Google Analytics user interface. For example, `Event name`.", + "type": "string" + } + }, + "type": "object" + }, + "DimensionOrderBy": { + "description": "Sorts by dimension values.", + "id": "DimensionOrderBy", + "properties": { + "dimensionName": { + "description": "A dimension name in the request to order by.", + "type": "string" + }, + "orderType": { + "description": "Controls the rule for dimension value ordering.", + "enum": [ + "ORDER_TYPE_UNSPECIFIED", + "ALPHANUMERIC", + "CASE_INSENSITIVE_ALPHANUMERIC", + "NUMERIC" + ], + "enumDescriptions": [ + "Unspecified.", + "Alphanumeric sort by Unicode code point. For example, \"2\" < \"A\" < \"X\" < \"b\" < \"z\".", + "Case insensitive alphanumeric sort by lower case Unicode code point. For example, \"2\" < \"A\" < \"b\" < \"X\" < \"z\".", + "Dimension values are converted to numbers before sorting. For example in NUMERIC sort, \"25\" < \"100\", and in `ALPHANUMERIC` sort, \"100\" < \"25\". Non-numeric dimension values all have equal ordering value below all numeric values." + ], + "type": "string" + } + }, + "type": "object" + }, + "DimensionValue": { + "description": "The value of a dimension.", + "id": "DimensionValue", + "properties": { + "value": { + "description": "Value as a string if the dimension type is a string.", + "type": "string" + } + }, + "type": "object" + }, + "Entity": { + "description": "The unique identifier of the property whose events are tracked.", + "id": "Entity", + "properties": { + "propertyId": { + "description": "A Google Analytics GA4 property id. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).", + "type": "string" + } + }, + "type": "object" + }, + "Filter": { + "description": "An expression to filter dimension or metric values.", + "id": "Filter", + "properties": { + "betweenFilter": { + "$ref": "BetweenFilter", + "description": "A filter for two values." + }, + "fieldName": { + "description": "The dimension name or metric name. Must be a name defined in dimensions or metrics.", + "type": "string" + }, + "inListFilter": { + "$ref": "InListFilter", + "description": "A filter for in list values." + }, + "nullFilter": { + "description": "A filter for null values. If True, a null dimension value is matched by this filter. Null filter is commonly used inside a NOT filter expression. For example, a NOT expression of a null filter removes rows when a dimension is null.", + "type": "boolean" + }, + "numericFilter": { + "$ref": "NumericFilter", + "description": "A filter for numeric or date values." + }, + "stringFilter": { + "$ref": "StringFilter", + "description": "Strings related filter." + } + }, + "type": "object" + }, + "FilterExpression": { + "description": "To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics.", + "id": "FilterExpression", + "properties": { + "andGroup": { + "$ref": "FilterExpressionList", + "description": "The FilterExpressions in and_group have an AND relationship." + }, + "filter": { + "$ref": "Filter", + "description": "A primitive filter. All fields in filter in same FilterExpression needs to be either all dimensions or metrics." + }, + "notExpression": { + "$ref": "FilterExpression", + "description": "The FilterExpression is NOT of not_expression." + }, + "orGroup": { + "$ref": "FilterExpressionList", + "description": "The FilterExpressions in or_group have an OR relationship." + } + }, + "type": "object" + }, + "FilterExpressionList": { + "description": "A list of filter expressions.", + "id": "FilterExpressionList", + "properties": { + "expressions": { + "description": "A list of filter expressions.", + "items": { + "$ref": "FilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "InListFilter": { + "description": "The result needs to be in a list of string values.", + "id": "InListFilter", + "properties": { + "caseSensitive": { + "description": "If true, the string value is case sensitive.", + "type": "boolean" + }, + "values": { + "description": "The list of string values. Must be non-empty.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Metadata": { + "description": "The dimensions and metrics currently accepted in reporting methods.", + "id": "Metadata", + "properties": { + "dimensions": { + "description": "The dimension descriptions.", + "items": { + "$ref": "DimensionMetadata" + }, + "type": "array" + }, + "metrics": { + "description": "The metric descriptions.", + "items": { + "$ref": "MetricMetadata" + }, + "type": "array" + }, + "name": { + "description": "Resource name of this metadata.", + "type": "string" + } + }, + "type": "object" + }, + "Metric": { + "description": "The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics.", + "id": "Metric", + "properties": { + "expression": { + "description": "A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.", + "type": "string" + }, + "invisible": { + "description": "Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`.", + "type": "boolean" + }, + "name": { + "description": "The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names. If `expression` is specified, `name` can be any string that you would like. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`.", + "type": "string" + } + }, + "type": "object" + }, + "MetricHeader": { + "description": "Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.", + "id": "MetricHeader", + "properties": { + "name": { + "description": "The metric's name.", + "type": "string" + }, + "type": { + "description": "The metric's data type.", + "enum": [ + "METRIC_TYPE_UNSPECIFIED", + "TYPE_INTEGER", + "TYPE_FLOAT", + "TYPE_SECONDS", + "TYPE_MILLISECONDS", + "TYPE_MINUTES", + "TYPE_HOURS", + "TYPE_STANDARD", + "TYPE_CURRENCY", + "TYPE_FEET", + "TYPE_MILES", + "TYPE_METERS", + "TYPE_KILOMETERS" + ], + "enumDescriptions": [ + "Unspecified type.", + "Integer type.", + "Floating point type.", + "A duration of seconds; a special floating point type.", + "A duration in milliseconds; a special floating point type.", + "A duration in minutes; a special floating point type.", + "A duration in hours; a special floating point type.", + "A custom metric of standard type; a special floating point type.", + "An amount of money; a special floating point type.", + "A length in feet; a special floating point type.", + "A length in miles; a special floating point type.", + "A length in meters; a special floating point type.", + "A length in kilometers; a special floating point type." + ], + "type": "string" + } + }, + "type": "object" + }, + "MetricMetadata": { + "description": "Explains a metric.", + "id": "MetricMetadata", + "properties": { + "apiName": { + "description": "A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`.", + "type": "string" + }, + "customDefinition": { + "description": "True if the metric is a custom metric for this property.", + "type": "boolean" + }, + "deprecatedApiNames": { + "description": "Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Description of how this metric is used and calculated.", + "type": "string" + }, + "expression": { + "description": "The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.", + "type": "string" + }, + "type": { + "description": "The type of this metric.", + "enum": [ + "METRIC_TYPE_UNSPECIFIED", + "TYPE_INTEGER", + "TYPE_FLOAT", + "TYPE_SECONDS", + "TYPE_MILLISECONDS", + "TYPE_MINUTES", + "TYPE_HOURS", + "TYPE_STANDARD", + "TYPE_CURRENCY", + "TYPE_FEET", + "TYPE_MILES", + "TYPE_METERS", + "TYPE_KILOMETERS" + ], + "enumDescriptions": [ + "Unspecified type.", + "Integer type.", + "Floating point type.", + "A duration of seconds; a special floating point type.", + "A duration in milliseconds; a special floating point type.", + "A duration in minutes; a special floating point type.", + "A duration in hours; a special floating point type.", + "A custom metric of standard type; a special floating point type.", + "An amount of money; a special floating point type.", + "A length in feet; a special floating point type.", + "A length in miles; a special floating point type.", + "A length in meters; a special floating point type.", + "A length in kilometers; a special floating point type." + ], + "type": "string" + }, + "uiName": { + "description": "This metric's name within the Google Analytics user interface. For example, `Event count`.", + "type": "string" + } + }, + "type": "object" + }, + "MetricOrderBy": { + "description": "Sorts by metric values.", + "id": "MetricOrderBy", + "properties": { + "metricName": { + "description": "A metric name in the request to order by.", + "type": "string" + } + }, + "type": "object" + }, + "MetricValue": { + "description": "The value of a metric.", + "id": "MetricValue", + "properties": { + "value": { + "description": "Measurement value. See MetricHeader for type.", + "type": "string" + } + }, + "type": "object" + }, + "NumericFilter": { + "description": "Filters for numeric or date values.", + "id": "NumericFilter", + "properties": { + "operation": { + "description": "The operation type for this filter.", + "enum": [ + "OPERATION_UNSPECIFIED", + "EQUAL", + "LESS_THAN", + "LESS_THAN_OR_EQUAL", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL" + ], + "enumDescriptions": [ + "Unspecified.", + "Equal", + "Less than", + "Less than or equal", + "Greater than", + "Greater than or equal" + ], + "type": "string" + }, + "value": { + "$ref": "NumericValue", + "description": "A numeric value or a date value." + } + }, + "type": "object" + }, + "NumericValue": { + "description": "To represent a number.", + "id": "NumericValue", + "properties": { + "doubleValue": { + "description": "Double value", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "Integer value", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "OrderBy": { + "description": "The sort options.", + "id": "OrderBy", + "properties": { + "desc": { + "description": "If true, sorts by descending order.", + "type": "boolean" + }, + "dimension": { + "$ref": "DimensionOrderBy", + "description": "Sorts results by a dimension's values." + }, + "metric": { + "$ref": "MetricOrderBy", + "description": "Sorts results by a metric's values." + }, + "pivot": { + "$ref": "PivotOrderBy", + "description": "Sorts results by a metric's values within a pivot column group." + } + }, + "type": "object" + }, + "Pivot": { + "description": "Describes the visible dimension columns and rows in the report response.", + "id": "Pivot", + "properties": { + "fieldNames": { + "description": "Dimension names for visible columns in the report response. Including \"dateRange\" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request.", + "items": { + "type": "string" + }, + "type": "array" + }, + "limit": { + "description": "The number of rows to return in this pivot. If unspecified, 10 rows are returned. If -1, all rows are returned.", + "format": "int64", + "type": "string" + }, + "metricAggregations": { + "description": "Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations.", + "items": { + "enum": [ + "METRIC_AGGREGATION_UNSPECIFIED", + "TOTAL", + "MINIMUM", + "MAXIMUM", + "COUNT" + ], + "enumDescriptions": [ + "Unspecified operator.", + "SUM operator.", + "Minimum operator.", + "Maximum operator.", + "Count operator." + ], + "type": "string" + }, + "type": "array" + }, + "offset": { + "description": "The row count of the start row. The first row is counted as row 0.", + "format": "int64", + "type": "string" + }, + "orderBys": { + "description": "Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names.", + "items": { + "$ref": "OrderBy" + }, + "type": "array" + } + }, + "type": "object" + }, + "PivotDimensionHeader": { + "description": "Summarizes dimension values from a row for this pivot.", + "id": "PivotDimensionHeader", + "properties": { + "dimensionValues": { + "description": "Values of multiple dimensions in a pivot.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "PivotHeader": { + "description": "Dimensions' values in a single pivot.", + "id": "PivotHeader", + "properties": { + "pivotDimensionHeaders": { + "description": "The size is the same as the cardinality of the corresponding dimension combinations.", + "items": { + "$ref": "PivotDimensionHeader" + }, + "type": "array" + }, + "rowCount": { + "description": "The cardinality of the pivot as if offset = 0 and limit = -1. The total number of rows for this pivot's fields regardless of how the parameters offset and limit are specified in the request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PivotOrderBy": { + "description": "Sorts by a pivot column group.", + "id": "PivotOrderBy", + "properties": { + "metricName": { + "description": "In the response to order by, order rows by this column. Must be a metric name from the request.", + "type": "string" + }, + "pivotSelections": { + "description": "Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair.", + "items": { + "$ref": "PivotSelection" + }, + "type": "array" + } + }, + "type": "object" + }, + "PivotSelection": { + "description": "A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{\"browser\", \"Chrome\"}} and metric_name = \"Sessions\", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|----------------", + "id": "PivotSelection", + "properties": { + "dimensionName": { + "description": "Must be a dimension name from the request.", + "type": "string" + }, + "dimensionValue": { + "description": "Order by only when the named dimension is this value.", + "type": "string" + } + }, + "type": "object" + }, + "PropertyQuota": { + "description": "Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.", + "id": "PropertyQuota", + "properties": { + "concurrentRequests": { + "$ref": "QuotaStatus", + "description": "Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests." + }, + "serverErrorsPerProjectPerHour": { + "$ref": "QuotaStatus", + "description": "Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour." + }, + "tokensPerDay": { + "$ref": "QuotaStatus", + "description": "Standard Analytics Properties can use up to 25,000 tokens per day; Analytics 360 Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens." + }, + "tokensPerHour": { + "$ref": "QuotaStatus", + "description": "Standard Analytics Properties can use up to 5,000 tokens per hour; Analytics 360 Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from both the hourly and daily quotas." + } + }, + "type": "object" + }, + "QuotaStatus": { + "description": "Current state for a particular quota group.", + "id": "QuotaStatus", + "properties": { + "consumed": { + "description": "Quota consumed by this request.", + "format": "int32", + "type": "integer" + }, + "remaining": { + "description": "Quota remaining after this request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResponseMetaData": { + "description": "Response's metadata carrying additional information about the report content.", + "id": "ResponseMetaData", + "properties": { + "dataLossFromOtherRow": { + "description": "If true, indicates some buckets of dimension combinations are rolled into \"(other)\" row. This can happen for high cardinality reports.", + "type": "boolean" + } + }, + "type": "object" + }, + "Row": { + "description": "Report data for each row. For example if RunReportRequest contains: ```none \"dimensions\": [ { \"name\": \"eventName\" }, { \"name\": \"countryId\" } ], \"metrics\": [ { \"name\": \"eventCount\" } ] ``` One row with 'in_app_purchase' as the eventName, 'JP' as the countryId, and 15 as the eventCount, would be: ```none \"dimensionValues\": [ { \"value\": \"in_app_purchase\" }, { \"value\": \"JP\" } ], \"metricValues\": [ { \"value\": \"15\" } ] ```", + "id": "Row", + "properties": { + "dimensionValues": { + "description": "List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "metricValues": { + "description": "List of requested visible metric values.", + "items": { + "$ref": "MetricValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "RunPivotReportRequest": { + "description": "The request to generate a pivot report.", + "id": "RunPivotReportRequest", + "properties": { + "cohortSpec": { + "$ref": "CohortSpec", + "description": "Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present." + }, + "currencyCode": { + "description": "A currency code in ISO4217 format, such as \"AED\", \"USD\", \"JPY\". If the field is empty, the report uses the entity's default currency.", + "type": "string" + }, + "dateRanges": { + "description": "The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name \"dateRange\" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified.", + "items": { + "$ref": "DateRange" + }, + "type": "array" + }, + "dimensionFilter": { + "$ref": "FilterExpression", + "description": "The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter." + }, + "dimensions": { + "description": "The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "entity": { + "$ref": "Entity", + "description": "A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity." + }, + "keepEmptyRows": { + "description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.", + "type": "boolean" + }, + "metricFilter": { + "$ref": "FilterExpression", + "description": "The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter." + }, + "metrics": { + "description": "The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "pivots": { + "description": "Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot.", + "items": { + "$ref": "Pivot" + }, + "type": "array" + }, + "returnPropertyQuota": { + "description": "Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).", + "type": "boolean" + } + }, + "type": "object" + }, + "RunPivotReportResponse": { + "description": "The response pivot report table corresponding to a pivot request.", + "id": "RunPivotReportResponse", + "properties": { + "aggregates": { + "description": "Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to \"RESERVED_\".", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "dimensionHeaders": { + "description": "Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.", + "items": { + "$ref": "DimensionHeader" + }, + "type": "array" + }, + "metadata": { + "$ref": "ResponseMetaData", + "description": "Metadata for the report." + }, + "metricHeaders": { + "description": "Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.", + "items": { + "$ref": "MetricHeader" + }, + "type": "array" + }, + "pivotHeaders": { + "description": "Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: \"pivots\": [{ \"fieldNames\": [\"country\", \"city\"] }, { \"fieldNames\": \"eventName\" }] We will have the following `pivotHeaders` in the response: \"pivotHeaders\" : [{ \"dimensionHeaders\": [{ \"dimensionValues\": [ { \"value\": \"United Kingdom\" }, { \"value\": \"London\" } ] }, { \"dimensionValues\": [ { \"value\": \"Japan\" }, { \"value\": \"Osaka\" } ] }] }, { \"dimensionHeaders\": [{ \"dimensionValues\": [{ \"value\": \"session_start\" }] }, { \"dimensionValues\": [{ \"value\": \"scroll\" }] }] }]", + "items": { + "$ref": "PivotHeader" + }, + "type": "array" + }, + "propertyQuota": { + "$ref": "PropertyQuota", + "description": "This Analytics Property's quota state including this request." + }, + "rows": { + "description": "Rows of dimension value combinations and metric values in the report.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "RunRealtimeReportRequest": { + "description": "The request to generate a realtime report.", + "id": "RunRealtimeReportRequest", + "properties": { + "dimensionFilter": { + "$ref": "FilterExpression", + "description": "The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter." + }, + "dimensions": { + "description": "The dimensions requested and displayed.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "limit": { + "description": "The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned.", + "format": "int64", + "type": "string" + }, + "metricAggregations": { + "description": "Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to \"RESERVED_(MetricAggregation)\".", + "items": { + "enum": [ + "METRIC_AGGREGATION_UNSPECIFIED", + "TOTAL", + "MINIMUM", + "MAXIMUM", + "COUNT" + ], + "enumDescriptions": [ + "Unspecified operator.", + "SUM operator.", + "Minimum operator.", + "Maximum operator.", + "Count operator." + ], + "type": "string" + }, + "type": "array" + }, + "metricFilter": { + "$ref": "FilterExpression", + "description": "The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter." + }, + "metrics": { + "description": "The metrics requested and displayed.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "orderBys": { + "description": "Specifies how rows are ordered in the response.", + "items": { + "$ref": "OrderBy" + }, + "type": "array" + }, + "returnPropertyQuota": { + "description": "Toggles whether to return the current state of this Analytics Property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).", + "type": "boolean" + } + }, + "type": "object" + }, + "RunRealtimeReportResponse": { + "description": "The response realtime report table corresponding to a request.", + "id": "RunRealtimeReportResponse", + "properties": { + "dimensionHeaders": { + "description": "Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.", + "items": { + "$ref": "DimensionHeader" + }, + "type": "array" + }, + "maximums": { + "description": "If requested, the maximum values of metrics.", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "metricHeaders": { + "description": "Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.", + "items": { + "$ref": "MetricHeader" + }, + "type": "array" + }, + "minimums": { + "description": "If requested, the minimum values of metrics.", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "propertyQuota": { + "$ref": "PropertyQuota", + "description": "This Analytics Property's Realtime quota state including this request." + }, + "rowCount": { + "description": "The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows.", + "format": "int32", + "type": "integer" + }, + "rows": { + "description": "Rows of dimension value combinations and metric values in the report.", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "totals": { + "description": "If requested, the totaled values of metrics.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "RunReportRequest": { + "description": "The request to generate a report.", + "id": "RunReportRequest", + "properties": { + "cohortSpec": { + "$ref": "CohortSpec", + "description": "Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present." + }, + "currencyCode": { + "description": "A currency code in ISO4217 format, such as \"AED\", \"USD\", \"JPY\". If the field is empty, the report uses the entity's default currency.", + "type": "string" + }, + "dateRanges": { + "description": "Date ranges of data to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified.", + "items": { + "$ref": "DateRange" + }, + "type": "array" + }, + "dimensionFilter": { + "$ref": "FilterExpression", + "description": "The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter." + }, + "dimensions": { + "description": "The dimensions requested and displayed.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "entity": { + "$ref": "Entity", + "description": "A property whose events are tracked. Within a batch request, this entity should either be unspecified or consistent with the batch-level entity." + }, + "keepEmptyRows": { + "description": "If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter.", + "type": "boolean" + }, + "limit": { + "description": "The number of rows to return. If unspecified, 10 rows are returned. If -1, all rows are returned. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).", + "format": "int64", + "type": "string" + }, + "metricAggregations": { + "description": "Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to \"RESERVED_(MetricAggregation)\".", + "items": { + "enum": [ + "METRIC_AGGREGATION_UNSPECIFIED", + "TOTAL", + "MINIMUM", + "MAXIMUM", + "COUNT" + ], + "enumDescriptions": [ + "Unspecified operator.", + "SUM operator.", + "Minimum operator.", + "Maximum operator.", + "Count operator." + ], + "type": "string" + }, + "type": "array" + }, + "metricFilter": { + "$ref": "FilterExpression", + "description": "The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter." + }, + "metrics": { + "description": "The metrics requested and displayed.", + "items": { + "$ref": "Metric" + }, + "type": "array" + }, + "offset": { + "description": "The row count of the start row. The first row is counted as row 0. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).", + "format": "int64", + "type": "string" + }, + "orderBys": { + "description": "Specifies how rows are ordered in the response.", + "items": { + "$ref": "OrderBy" + }, + "type": "array" + }, + "returnPropertyQuota": { + "description": "Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).", + "type": "boolean" + } + }, + "type": "object" + }, + "RunReportResponse": { + "description": "The response report table corresponding to a request.", + "id": "RunReportResponse", + "properties": { + "dimensionHeaders": { + "description": "Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.", + "items": { + "$ref": "DimensionHeader" + }, + "type": "array" + }, + "maximums": { + "description": "If requested, the maximum values of metrics.", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "metadata": { + "$ref": "ResponseMetaData", + "description": "Metadata for the report." + }, + "metricHeaders": { + "description": "Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.", + "items": { + "$ref": "MetricHeader" + }, + "type": "array" + }, + "minimums": { + "description": "If requested, the minimum values of metrics.", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "propertyQuota": { + "$ref": "PropertyQuota", + "description": "This Analytics Property's quota state including this request." + }, + "rowCount": { + "description": "The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).", + "format": "int32", + "type": "integer" + }, + "rows": { + "description": "Rows of dimension value combinations and metric values in the report.", + "items": { + "$ref": "Row" + }, + "type": "array" + }, + "totals": { + "description": "If requested, the totaled values of metrics.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "StringFilter": { + "description": "The filter for string", + "id": "StringFilter", + "properties": { + "caseSensitive": { + "description": "If true, the string value is case sensitive.", + "type": "boolean" + }, + "matchType": { + "description": "The match type for this filter.", + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "EXACT", + "BEGINS_WITH", + "ENDS_WITH", + "CONTAINS", + "FULL_REGEXP", + "PARTIAL_REGEXP" + ], + "enumDescriptions": [ + "Unspecified", + "Exact match of the string value.", + "Begins with the string value.", + "Ends with the string value.", + "Contains the string value.", + "Full regular expression match with the string value.", + "Partial regular expression match with the string value." + ], + "type": "string" + }, + "value": { + "description": "The string value used for the matching.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Google Analytics Data API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/appengine__v1beta.json b/discovery/googleapis_beta/appengine__v1beta.json deleted file mode 100644 index c10bbdd..0000000 --- a/discovery/googleapis_beta/appengine__v1beta.json +++ /dev/null
@@ -1,3717 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/appengine.admin": { - "description": "View and manage your applications deployed on Google App Engine" - }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://appengine.googleapis.com/", - "batchPath": "batch", - "description": "Provisions and manages developers' App Engine applications.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "appengine:v1beta", - "kind": "discovery#restDescription", - "name": "appengine", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "apps": { - "methods": { - "create": { - "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/standard/python/console/).", - "httpMethod": "POST", - "id": "appengine.apps.create", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta/apps", - "request": { - "$ref": "Application" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets information about an application.", - "httpMethod": "GET", - "id": "appengine.apps.get", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}", - "response": { - "$ref": "Application" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.", - "httpMethod": "PATCH", - "id": "appengine.apps.patch", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}", - "request": { - "$ref": "Application" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "repair": { - "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B\"name\"%3A\"projects%2F-%2FserviceAccounts%2Funique_id\"%2C\"resource\"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.", - "httpMethod": "POST", - "id": "appengine.apps.repair", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the application to repair. Example: apps/myapp", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}:repair", - "request": { - "$ref": "RepairApplicationRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "authorizedCertificates": { - "methods": { - "create": { - "description": "Uploads the specified SSL certificate.", - "httpMethod": "POST", - "id": "appengine.apps.authorizedCertificates.create", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/authorizedCertificates", - "request": { - "$ref": "AuthorizedCertificate" - }, - "response": { - "$ref": "AuthorizedCertificate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes the specified SSL certificate.", - "httpMethod": "DELETE", - "id": "appengine.apps.authorizedCertificates.delete", - "parameterOrder": [ - "appsId", - "authorizedCertificatesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", - "location": "path", - "required": true, - "type": "string" - }, - "authorizedCertificatesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified SSL certificate.", - "httpMethod": "GET", - "id": "appengine.apps.authorizedCertificates.get", - "parameterOrder": [ - "appsId", - "authorizedCertificatesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", - "location": "path", - "required": true, - "type": "string" - }, - "authorizedCertificatesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "view": { - "description": "Controls the set of fields returned in the GET response.", - "enum": [ - "BASIC_CERTIFICATE", - "FULL_CERTIFICATE" - ], - "enumDescriptions": [ - "Basic certificate information, including applicable domains and expiration date.", - "The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "response": { - "$ref": "AuthorizedCertificate" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists all SSL certificates the user is authorized to administer.", - "httpMethod": "GET", - "id": "appengine.apps.authorizedCertificates.list", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "location": "query", - "type": "string" - }, - "view": { - "description": "Controls the set of fields returned in the LIST response.", - "enum": [ - "BASIC_CERTIFICATE", - "FULL_CERTIFICATE" - ], - "enumDescriptions": [ - "Basic certificate information, including applicable domains and expiration date.", - "The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/authorizedCertificates", - "response": { - "$ref": "ListAuthorizedCertificatesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", - "httpMethod": "PATCH", - "id": "appengine.apps.authorizedCertificates.patch", - "parameterOrder": [ - "appsId", - "authorizedCertificatesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", - "location": "path", - "required": true, - "type": "string" - }, - "authorizedCertificatesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "request": { - "$ref": "AuthorizedCertificate" - }, - "response": { - "$ref": "AuthorizedCertificate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "authorizedDomains": { - "methods": { - "list": { - "description": "Lists all domains the user is authorized to administer.", - "httpMethod": "GET", - "id": "appengine.apps.authorizedDomains.list", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/authorizedDomains", - "response": { - "$ref": "ListAuthorizedDomainsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - }, - "domainMappings": { - "methods": { - "create": { - "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.", - "httpMethod": "POST", - "id": "appengine.apps.domainMappings.create", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - }, - "overrideStrategy": { - "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.", - "enum": [ - "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY", - "STRICT", - "OVERRIDE" - ], - "enumDescriptions": [ - "Strategy unspecified. Defaults to STRICT.", - "Overrides not allowed. If a mapping already exists for the specified domain, the request will return an ALREADY_EXISTS (409).", - "Overrides allowed. If a mapping already exists for the specified domain, the request will overwrite it. Note that this might stop another Google product from serving. For example, if the domain is mapped to another App Engine application, that app will no longer serve from that domain." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/domainMappings", - "request": { - "$ref": "DomainMapping" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", - "httpMethod": "DELETE", - "id": "appengine.apps.domainMappings.delete", - "parameterOrder": [ - "appsId", - "domainMappingsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", - "location": "path", - "required": true, - "type": "string" - }, - "domainMappingsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified domain mapping.", - "httpMethod": "GET", - "id": "appengine.apps.domainMappings.get", - "parameterOrder": [ - "appsId", - "domainMappingsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", - "location": "path", - "required": true, - "type": "string" - }, - "domainMappingsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "response": { - "$ref": "DomainMapping" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists the domain mappings on an application.", - "httpMethod": "GET", - "id": "appengine.apps.domainMappings.list", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/domainMappings", - "response": { - "$ref": "ListDomainMappingsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", - "httpMethod": "PATCH", - "id": "appengine.apps.domainMappings.patch", - "parameterOrder": [ - "appsId", - "domainMappingsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", - "location": "path", - "required": true, - "type": "string" - }, - "domainMappingsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "request": { - "$ref": "DomainMapping" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "firewall": { - "resources": { - "ingressRules": { - "methods": { - "batchUpdate": { - "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.", - "httpMethod": "POST", - "id": "appengine.apps.firewall.ingressRules.batchUpdate", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate", - "request": { - "$ref": "BatchUpdateIngressRulesRequest" - }, - "response": { - "$ref": "BatchUpdateIngressRulesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a firewall rule for the application.", - "httpMethod": "POST", - "id": "appengine.apps.firewall.ingressRules.create", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/firewall/ingressRules", - "request": { - "$ref": "FirewallRule" - }, - "response": { - "$ref": "FirewallRule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes the specified firewall rule.", - "httpMethod": "DELETE", - "id": "appengine.apps.firewall.ingressRules.delete", - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.", - "location": "path", - "required": true, - "type": "string" - }, - "ingressRulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified firewall rule.", - "httpMethod": "GET", - "id": "appengine.apps.firewall.ingressRules.get", - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.", - "location": "path", - "required": true, - "type": "string" - }, - "ingressRulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "response": { - "$ref": "FirewallRule" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists the firewall rules of an application.", - "httpMethod": "GET", - "id": "appengine.apps.firewall.ingressRules.list", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.", - "location": "path", - "required": true, - "type": "string" - }, - "matchingAddress": { - "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/firewall/ingressRules", - "response": { - "$ref": "ListIngressRulesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates the specified firewall rule.", - "httpMethod": "PATCH", - "id": "appengine.apps.firewall.ingressRules.patch", - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.", - "location": "path", - "required": true, - "type": "string" - }, - "ingressRulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "request": { - "$ref": "FirewallRule" - }, - "response": { - "$ref": "FirewallRule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "locations": { - "methods": { - "get": { - "description": "Gets information about a location.", - "httpMethod": "GET", - "id": "appengine.apps.locations.get", - "parameterOrder": [ - "appsId", - "locationsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Resource name for the location.", - "location": "path", - "required": true, - "type": "string" - }, - "locationsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/locations/{locationsId}", - "response": { - "$ref": "Location" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists information about the supported locations for this service.", - "httpMethod": "GET", - "id": "appengine.apps.locations.list", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. The resource that owns the locations collection, if applicable.", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/locations", - "response": { - "$ref": "ListLocationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - }, - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "appengine.apps.operations.get", - "parameterOrder": [ - "appsId", - "operationsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. The name of the operation resource.", - "location": "path", - "required": true, - "type": "string" - }, - "operationsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/operations/{operationsId}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", - "id": "appengine.apps.operations.list", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. The name of the operation's parent resource.", - "location": "path", - "required": true, - "type": "string" - }, - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/operations", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - }, - "services": { - "methods": { - "delete": { - "description": "Deletes the specified service and all enclosed versions.", - "httpMethod": "DELETE", - "id": "appengine.apps.services.delete", - "parameterOrder": [ - "appsId", - "servicesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the current configuration of the specified service.", - "httpMethod": "GET", - "id": "appengine.apps.services.get", - "parameterOrder": [ - "appsId", - "servicesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}", - "response": { - "$ref": "Service" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists all the services in the application.", - "httpMethod": "GET", - "id": "appengine.apps.services.list", - "parameterOrder": [ - "appsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services", - "response": { - "$ref": "ListServicesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates the configuration of the specified service.", - "httpMethod": "PATCH", - "id": "appengine.apps.services.patch", - "parameterOrder": [ - "appsId", - "servicesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", - "location": "path", - "required": true, - "type": "string" - }, - "migrateTraffic": { - "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#InboundServiceType) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#AutomaticScaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#ShardBy) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", - "location": "query", - "type": "boolean" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}", - "request": { - "$ref": "Service" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "versions": { - "methods": { - "create": { - "description": "Deploys code and resource files to a new version.", - "httpMethod": "POST", - "id": "appengine.apps.services.versions.create", - "parameterOrder": [ - "appsId", - "servicesId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `parent`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions", - "request": { - "$ref": "Version" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an existing Version resource.", - "httpMethod": "DELETE", - "id": "appengine.apps.services.versions.delete", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", - "httpMethod": "GET", - "id": "appengine.apps.services.versions.get", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "view": { - "description": "Controls the set of fields returned in the Get response.", - "enum": [ - "BASIC", - "FULL" - ], - "enumDescriptions": [ - "Basic version information including scaling and inbound services, but not detailed deployment information.", - "The information from BASIC, plus detailed information about the deployment. This format is required when creating resources, but is not returned in Get or List by default." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "response": { - "$ref": "Version" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists the versions of a service.", - "httpMethod": "GET", - "id": "appengine.apps.services.versions.list", - "parameterOrder": [ - "appsId", - "servicesId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "location": "query", - "type": "string" - }, - "servicesId": { - "description": "Part of `parent`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "view": { - "description": "Controls the set of fields returned in the List response.", - "enum": [ - "BASIC", - "FULL" - ], - "enumDescriptions": [ - "Basic version information including scaling and inbound services, but not detailed deployment information.", - "The information from BASIC, plus detailed information about the deployment. This format is required when creating resources, but is not returned in Get or List by default." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions", - "response": { - "$ref": "ListVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)", - "httpMethod": "PATCH", - "id": "appengine.apps.services.versions.patch", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "request": { - "$ref": "Version" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "instances": { - "methods": { - "debug": { - "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", - "httpMethod": "POST", - "id": "appengine.apps.services.versions.instances.debug", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId", - "instancesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", - "location": "path", - "required": true, - "type": "string" - }, - "instancesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", - "request": { - "$ref": "DebugInstanceRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Stops a running instance.The instance might be automatically recreated based on the scaling settings of the version. For more information, see \"How Instances are Managed\" (standard environment (https://cloud.google.com/appengine/docs/standard/python/how-instances-are-managed) | flexible environment (https://cloud.google.com/appengine/docs/flexible/python/how-instances-are-managed)).To ensure that instances are not re-created and avoid getting billed, you can stop all instances within the target version by changing the serving status of the version to STOPPED with the apps.services.versions.patch (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions/patch) method.", - "httpMethod": "DELETE", - "id": "appengine.apps.services.versions.instances.delete", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId", - "instancesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", - "location": "path", - "required": true, - "type": "string" - }, - "instancesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets instance information.", - "httpMethod": "GET", - "id": "appengine.apps.services.versions.instances.get", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId", - "instancesId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", - "location": "path", - "required": true, - "type": "string" - }, - "instancesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "response": { - "$ref": "Instance" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).", - "httpMethod": "GET", - "id": "appengine.apps.services.versions.instances.list", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.", - "location": "path", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "location": "query", - "type": "string" - }, - "servicesId": { - "description": "Part of `parent`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `parent`. See documentation of `appsId`.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", - "response": { - "$ref": "ListInstancesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - } - } - } - } - } - } - } - }, - "revision": "20201003", - "rootUrl": "https://appengine.googleapis.com/", - "schemas": { - "ApiConfigHandler": { - "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", - "id": "ApiConfigHandler", - "properties": { - "authFailAction": { - "description": "Action to take when users access resources that require authentication. Defaults to redirect.", - "enum": [ - "AUTH_FAIL_ACTION_UNSPECIFIED", - "AUTH_FAIL_ACTION_REDIRECT", - "AUTH_FAIL_ACTION_UNAUTHORIZED" - ], - "enumDescriptions": [ - "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", - "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", - "Rejects request with a 401 HTTP status code and an error message." - ], - "type": "string" - }, - "login": { - "description": "Level of login required to access this resource. Defaults to optional.", - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" - ], - "enumDescriptions": [ - "Not specified. LOGIN_OPTIONAL is assumed.", - "Does not require that the user is signed in.", - "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", - "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." - ], - "type": "string" - }, - "script": { - "description": "Path to the script from the application root directory.", - "type": "string" - }, - "securityLevel": { - "description": "Security (HTTPS) enforcement for this URL.", - "enum": [ - "SECURE_UNSPECIFIED", - "SECURE_DEFAULT", - "SECURE_NEVER", - "SECURE_OPTIONAL", - "SECURE_ALWAYS" - ], - "enumDescriptions": [ - "Not specified.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", - "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", - "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." - ], - "type": "string" - }, - "url": { - "description": "URL to serve the endpoint at.", - "type": "string" - } - }, - "type": "object" - }, - "ApiEndpointHandler": { - "description": "Uses Google Cloud Endpoints to handle requests.", - "id": "ApiEndpointHandler", - "properties": { - "scriptPath": { - "description": "Path to the script from the application root directory.", - "type": "string" - } - }, - "type": "object" - }, - "Application": { - "description": "An Application resource contains the top-level configuration of an App Engine application.", - "id": "Application", - "properties": { - "authDomain": { - "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.", - "type": "string" - }, - "codeBucket": { - "description": "Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly", - "type": "string" - }, - "databaseType": { - "description": "The type of the Cloud Firestore or Cloud Datastore database associated with this application.", - "enum": [ - "DATABASE_TYPE_UNSPECIFIED", - "CLOUD_DATASTORE", - "CLOUD_FIRESTORE", - "CLOUD_DATASTORE_COMPATIBILITY" - ], - "enumDescriptions": [ - "Database type is unspecified.", - "Cloud Datastore", - "Cloud Firestore Native", - "Cloud Firestore in Datastore Mode" - ], - "type": "string" - }, - "defaultBucket": { - "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly", - "type": "string" - }, - "defaultCookieExpiration": { - "description": "Cookie expiration policy for this application.", - "format": "google-duration", - "type": "string" - }, - "defaultHostname": { - "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly", - "type": "string" - }, - "dispatchRules": { - "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.", - "items": { - "$ref": "UrlDispatchRule" - }, - "type": "array" - }, - "featureSettings": { - "$ref": "FeatureSettings", - "description": "The feature specific settings to be used in the application." - }, - "gcrDomain": { - "description": "The Google Container Registry domain used for storing managed build docker images for this application.", - "type": "string" - }, - "iap": { - "$ref": "IdentityAwareProxy" - }, - "id": { - "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", - "type": "string" - }, - "locationId": { - "description": "Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).", - "type": "string" - }, - "name": { - "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", - "type": "string" - }, - "servingStatus": { - "description": "Serving status of this application.", - "enum": [ - "UNSPECIFIED", - "SERVING", - "USER_DISABLED", - "SYSTEM_DISABLED" - ], - "enumDescriptions": [ - "Serving status is unspecified.", - "Application is serving.", - "Application has been disabled by the user.", - "Application has been disabled by the system." - ], - "type": "string" - } - }, - "type": "object" - }, - "AuthorizedCertificate": { - "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.", - "id": "AuthorizedCertificate", - "properties": { - "certificateRawData": { - "$ref": "CertificateRawData", - "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority." - }, - "displayName": { - "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.", - "type": "string" - }, - "domainMappingsCount": { - "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "domainNames": { - "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly", - "items": { - "type": "string" - }, - "type": "array" - }, - "expireTime": { - "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "id": { - "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly", - "type": "string" - }, - "managedCertificate": { - "$ref": "ManagedCertificate", - "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly" - }, - "name": { - "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly", - "type": "string" - }, - "visibleDomainMappings": { - "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AuthorizedDomain": { - "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).", - "id": "AuthorizedDomain", - "properties": { - "id": { - "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.", - "type": "string" - }, - "name": { - "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly", - "type": "string" - } - }, - "type": "object" - }, - "AutomaticScaling": { - "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", - "id": "AutomaticScaling", - "properties": { - "coolDownPeriod": { - "description": "The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.", - "format": "google-duration", - "type": "string" - }, - "cpuUtilization": { - "$ref": "CpuUtilization", - "description": "Target scaling by CPU usage." - }, - "customMetrics": { - "description": "Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment.", - "items": { - "$ref": "CustomMetric" - }, - "type": "array" - }, - "diskUtilization": { - "$ref": "DiskUtilization", - "description": "Target scaling by disk usage." - }, - "maxConcurrentRequests": { - "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", - "format": "int32", - "type": "integer" - }, - "maxIdleInstances": { - "description": "Maximum number of idle instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "maxPendingLatency": { - "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "maxTotalInstances": { - "description": "Maximum number of instances that should be started to handle requests for this version.", - "format": "int32", - "type": "integer" - }, - "minIdleInstances": { - "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.", - "format": "int32", - "type": "integer" - }, - "minPendingLatency": { - "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "minTotalInstances": { - "description": "Minimum number of running instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "networkUtilization": { - "$ref": "NetworkUtilization", - "description": "Target scaling by network usage." - }, - "requestUtilization": { - "$ref": "RequestUtilization", - "description": "Target scaling by request utilization." - }, - "standardSchedulerSettings": { - "$ref": "StandardSchedulerSettings", - "description": "Scheduler settings for standard environment." - } - }, - "type": "object" - }, - "BasicScaling": { - "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", - "id": "BasicScaling", - "properties": { - "idleTimeout": { - "description": "Duration of time after the last request that an instance must wait before the instance is shut down.", - "format": "google-duration", - "type": "string" - }, - "maxInstances": { - "description": "Maximum number of instances to create for this version.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "BatchUpdateIngressRulesRequest": { - "description": "Request message for Firewall.BatchUpdateIngressRules.", - "id": "BatchUpdateIngressRulesRequest", - "properties": { - "ingressRules": { - "description": "A list of FirewallRules to replace the existing set.", - "items": { - "$ref": "FirewallRule" - }, - "type": "array" - } - }, - "type": "object" - }, - "BatchUpdateIngressRulesResponse": { - "description": "Response message for Firewall.UpdateAllIngressRules.", - "id": "BatchUpdateIngressRulesResponse", - "properties": { - "ingressRules": { - "description": "The full list of ingress FirewallRules for this application.", - "items": { - "$ref": "FirewallRule" - }, - "type": "array" - } - }, - "type": "object" - }, - "BuildInfo": { - "description": "Google Cloud Build information.", - "id": "BuildInfo", - "properties": { - "cloudBuildId": { - "description": "The Google Cloud Build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"", - "type": "string" - } - }, - "type": "object" - }, - "CertificateRawData": { - "description": "An SSL certificate obtained from a certificate authority.", - "id": "CertificateRawData", - "properties": { - "privateKey": { - "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly", - "type": "string" - }, - "publicCertificate": { - "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- ", - "type": "string" - } - }, - "type": "object" - }, - "CloudBuildOptions": { - "description": "Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.", - "id": "CloudBuildOptions", - "properties": { - "appYamlPath": { - "description": "Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.", - "type": "string" - }, - "cloudBuildTimeout": { - "description": "The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "ContainerInfo": { - "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.", - "id": "ContainerInfo", - "properties": { - "image": { - "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"", - "type": "string" - } - }, - "type": "object" - }, - "CpuUtilization": { - "description": "Target scaling by CPU usage.", - "id": "CpuUtilization", - "properties": { - "aggregationWindowLength": { - "description": "Period of time over which CPU utilization is calculated.", - "format": "google-duration", - "type": "string" - }, - "targetUtilization": { - "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "CreateVersionMetadataV1": { - "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.", - "id": "CreateVersionMetadataV1", - "properties": { - "cloudBuildId": { - "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", - "type": "string" - } - }, - "type": "object" - }, - "CreateVersionMetadataV1Alpha": { - "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", - "id": "CreateVersionMetadataV1Alpha", - "properties": { - "cloudBuildId": { - "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", - "type": "string" - } - }, - "type": "object" - }, - "CreateVersionMetadataV1Beta": { - "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.", - "id": "CreateVersionMetadataV1Beta", - "properties": { - "cloudBuildId": { - "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", - "type": "string" - } - }, - "type": "object" - }, - "CustomMetric": { - "description": "Allows autoscaling based on Stackdriver metrics.", - "id": "CustomMetric", - "properties": { - "filter": { - "description": "Allows filtering on the metric's fields.", - "type": "string" - }, - "metricName": { - "description": "The name of the metric.", - "type": "string" - }, - "singleInstanceAssignment": { - "description": "May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment.", - "format": "double", - "type": "number" - }, - "targetType": { - "description": "The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.", - "type": "string" - }, - "targetUtilization": { - "description": "The target value for the metric.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "DebugInstanceRequest": { - "description": "Request message for Instances.DebugInstance.", - "id": "DebugInstanceRequest", - "properties": { - "sshKey": { - "description": "Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).", - "type": "string" - } - }, - "type": "object" - }, - "Deployment": { - "description": "Code and application artifacts used to deploy a version to App Engine.", - "id": "Deployment", - "properties": { - "build": { - "$ref": "BuildInfo", - "description": "Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment." - }, - "cloudBuildOptions": { - "$ref": "CloudBuildOptions", - "description": "Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip." - }, - "container": { - "$ref": "ContainerInfo", - "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment." - }, - "files": { - "additionalProperties": { - "$ref": "FileInfo" - }, - "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.", - "type": "object" - }, - "zip": { - "$ref": "ZipInfo", - "description": "The zip file for this deployment, if this is a zip deployment." - } - }, - "type": "object" - }, - "DiskUtilization": { - "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.", - "id": "DiskUtilization", - "properties": { - "targetReadBytesPerSecond": { - "description": "Target bytes read per second.", - "format": "int32", - "type": "integer" - }, - "targetReadOpsPerSecond": { - "description": "Target ops read per seconds.", - "format": "int32", - "type": "integer" - }, - "targetWriteBytesPerSecond": { - "description": "Target bytes written per second.", - "format": "int32", - "type": "integer" - }, - "targetWriteOpsPerSecond": { - "description": "Target ops written per second.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DomainMapping": { - "description": "A domain serving an App Engine application.", - "id": "DomainMapping", - "properties": { - "id": { - "description": "Relative name of the domain serving the application. Example: example.com.", - "type": "string" - }, - "name": { - "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly", - "type": "string" - }, - "resourceRecords": { - "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly", - "items": { - "$ref": "ResourceRecord" - }, - "type": "array" - }, - "sslSettings": { - "$ref": "SslSettings", - "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL." - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for Empty is empty JSON object {}.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "EndpointsApiService": { - "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", - "id": "EndpointsApiService", - "properties": { - "configId": { - "description": "Endpoints service configuration ID as specified by the Service Management API. For example \"2016-09-19r1\".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.", - "type": "string" - }, - "disableTraceSampling": { - "description": "Enable or disable trace sampling. By default, this is set to false for enabled.", - "type": "boolean" - }, - "name": { - "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", - "type": "string" - }, - "rolloutStrategy": { - "description": "Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.", - "enum": [ - "UNSPECIFIED_ROLLOUT_STRATEGY", - "FIXED", - "MANAGED" - ], - "enumDescriptions": [ - "Not specified. Defaults to FIXED.", - "Endpoints service configuration ID will be fixed to the configuration ID specified by config_id.", - "Endpoints service configuration ID will be updated with each rollout." - ], - "type": "string" - } - }, - "type": "object" - }, - "Entrypoint": { - "description": "The entrypoint for the application.", - "id": "Entrypoint", - "properties": { - "shell": { - "description": "The format should be a shell command that can be fed to bash -c.", - "type": "string" - } - }, - "type": "object" - }, - "ErrorHandler": { - "description": "Custom static error page to be served when an error occurs.", - "id": "ErrorHandler", - "properties": { - "errorCode": { - "description": "Error condition this handler applies to.", - "enum": [ - "ERROR_CODE_UNSPECIFIED", - "ERROR_CODE_DEFAULT", - "ERROR_CODE_OVER_QUOTA", - "ERROR_CODE_DOS_API_DENIAL", - "ERROR_CODE_TIMEOUT" - ], - "enumDescriptions": [ - "Not specified. ERROR_CODE_DEFAULT is assumed.", - "All other error types.", - "Application has exceeded a resource quota.", - "Client blocked by the application's Denial of Service protection configuration.", - "Deadline reached before the application responds." - ], - "type": "string" - }, - "mimeType": { - "description": "MIME type of file. Defaults to text/html.", - "type": "string" - }, - "staticFile": { - "description": "Static file content to be served for this error.", - "type": "string" - } - }, - "type": "object" - }, - "FeatureSettings": { - "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.", - "id": "FeatureSettings", - "properties": { - "splitHealthChecks": { - "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.", - "type": "boolean" - }, - "useContainerOptimizedOs": { - "description": "If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.", - "type": "boolean" - } - }, - "type": "object" - }, - "FileInfo": { - "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.", - "id": "FileInfo", - "properties": { - "mimeType": { - "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.", - "type": "string" - }, - "sha1Sum": { - "description": "The SHA1 hash of the file, in hex.", - "type": "string" - }, - "sourceUrl": { - "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.", - "type": "string" - } - }, - "type": "object" - }, - "FirewallRule": { - "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.", - "id": "FirewallRule", - "properties": { - "action": { - "description": "The action to take on matched requests.", - "enum": [ - "UNSPECIFIED_ACTION", - "ALLOW", - "DENY" - ], - "enumDescriptions": [ - "", - "Matching requests are allowed.", - "Matching requests are denied." - ], - "type": "string" - }, - "description": { - "description": "An optional string description of this rule. This field has a maximum length of 100 characters.", - "type": "string" - }, - "priority": { - "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.", - "format": "int32", - "type": "integer" - }, - "sourceRange": { - "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. Truncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.", - "type": "string" - } - }, - "type": "object" - }, - "HealthCheck": { - "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.", - "id": "HealthCheck", - "properties": { - "checkInterval": { - "description": "Interval between health checks.", - "format": "google-duration", - "type": "string" - }, - "disableHealthCheck": { - "description": "Whether to explicitly disable health checks for this instance.", - "type": "boolean" - }, - "healthyThreshold": { - "description": "Number of consecutive successful health checks required before receiving traffic.", - "format": "uint32", - "type": "integer" - }, - "host": { - "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"", - "type": "string" - }, - "restartThreshold": { - "description": "Number of consecutive failed health checks required before an instance is restarted.", - "format": "uint32", - "type": "integer" - }, - "timeout": { - "description": "Time before the health check is considered failed.", - "format": "google-duration", - "type": "string" - }, - "unhealthyThreshold": { - "description": "Number of consecutive failed health checks required before removing traffic.", - "format": "uint32", - "type": "integer" - } - }, - "type": "object" - }, - "IdentityAwareProxy": { - "description": "Identity-Aware Proxy", - "id": "IdentityAwareProxy", - "properties": { - "enabled": { - "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.", - "type": "boolean" - }, - "oauth2ClientId": { - "description": "OAuth2 client ID to use for the authentication flow.", - "type": "string" - }, - "oauth2ClientSecret": { - "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly", - "type": "string" - }, - "oauth2ClientSecretSha256": { - "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly", - "type": "string" - } - }, - "type": "object" - }, - "Instance": { - "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.", - "id": "Instance", - "properties": { - "appEngineRelease": { - "description": "Output only. App Engine release this instance is running on.", - "readOnly": true, - "type": "string" - }, - "availability": { - "description": "Output only. Availability of the instance.", - "enum": [ - "UNSPECIFIED", - "RESIDENT", - "DYNAMIC" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "readOnly": true, - "type": "string" - }, - "averageLatency": { - "description": "Output only. Average latency (ms) over the last minute.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "errors": { - "description": "Output only. Number of errors since this instance was started.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "id": { - "description": "Output only. Relative name of the instance within the version. Example: instance-1.", - "readOnly": true, - "type": "string" - }, - "memoryUsage": { - "description": "Output only. Total memory in use (bytes).", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", - "readOnly": true, - "type": "string" - }, - "qps": { - "description": "Output only. Average queries per second (QPS) over the last minute.", - "format": "float", - "readOnly": true, - "type": "number" - }, - "requests": { - "description": "Output only. Number of requests since this instance was started.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "startTime": { - "description": "Output only. Time that this instance was started.@OutputOnly", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "vmDebugEnabled": { - "description": "Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.", - "readOnly": true, - "type": "boolean" - }, - "vmId": { - "description": "Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.", - "readOnly": true, - "type": "string" - }, - "vmIp": { - "description": "Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment.", - "readOnly": true, - "type": "string" - }, - "vmLiveness": { - "description": "Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment.", - "enum": [ - "STATE_UNSPECIFIED", - "UNKNOWN", - "HEALTHY", - "UNHEALTHY", - "DRAINING", - "TIMEOUT" - ], - "enumDescriptions": [ - "There is no liveness health check for the instance. Only applicable for instances in App Engine standard environment.", - "The health checking system is aware of the instance but its health is not known at the moment.", - "The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.", - "The instance is reachable, but does not conform to the requirements defined by the health check.", - "The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.", - "The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout." - ], - "readOnly": true, - "type": "string" - }, - "vmName": { - "description": "Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.", - "readOnly": true, - "type": "string" - }, - "vmStatus": { - "description": "Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.", - "readOnly": true, - "type": "string" - }, - "vmZoneName": { - "description": "Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Library": { - "description": "Third-party Python runtime library that is required by the application.", - "id": "Library", - "properties": { - "name": { - "description": "Name of the library. Example: \"django\".", - "type": "string" - }, - "version": { - "description": "Version of the library to select, or \"latest\".", - "type": "string" - } - }, - "type": "object" - }, - "ListAuthorizedCertificatesResponse": { - "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.", - "id": "ListAuthorizedCertificatesResponse", - "properties": { - "certificates": { - "description": "The SSL certificates the user is authorized to administer.", - "items": { - "$ref": "AuthorizedCertificate" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "ListAuthorizedDomainsResponse": { - "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.", - "id": "ListAuthorizedDomainsResponse", - "properties": { - "domains": { - "description": "The authorized domains belonging to the user.", - "items": { - "$ref": "AuthorizedDomain" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "ListDomainMappingsResponse": { - "description": "Response message for DomainMappings.ListDomainMappings.", - "id": "ListDomainMappingsResponse", - "properties": { - "domainMappings": { - "description": "The domain mappings for the application.", - "items": { - "$ref": "DomainMapping" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "ListIngressRulesResponse": { - "description": "Response message for Firewall.ListIngressRules.", - "id": "ListIngressRulesResponse", - "properties": { - "ingressRules": { - "description": "The ingress FirewallRules for this application.", - "items": { - "$ref": "FirewallRule" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "ListInstancesResponse": { - "description": "Response message for Instances.ListInstances.", - "id": "ListInstancesResponse", - "properties": { - "instances": { - "description": "The instances belonging to the requested version.", - "items": { - "$ref": "Instance" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "type": "object" - }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "id": "ListLocationsResponse", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "items": { - "$ref": "Location" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "type": "object" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListServicesResponse": { - "description": "Response message for Services.ListServices.", - "id": "ListServicesResponse", - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "services": { - "description": "The services belonging to the requested application.", - "items": { - "$ref": "Service" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListVersionsResponse": { - "description": "Response message for Versions.ListVersions.", - "id": "ListVersionsResponse", - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "versions": { - "description": "The versions belonging to the requested service.", - "items": { - "$ref": "Version" - }, - "type": "array" - } - }, - "type": "object" - }, - "LivenessCheck": { - "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.", - "id": "LivenessCheck", - "properties": { - "checkInterval": { - "description": "Interval between health checks.", - "format": "google-duration", - "type": "string" - }, - "failureThreshold": { - "description": "Number of consecutive failed checks required before considering the VM unhealthy.", - "format": "uint32", - "type": "integer" - }, - "host": { - "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"", - "type": "string" - }, - "initialDelay": { - "description": "The initial delay before starting to execute the checks.", - "format": "google-duration", - "type": "string" - }, - "path": { - "description": "The request path.", - "type": "string" - }, - "successThreshold": { - "description": "Number of consecutive successful checks required before considering the VM healthy.", - "format": "uint32", - "type": "integer" - }, - "timeout": { - "description": "Time before the check is considered failed.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "Location": { - "description": "A resource that represents Google Cloud Platform location.", - "id": "Location", - "properties": { - "displayName": { - "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"} ", - "type": "object" - }, - "locationId": { - "description": "The canonical id for this location. For example: \"us-east1\".", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object" - }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", - "type": "string" - } - }, - "type": "object" - }, - "LocationMetadata": { - "description": "Metadata for the given google.cloud.location.Location.", - "id": "LocationMetadata", - "properties": { - "flexibleEnvironmentAvailable": { - "description": "App Engine flexible environment is available in the given location.@OutputOnly", - "type": "boolean" - }, - "standardEnvironmentAvailable": { - "description": "App Engine standard environment is available in the given location.@OutputOnly", - "type": "boolean" - } - }, - "type": "object" - }, - "ManagedCertificate": { - "description": "A certificate managed by App Engine.", - "id": "ManagedCertificate", - "properties": { - "lastRenewalTime": { - "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "status": { - "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly", - "enum": [ - "MANAGEMENT_STATUS_UNSPECIFIED", - "OK", - "PENDING", - "FAILED_RETRYING_NOT_VISIBLE", - "FAILED_PERMANENT", - "FAILED_RETRYING_CAA_FORBIDDEN", - "FAILED_RETRYING_CAA_CHECKING" - ], - "enumDescriptions": [ - "", - "Certificate was successfully obtained and inserted into the serving system.", - "Certificate is under active attempts to acquire or renew.", - "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.", - "All renewal attempts have been exhausted, likely due to an invalid DNS setup.", - "Most recent renewal failed due to an explicit CAA record that does not include one of the in-use CAs (Google CA and Let's Encrypt). Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.", - "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving." - ], - "type": "string" - } - }, - "type": "object" - }, - "ManualScaling": { - "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", - "id": "ManualScaling", - "properties": { - "instances": { - "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Network": { - "description": "Extra network settings. Only applicable in the App Engine flexible environment.", - "id": "Network", - "properties": { - "forwardedPorts": { - "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.", - "items": { - "type": "string" - }, - "type": "array" - }, - "instanceTag": { - "description": "Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.", - "type": "string" - }, - "name": { - "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.", - "type": "string" - }, - "sessionAffinity": { - "description": "Enable session affinity. Only applicable in the App Engine flexible environment.", - "type": "boolean" - }, - "subnetworkName": { - "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.", - "type": "string" - } - }, - "type": "object" - }, - "NetworkSettings": { - "description": "A NetworkSettings resource is a container for ingress settings for a version or service.", - "id": "NetworkSettings", - "properties": { - "ingressTrafficAllowed": { - "description": "The ingress settings for version or service.", - "enum": [ - "INGRESS_TRAFFIC_ALLOWED_UNSPECIFIED", - "INGRESS_TRAFFIC_ALLOWED_ALL", - "INGRESS_TRAFFIC_ALLOWED_INTERNAL_ONLY", - "INGRESS_TRAFFIC_ALLOWED_INTERNAL_AND_LB" - ], - "enumDescriptions": [ - "Unspecified", - "Allow HTTP traffic from public and private sources.", - "Allow HTTP traffic from only private VPC sources.", - "Allow HTTP traffic from private VPC sources and through load balancers." - ], - "type": "string" - } - }, - "type": "object" - }, - "NetworkUtilization": { - "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.", - "id": "NetworkUtilization", - "properties": { - "targetReceivedBytesPerSecond": { - "description": "Target bytes received per second.", - "format": "int32", - "type": "integer" - }, - "targetReceivedPacketsPerSecond": { - "description": "Target packets received per second.", - "format": "int32", - "type": "integer" - }, - "targetSentBytesPerSecond": { - "description": "Target bytes sent per second.", - "format": "int32", - "type": "integer" - }, - "targetSentPacketsPerSecond": { - "description": "Target packets sent per second.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.", - "type": "object" - } - }, - "type": "object" - }, - "OperationMetadataV1": { - "description": "Metadata for the given google.longrunning.Operation.", - "id": "OperationMetadataV1", - "properties": { - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "OperationMetadataV1Alpha": { - "description": "Metadata for the given google.longrunning.Operation.", - "id": "OperationMetadataV1Alpha", - "properties": { - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Alpha" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "OperationMetadataV1Beta": { - "description": "Metadata for the given google.longrunning.Operation.", - "id": "OperationMetadataV1Beta", - "properties": { - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Beta" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ReadinessCheck": { - "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.", - "id": "ReadinessCheck", - "properties": { - "appStartTimeout": { - "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.", - "format": "google-duration", - "type": "string" - }, - "checkInterval": { - "description": "Interval between health checks.", - "format": "google-duration", - "type": "string" - }, - "failureThreshold": { - "description": "Number of consecutive failed checks required before removing traffic.", - "format": "uint32", - "type": "integer" - }, - "host": { - "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"", - "type": "string" - }, - "path": { - "description": "The request path.", - "type": "string" - }, - "successThreshold": { - "description": "Number of consecutive successful checks required before receiving traffic.", - "format": "uint32", - "type": "integer" - }, - "timeout": { - "description": "Time before the check is considered failed.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "RepairApplicationRequest": { - "description": "Request message for 'Applications.RepairApplication'.", - "id": "RepairApplicationRequest", - "properties": {}, - "type": "object" - }, - "RequestUtilization": { - "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.", - "id": "RequestUtilization", - "properties": { - "targetConcurrentRequests": { - "description": "Target number of concurrent requests.", - "format": "int32", - "type": "integer" - }, - "targetRequestCountPerSecond": { - "description": "Target requests per second.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ResourceRecord": { - "description": "A DNS resource record.", - "id": "ResourceRecord", - "properties": { - "name": { - "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.", - "type": "string" - }, - "rrdata": { - "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).", - "type": "string" - }, - "type": { - "description": "Resource record type. Example: AAAA.", - "enum": [ - "A", - "AAAA", - "CNAME" - ], - "enumDescriptions": [ - "An A resource record. Data is an IPv4 address.", - "An AAAA resource record. Data is an IPv6 address.", - "A CNAME resource record. Data is a domain name to be aliased." - ], - "type": "string" - } - }, - "type": "object" - }, - "Resources": { - "description": "Machine resources for a version.", - "id": "Resources", - "properties": { - "cpu": { - "description": "Number of CPU cores needed.", - "format": "double", - "type": "number" - }, - "diskGb": { - "description": "Disk size (GB) needed.", - "format": "double", - "type": "number" - }, - "kmsKeyReference": { - "description": "The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk", - "type": "string" - }, - "memoryGb": { - "description": "Memory (GB) needed.", - "format": "double", - "type": "number" - }, - "volumes": { - "description": "User specified volumes.", - "items": { - "$ref": "Volume" - }, - "type": "array" - } - }, - "type": "object" - }, - "ScriptHandler": { - "description": "Executes a script to handle the request that matches the URL pattern.", - "id": "ScriptHandler", - "properties": { - "scriptPath": { - "description": "Path to the script from the application root directory.", - "type": "string" - } - }, - "type": "object" - }, - "Service": { - "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.", - "id": "Service", - "properties": { - "id": { - "description": "Relative name of the service within the application. Example: default.@OutputOnly", - "type": "string" - }, - "name": { - "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "networkSettings": { - "$ref": "NetworkSettings", - "description": "Ingress settings for this service. Will apply to all versions." - }, - "split": { - "$ref": "TrafficSplit", - "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service." - } - }, - "type": "object" - }, - "SslSettings": { - "description": "SSL configuration for a DomainMapping resource.", - "id": "SslSettings", - "properties": { - "certificateId": { - "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.", - "type": "string" - }, - "pendingManagedCertificateId": { - "description": "ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly", - "type": "string" - }, - "sslManagementType": { - "description": "SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.", - "enum": [ - "AUTOMATIC", - "MANUAL" - ], - "enumDescriptions": [ - "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.", - "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain." - ], - "type": "string" - } - }, - "type": "object" - }, - "StandardSchedulerSettings": { - "description": "Scheduler settings for standard environment.", - "id": "StandardSchedulerSettings", - "properties": { - "maxInstances": { - "description": "Maximum number of instances to run for this version. Set to zero to disable max_instances configuration.", - "format": "int32", - "type": "integer" - }, - "minInstances": { - "description": "Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.", - "format": "int32", - "type": "integer" - }, - "targetCpuUtilization": { - "description": "Target CPU utilization ratio to maintain when scaling.", - "format": "double", - "type": "number" - }, - "targetThroughputUtilization": { - "description": "Target throughput utilization ratio to maintain when scaling", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "StaticFilesHandler": { - "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.", - "id": "StaticFilesHandler", - "properties": { - "applicationReadable": { - "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", - "type": "boolean" - }, - "expiration": { - "description": "Time a static file served by this handler should be cached by web proxies and browsers.", - "format": "google-duration", - "type": "string" - }, - "httpHeaders": { - "additionalProperties": { - "type": "string" - }, - "description": "HTTP headers to use for all responses from these URLs.", - "type": "object" - }, - "mimeType": { - "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.", - "type": "string" - }, - "path": { - "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.", - "type": "string" - }, - "requireMatchingFile": { - "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", - "type": "boolean" - }, - "uploadPathRegex": { - "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "TrafficSplit": { - "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.", - "id": "TrafficSplit", - "properties": { - "allocations": { - "additionalProperties": { - "format": "double", - "type": "number" - }, - "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.", - "type": "object" - }, - "shardBy": { - "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.", - "enum": [ - "UNSPECIFIED", - "COOKIE", - "IP", - "RANDOM" - ], - "enumDescriptions": [ - "Diversion method unspecified.", - "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.", - "Diversion based on applying the modulus operation to a fingerprint of the IP address.", - "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share." - ], - "type": "string" - } - }, - "type": "object" - }, - "UrlDispatchRule": { - "description": "Rules to match an HTTP request and dispatch that request to a service.", - "id": "UrlDispatchRule", - "properties": { - "domain": { - "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", - "type": "string" - }, - "path": { - "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.", - "type": "string" - }, - "service": { - "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.", - "type": "string" - } - }, - "type": "object" - }, - "UrlMap": { - "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", - "id": "UrlMap", - "properties": { - "apiEndpoint": { - "$ref": "ApiEndpointHandler", - "description": "Uses API Endpoints to handle requests." - }, - "authFailAction": { - "description": "Action to take when users access resources that require authentication. Defaults to redirect.", - "enum": [ - "AUTH_FAIL_ACTION_UNSPECIFIED", - "AUTH_FAIL_ACTION_REDIRECT", - "AUTH_FAIL_ACTION_UNAUTHORIZED" - ], - "enumDescriptions": [ - "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", - "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", - "Rejects request with a 401 HTTP status code and an error message." - ], - "type": "string" - }, - "login": { - "description": "Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.", - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" - ], - "enumDescriptions": [ - "Not specified. LOGIN_OPTIONAL is assumed.", - "Does not require that the user is signed in.", - "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", - "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." - ], - "type": "string" - }, - "redirectHttpResponseCode": { - "description": "30x code to use when performing redirects for the secure field. Defaults to 302.", - "enum": [ - "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", - "REDIRECT_HTTP_RESPONSE_CODE_301", - "REDIRECT_HTTP_RESPONSE_CODE_302", - "REDIRECT_HTTP_RESPONSE_CODE_303", - "REDIRECT_HTTP_RESPONSE_CODE_307" - ], - "enumDescriptions": [ - "Not specified. 302 is assumed.", - "301 Moved Permanently code.", - "302 Moved Temporarily code.", - "303 See Other code.", - "307 Temporary Redirect code." - ], - "type": "string" - }, - "script": { - "$ref": "ScriptHandler", - "description": "Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example \"script\": \"auto\"." - }, - "securityLevel": { - "description": "Security (HTTPS) enforcement for this URL.", - "enum": [ - "SECURE_UNSPECIFIED", - "SECURE_DEFAULT", - "SECURE_NEVER", - "SECURE_OPTIONAL", - "SECURE_ALWAYS" - ], - "enumDescriptions": [ - "Not specified.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", - "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", - "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." - ], - "type": "string" - }, - "staticFiles": { - "$ref": "StaticFilesHandler", - "description": "Returns the contents of a file, such as an image, as the response." - }, - "urlRegex": { - "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.", - "type": "string" - } - }, - "type": "object" - }, - "Version": { - "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.", - "id": "Version", - "properties": { - "apiConfig": { - "$ref": "ApiConfigHandler", - "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set." - }, - "automaticScaling": { - "$ref": "AutomaticScaling", - "description": "Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic." - }, - "basicScaling": { - "$ref": "BasicScaling", - "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity." - }, - "betaSettings": { - "additionalProperties": { - "type": "string" - }, - "description": "Metadata settings that are supplied to this version to enable beta runtime features.", - "type": "object" - }, - "buildEnvVariables": { - "additionalProperties": { - "type": "string" - }, - "description": "Environment variables available to the build environment.Only returned in GET requests if view=FULL is set.", - "type": "object" - }, - "createTime": { - "description": "Time that this version was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "createdBy": { - "description": "Email address of the user who created this version.@OutputOnly", - "type": "string" - }, - "defaultExpiration": { - "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.", - "format": "google-duration", - "type": "string" - }, - "deployment": { - "$ref": "Deployment", - "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." - }, - "diskUsageBytes": { - "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", - "format": "int64", - "type": "string" - }, - "endpointsApiService": { - "$ref": "EndpointsApiService", - "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app." - }, - "entrypoint": { - "$ref": "Entrypoint", - "description": "The entrypoint for the application." - }, - "env": { - "description": "App Engine execution environment for this version.Defaults to standard.", - "type": "string" - }, - "envVariables": { - "additionalProperties": { - "type": "string" - }, - "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.", - "type": "object" - }, - "errorHandlers": { - "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.", - "items": { - "$ref": "ErrorHandler" - }, - "type": "array" - }, - "handlers": { - "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.", - "items": { - "$ref": "UrlMap" - }, - "type": "array" - }, - "healthCheck": { - "$ref": "HealthCheck", - "description": "Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set." - }, - "id": { - "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".", - "type": "string" - }, - "inboundServices": { - "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.", - "items": { - "enum": [ - "INBOUND_SERVICE_UNSPECIFIED", - "INBOUND_SERVICE_MAIL", - "INBOUND_SERVICE_MAIL_BOUNCE", - "INBOUND_SERVICE_XMPP_ERROR", - "INBOUND_SERVICE_XMPP_MESSAGE", - "INBOUND_SERVICE_XMPP_SUBSCRIBE", - "INBOUND_SERVICE_XMPP_PRESENCE", - "INBOUND_SERVICE_CHANNEL_PRESENCE", - "INBOUND_SERVICE_WARMUP" - ], - "enumDescriptions": [ - "Not specified.", - "Allows an application to receive mail.", - "Allows an application to receive email-bound notifications.", - "Allows an application to receive error stanzas.", - "Allows an application to receive instant messages.", - "Allows an application to receive user subscription POSTs.", - "Allows an application to receive a user's chat presence.", - "Registers an application for notifications when a client connects or disconnects from a channel.", - "Enables warmup requests." - ], - "type": "string" - }, - "type": "array" - }, - "instanceClass": { - "description": "Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.", - "type": "string" - }, - "libraries": { - "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.", - "items": { - "$ref": "Library" - }, - "type": "array" - }, - "livenessCheck": { - "$ref": "LivenessCheck", - "description": "Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set." - }, - "manualScaling": { - "$ref": "ManualScaling", - "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as \"backends\"." - }, - "name": { - "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", - "type": "string" - }, - "network": { - "$ref": "Network", - "description": "Extra network settings. Only applicable in the App Engine flexible environment." - }, - "nobuildFilesRegex": { - "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.", - "type": "string" - }, - "readinessCheck": { - "$ref": "ReadinessCheck", - "description": "Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set." - }, - "resources": { - "$ref": "Resources", - "description": "Machine resources for this version. Only applicable in the App Engine flexible environment." - }, - "runtime": { - "description": "Desired runtime. Example: python27.", - "type": "string" - }, - "runtimeApiVersion": { - "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref", - "type": "string" - }, - "runtimeChannel": { - "description": "The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.", - "type": "string" - }, - "runtimeMainExecutablePath": { - "description": "The path or name of the app's main executable.", - "type": "string" - }, - "servingStatus": { - "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.", - "enum": [ - "SERVING_STATUS_UNSPECIFIED", - "SERVING", - "STOPPED" - ], - "enumDescriptions": [ - "Not specified.", - "Currently serving. Instances are created according to the scaling settings of the version.", - "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING." - ], - "type": "string" - }, - "threadsafe": { - "description": "Whether multiple requests can be dispatched to this version at once.", - "type": "boolean" - }, - "versionUrl": { - "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", - "type": "string" - }, - "vm": { - "description": "Whether to deploy this version in a container on a virtual machine.", - "type": "boolean" - }, - "vpcAccessConnector": { - "$ref": "VpcAccessConnector", - "description": "Enables VPC connectivity for standard apps." - }, - "zones": { - "description": "The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Volume": { - "description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.", - "id": "Volume", - "properties": { - "name": { - "description": "Unique name for the volume.", - "type": "string" - }, - "sizeGb": { - "description": "Volume size in gigabytes.", - "format": "double", - "type": "number" - }, - "volumeType": { - "description": "Underlying volume type, e.g. 'tmpfs'.", - "type": "string" - } - }, - "type": "object" - }, - "VpcAccessConnector": { - "description": "VPC access connector specification.", - "id": "VpcAccessConnector", - "properties": { - "name": { - "description": "Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.", - "type": "string" - } - }, - "type": "object" - }, - "ZipInfo": { - "description": "The zip file information for a zip deployment.", - "id": "ZipInfo", - "properties": { - "filesCount": { - "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.", - "format": "int32", - "type": "integer" - }, - "sourceUrl": { - "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "App Engine Admin API", - "version": "v1beta" -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/area120tables__v1alpha1.json b/discovery/googleapis_beta/area120tables__v1alpha1.json new file mode 100644 index 0000000..b969dc3 --- /dev/null +++ b/discovery/googleapis_beta/area120tables__v1alpha1.json
@@ -0,0 +1,890 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/drive": { + "description": "See, edit, create, and delete all of your Google Drive files" + }, + "https://www.googleapis.com/auth/drive.file": { + "description": "View and manage Google Drive files and folders that you have opened or created with this app" + }, + "https://www.googleapis.com/auth/drive.readonly": { + "description": "See and download all your Google Drive files" + }, + "https://www.googleapis.com/auth/spreadsheets": { + "description": "See, edit, create, and delete your spreadsheets in Google Drive" + }, + "https://www.googleapis.com/auth/spreadsheets.readonly": { + "description": "View your Google Spreadsheets" + }, + "https://www.googleapis.com/auth/tables": { + "description": "See, edit, create, and delete your tables in Tables by Area 120" + } + } + } + }, + "basePath": "", + "baseUrl": "https://area120tables.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Area120 Tables", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://support.google.com/area120-tables/answer/10011390", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "area120tables:v1alpha1", + "kind": "discovery#restDescription", + "name": "area120tables", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "tables": { + "methods": { + "get": { + "description": "Gets a table. Returns NOT_FOUND if the table does not exist.", + "httpMethod": "GET", + "id": "area120tables.tables.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the table to retrieve. Format: tables/{table}", + "location": "path", + "pattern": "^tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Table" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly", + "https://www.googleapis.com/auth/tables" + ] + }, + "list": { + "description": "Lists tables for the user.", + "httpMethod": "GET", + "id": "area120tables.tables.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/tables", + "response": { + "$ref": "ListTablesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly", + "https://www.googleapis.com/auth/tables" + ] + } + }, + "resources": { + "rows": { + "methods": { + "batchCreate": { + "description": "Creates multiple rows.", + "httpMethod": "POST", + "id": "area120tables.tables.rows.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent table where the rows will be created. Format: tables/{table}", + "location": "path", + "pattern": "^tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/rows:batchCreate", + "request": { + "$ref": "BatchCreateRowsRequest" + }, + "response": { + "$ref": "BatchCreateRowsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/tables" + ] + }, + "batchDelete": { + "description": "Deletes multiple rows.", + "httpMethod": "POST", + "id": "area120tables.tables.rows.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent table shared by all rows being deleted. Format: tables/{table}", + "location": "path", + "pattern": "^tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/rows:batchDelete", + "request": { + "$ref": "BatchDeleteRowsRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/tables" + ] + }, + "batchUpdate": { + "description": "Updates multiple rows.", + "httpMethod": "POST", + "id": "area120tables.tables.rows.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent table shared by all rows being updated. Format: tables/{table}", + "location": "path", + "pattern": "^tables/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/rows:batchUpdate", + "request": { + "$ref": "BatchUpdateRowsRequest" + }, + "response": { + "$ref": "BatchUpdateRowsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/tables" + ] + }, + "create": { + "description": "Creates a row.", + "httpMethod": "POST", + "id": "area120tables.tables.rows.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent table where this row will be created. Format: tables/{table}", + "location": "path", + "pattern": "^tables/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. Column key to use for values in the row. Defaults to user entered name.", + "enum": [ + "VIEW_UNSPECIFIED", + "COLUMN_ID_VIEW" + ], + "enumDescriptions": [ + "Defaults to user entered text.", + "Uses internally generated column id to identify values." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/rows", + "request": { + "$ref": "Row" + }, + "response": { + "$ref": "Row" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/tables" + ] + }, + "delete": { + "description": "Deletes a row.", + "httpMethod": "DELETE", + "id": "area120tables.tables.rows.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the row to delete. Format: tables/{table}/rows/{row}", + "location": "path", + "pattern": "^tables/[^/]+/rows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/tables" + ] + }, + "get": { + "description": "Gets a row. Returns NOT_FOUND if the row does not exist in the table.", + "httpMethod": "GET", + "id": "area120tables.tables.rows.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the row to retrieve. Format: tables/{table}/rows/{row}", + "location": "path", + "pattern": "^tables/[^/]+/rows/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. Column key to use for values in the row. Defaults to user entered name.", + "enum": [ + "VIEW_UNSPECIFIED", + "COLUMN_ID_VIEW" + ], + "enumDescriptions": [ + "Defaults to user entered text.", + "Uses internally generated column id to identify values." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Row" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly", + "https://www.googleapis.com/auth/tables" + ] + }, + "list": { + "description": "Lists rows in a table. Returns NOT_FOUND if the table does not exist.", + "httpMethod": "GET", + "id": "area120tables.tables.rows.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListRows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRows` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent table. Format: tables/{table}", + "location": "path", + "pattern": "^tables/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. Column key to use for values in the row. Defaults to user entered name.", + "enum": [ + "VIEW_UNSPECIFIED", + "COLUMN_ID_VIEW" + ], + "enumDescriptions": [ + "Defaults to user entered text.", + "Uses internally generated column id to identify values." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/rows", + "response": { + "$ref": "ListRowsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly", + "https://www.googleapis.com/auth/tables" + ] + }, + "patch": { + "description": "Updates a row.", + "httpMethod": "PATCH", + "id": "area120tables.tables.rows.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.", + "location": "path", + "pattern": "^tables/[^/]+/rows/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "view": { + "description": "Optional. Column key to use for values in the row. Defaults to user entered name.", + "enum": [ + "VIEW_UNSPECIFIED", + "COLUMN_ID_VIEW" + ], + "enumDescriptions": [ + "Defaults to user entered text.", + "Uses internally generated column id to identify values." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "Row" + }, + "response": { + "$ref": "Row" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/tables" + ] + } + } + } + } + }, + "workspaces": { + "methods": { + "get": { + "description": "Gets a workspace. Returns NOT_FOUND if the workspace does not exist.", + "httpMethod": "GET", + "id": "area120tables.workspaces.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the workspace to retrieve. Format: workspaces/{workspace}", + "location": "path", + "pattern": "^workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Workspace" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly", + "https://www.googleapis.com/auth/tables" + ] + }, + "list": { + "description": "Lists workspaces for the user.", + "httpMethod": "GET", + "id": "area120tables.workspaces.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "The maximum number of workspaces to return. The service may return fewer than this value. If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/workspaces", + "response": { + "$ref": "ListWorkspacesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly", + "https://www.googleapis.com/auth/tables" + ] + } + } + } + }, + "revision": "20210203", + "rootUrl": "https://area120tables.googleapis.com/", + "schemas": { + "BatchCreateRowsRequest": { + "description": "Request message for TablesService.BatchCreateRows.", + "id": "BatchCreateRowsRequest", + "properties": { + "requests": { + "description": "Required. The request message specifying the rows to create. A maximum of 500 rows can be created in a single batch.", + "items": { + "$ref": "CreateRowRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchCreateRowsResponse": { + "description": "Response message for TablesService.BatchCreateRows.", + "id": "BatchCreateRowsResponse", + "properties": { + "rows": { + "description": "The created rows.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchDeleteRowsRequest": { + "description": "Request message for TablesService.BatchDeleteRows", + "id": "BatchDeleteRowsRequest", + "properties": { + "names": { + "description": "Required. The names of the rows to delete. All rows must belong to the parent table or else the entire batch will fail. A maximum of 500 rows can be deleted in a batch. Format: tables/{table}/rows/{row}", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchUpdateRowsRequest": { + "description": "Request message for TablesService.BatchUpdateRows.", + "id": "BatchUpdateRowsRequest", + "properties": { + "requests": { + "description": "Required. The request messages specifying the rows to update. A maximum of 500 rows can be modified in a single batch.", + "items": { + "$ref": "UpdateRowRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchUpdateRowsResponse": { + "description": "Response message for TablesService.BatchUpdateRows.", + "id": "BatchUpdateRowsResponse", + "properties": { + "rows": { + "description": "The updated rows.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "ColumnDescription": { + "description": "Details on a column in the table.", + "id": "ColumnDescription", + "properties": { + "dataType": { + "description": "Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website.", + "type": "string" + }, + "id": { + "description": "Internal id for a column.", + "type": "string" + }, + "labels": { + "description": "Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation.", + "items": { + "$ref": "LabeledItem" + }, + "type": "array" + }, + "lookupDetails": { + "$ref": "LookupDetails", + "description": "Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column." + }, + "name": { + "description": "column name", + "type": "string" + }, + "relationshipDetails": { + "$ref": "RelationshipDetails", + "description": "Optional. Additional details about a relationship column. Specified when data_type is relationship." + } + }, + "type": "object" + }, + "CreateRowRequest": { + "description": "Request message for TablesService.CreateRow.", + "id": "CreateRowRequest", + "properties": { + "parent": { + "description": "Required. The parent table where this row will be created. Format: tables/{table}", + "type": "string" + }, + "row": { + "$ref": "Row", + "description": "Required. The row to create." + }, + "view": { + "description": "Optional. Column key to use for values in the row. Defaults to user entered name.", + "enum": [ + "VIEW_UNSPECIFIED", + "COLUMN_ID_VIEW" + ], + "enumDescriptions": [ + "Defaults to user entered text.", + "Uses internally generated column id to identify values." + ], + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "LabeledItem": { + "description": "A single item in a labeled column.", + "id": "LabeledItem", + "properties": { + "id": { + "description": "Internal id associated with the item.", + "type": "string" + }, + "name": { + "description": "Display string as entered by user.", + "type": "string" + } + }, + "type": "object" + }, + "ListRowsResponse": { + "description": "Response message for TablesService.ListRows.", + "id": "ListRowsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", + "type": "string" + }, + "rows": { + "description": "The rows from the specified table.", + "items": { + "$ref": "Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListTablesResponse": { + "description": "Response message for TablesService.ListTables.", + "id": "ListTablesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", + "type": "string" + }, + "tables": { + "description": "The list of tables.", + "items": { + "$ref": "Table" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListWorkspacesResponse": { + "description": "Response message for TablesService.ListWorkspaces.", + "id": "ListWorkspacesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", + "type": "string" + }, + "workspaces": { + "description": "The list of workspaces.", + "items": { + "$ref": "Workspace" + }, + "type": "array" + } + }, + "type": "object" + }, + "LookupDetails": { + "description": "Details about a lookup column whose value comes from the associated relationship.", + "id": "LookupDetails", + "properties": { + "relationshipColumn": { + "description": "The name of the relationship column associated with the lookup.", + "type": "string" + }, + "relationshipColumnId": { + "description": "The id of the relationship column.", + "type": "string" + } + }, + "type": "object" + }, + "RelationshipDetails": { + "description": "Details about a relationship column.", + "id": "RelationshipDetails", + "properties": { + "linkedTable": { + "description": "The name of the table this relationship is linked to.", + "type": "string" + } + }, + "type": "object" + }, + "Row": { + "description": "A single row in a table.", + "id": "Row", + "properties": { + "name": { + "description": "The resource name of the row. Row names have the form `tables/{table}/rows/{row}`. The name is ignored when creating a row.", + "type": "string" + }, + "values": { + "additionalProperties": { + "type": "any" + }, + "description": "The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.", + "type": "object" + } + }, + "type": "object" + }, + "Table": { + "description": "A single table.", + "id": "Table", + "properties": { + "columns": { + "description": "List of columns in this table. Order of columns matches the display order.", + "items": { + "$ref": "ColumnDescription" + }, + "type": "array" + }, + "displayName": { + "description": "The human readable title of the table.", + "type": "string" + }, + "name": { + "description": "The resource name of the table. Table names have the form `tables/{table}`.", + "type": "string" + } + }, + "type": "object" + }, + "UpdateRowRequest": { + "description": "Request message for TablesService.UpdateRow.", + "id": "UpdateRowRequest", + "properties": { + "row": { + "$ref": "Row", + "description": "Required. The row to update." + }, + "updateMask": { + "description": "The list of fields to update.", + "format": "google-fieldmask", + "type": "string" + }, + "view": { + "description": "Optional. Column key to use for values in the row. Defaults to user entered name.", + "enum": [ + "VIEW_UNSPECIFIED", + "COLUMN_ID_VIEW" + ], + "enumDescriptions": [ + "Defaults to user entered text.", + "Uses internally generated column id to identify values." + ], + "type": "string" + } + }, + "type": "object" + }, + "Workspace": { + "description": "A single workspace.", + "id": "Workspace", + "properties": { + "displayName": { + "description": "The human readable title of the workspace.", + "type": "string" + }, + "name": { + "description": "The resource name of the workspace. Workspace names have the form `workspaces/{workspace}`.", + "type": "string" + }, + "tables": { + "description": "The list of tables in the workspace.", + "items": { + "$ref": "Table" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Area120 Tables API", + "version": "v1alpha1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/artifactregistry__v1beta1.json b/discovery/googleapis_beta/artifactregistry__v1beta1.json deleted file mode 100644 index 58883ac..0000000 --- a/discovery/googleapis_beta/artifactregistry__v1beta1.json +++ /dev/null
@@ -1,1552 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://artifactregistry.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Artifact Registry", - "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/artifacts/docs/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "artifactregistry:v1beta1", - "kind": "discovery#restDescription", - "name": "artifactregistry", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "locations": { - "methods": { - "get": { - "description": "Gets information about a location.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name for the location.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Location" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists information about the supported locations for this service.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The resource that owns the locations collection, if applicable.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}/locations", - "response": { - "$ref": "ListLocationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - }, - "resources": { - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - }, - "repositories": { - "methods": { - "create": { - "description": "Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.", - "httpMethod": "POST", - "id": "artifactregistry.projects.locations.repositories.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The name of the parent resource where the repository will be created.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "repositoryId": { - "description": "The repository id to use for this repository.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/repositories", - "request": { - "$ref": "Repository" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.", - "httpMethod": "DELETE", - "id": "artifactregistry.projects.locations.repositories.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the repository to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a repository.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the repository to retrieve.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Repository" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "getIamPolicy": { - "description": "Gets the IAM policy for a given resource.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists repositories.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of repositories to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The name of the parent resource whose repositories will be listed.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/repositories", - "response": { - "$ref": "ListRepositoriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates a repository.", - "httpMethod": "PATCH", - "id": "artifactregistry.projects.locations.repositories.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the repository, for example: \"projects/p1/locations/us-central1/repositories/repo1\".", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Repository" - }, - "response": { - "$ref": "Repository" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Updates the IAM policy for a given resource.", - "httpMethod": "POST", - "id": "artifactregistry.projects.locations.repositories.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Tests if the caller has a list of permissions on a resource.", - "httpMethod": "POST", - "id": "artifactregistry.projects.locations.repositories.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - }, - "resources": { - "files": { - "methods": { - "get": { - "description": "Gets a file.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.files.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the file to retrieve.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/files/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "File" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists files.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.files.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name=\"projects/p1/locations/us-central1/repositories/repo1/files/a/b/*\"` --> Files with an ID starting with \"a/b/\". * `owner=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Files owned by the version `1.0` in package `pkg1`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of files to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The name of the parent resource whose files will be listed.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/files", - "response": { - "$ref": "ListFilesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - }, - "packages": { - "methods": { - "delete": { - "description": "Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.", - "httpMethod": "DELETE", - "id": "artifactregistry.projects.locations.repositories.packages.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the package to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a package.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.packages.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the package to retrieve.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Package" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists packages.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.packages.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of packages to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The name of the parent resource whose packages will be listed.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/packages", - "response": { - "$ref": "ListPackagesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - }, - "resources": { - "tags": { - "methods": { - "create": { - "description": "Creates a tag.", - "httpMethod": "POST", - "id": "artifactregistry.projects.locations.repositories.packages.tags.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The name of the parent resource where the tag will be created.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", - "required": true, - "type": "string" - }, - "tagId": { - "description": "The tag id to use for this repository.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/tags", - "request": { - "$ref": "Tag" - }, - "response": { - "$ref": "Tag" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a tag.", - "httpMethod": "DELETE", - "id": "artifactregistry.projects.locations.repositories.packages.tags.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the tag to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/tags/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a tag.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.packages.tags.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the tag to retrieve.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/tags/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Tag" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists tags.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.packages.tags.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of tags to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The name of the parent resource whose tags will be listed.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/tags", - "response": { - "$ref": "ListTagsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates a tag.", - "httpMethod": "PATCH", - "id": "artifactregistry.projects.locations.repositories.packages.tags.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\".", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/tags/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Tag" - }, - "response": { - "$ref": "Tag" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "versions": { - "methods": { - "delete": { - "description": "Deletes a version and all of its content. The returned operation will complete once the version has been deleted.", - "httpMethod": "DELETE", - "id": "artifactregistry.projects.locations.repositories.packages.versions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "By default, a version that is tagged may not be deleted. If force=true, the version and any tags pointing to the version are deleted.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "The name of the version to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a version", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.packages.versions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the version to retrieve.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - }, - "view": { - "description": "The view that should be returned in the response.", - "enum": [ - "VERSION_VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Includes basic information about the version, but not any related tags.", - "Include everything." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Version" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists versions.", - "httpMethod": "GET", - "id": "artifactregistry.projects.locations.repositories.packages.versions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of versions to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The name of the parent resource whose versions will be listed.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+$", - "required": true, - "type": "string" - }, - "view": { - "description": "The view that should be returned in the response.", - "enum": [ - "VERSION_VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Includes basic information about the version, but not any related tags.", - "Include everything." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/versions", - "response": { - "$ref": "ListVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - } - } - } - } - } - } - } - } - } - }, - "revision": "20200918", - "rootUrl": "https://artifactregistry.googleapis.com/", - "schemas": { - "Binding": { - "description": "Associates `members` with a `role`.", - "id": "Binding", - "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, - "condition": { - "$ref": "Expr", - "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 members 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)." - }, - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", - "items": { - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Expr": { - "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() < 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", - "properties": { - "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" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "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" - }, - "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" - }, - "File": { - "description": "Files store content that is potentially associated with Packages or Versions.", - "id": "File", - "properties": { - "createTime": { - "description": "The time when the File was created.", - "format": "google-datetime", - "type": "string" - }, - "hashes": { - "description": "The hashes of the file content.", - "items": { - "$ref": "Hash" - }, - "type": "array" - }, - "name": { - "description": "The name of the file, for example: \"projects/p1/locations/us-central1/repositories/repo1/files/a/b/c.txt\".", - "type": "string" - }, - "owner": { - "description": "The name of the Package or Version that owns this file, if any.", - "type": "string" - }, - "sizeBytes": { - "description": "The size of the File in bytes.", - "format": "int64", - "type": "string" - }, - "updateTime": { - "description": "The time when the File was last updated.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleDevtoolsArtifactregistryV1alpha1ErrorInfo": { - "description": "Error information explaining why a package was not imported.", - "id": "GoogleDevtoolsArtifactregistryV1alpha1ErrorInfo", - "properties": { - "error": { - "$ref": "Status", - "description": "The detailed error status." - }, - "gcsSource": { - "$ref": "GoogleDevtoolsArtifactregistryV1alpha1GcsSource", - "description": "Google Cloud Storage location requested." - } - }, - "type": "object" - }, - "GoogleDevtoolsArtifactregistryV1alpha1GcsSource": { - "description": "Google Cloud Storage location for the input content.", - "id": "GoogleDevtoolsArtifactregistryV1alpha1GcsSource", - "properties": { - "uris": { - "description": "Cloud Storage paths URI (e.g., gs://my_bucket//my_object).", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleDevtoolsArtifactregistryV1alpha1ImportArtifactsResponse": { - "description": "The response message from importing artifacts.", - "id": "GoogleDevtoolsArtifactregistryV1alpha1ImportArtifactsResponse", - "properties": { - "errors": { - "description": "Detailed error info for packages that were not imported.", - "items": { - "$ref": "GoogleDevtoolsArtifactregistryV1alpha1ErrorInfo" - }, - "type": "array" - }, - "packages": { - "description": "The packages updated.", - "items": { - "$ref": "GoogleDevtoolsArtifactregistryV1alpha1Package" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleDevtoolsArtifactregistryV1alpha1Package": { - "description": "Packages are named collections of versions.", - "id": "GoogleDevtoolsArtifactregistryV1alpha1Package", - "properties": { - "createTime": { - "description": "The time when the package was created.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the package.", - "type": "string" - }, - "name": { - "description": "The name of the package, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1\".", - "type": "string" - }, - "updateTime": { - "description": "The time when the package was last updated. This includes publishing a new version of the package.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "Hash": { - "description": "A hash of file content.", - "id": "Hash", - "properties": { - "type": { - "description": "The algorithm used to compute the hash value.", - "enum": [ - "HASH_TYPE_UNSPECIFIED", - "SHA256" - ], - "enumDescriptions": [ - "Unspecified.", - "SHA256 hash." - ], - "type": "string" - }, - "value": { - "description": "The hash value.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "ListFilesResponse": { - "description": "The response from listing files.", - "id": "ListFilesResponse", - "properties": { - "files": { - "description": "The files returned.", - "items": { - "$ref": "File" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The token to retrieve the next page of files, or empty if there are no more files to return.", - "type": "string" - } - }, - "type": "object" - }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "id": "ListLocationsResponse", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "items": { - "$ref": "Location" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "type": "object" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListPackagesResponse": { - "description": "The response from listing packages.", - "id": "ListPackagesResponse", - "properties": { - "nextPageToken": { - "description": "The token to retrieve the next page of packages, or empty if there are no more packages to return.", - "type": "string" - }, - "packages": { - "description": "The packages returned.", - "items": { - "$ref": "Package" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListRepositoriesResponse": { - "description": "The response from listing repositories.", - "id": "ListRepositoriesResponse", - "properties": { - "nextPageToken": { - "description": "The token to retrieve the next page of repositories, or empty if there are no more repositories to return.", - "type": "string" - }, - "repositories": { - "description": "The repositories returned.", - "items": { - "$ref": "Repository" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListTagsResponse": { - "description": "The response from listing tags.", - "id": "ListTagsResponse", - "properties": { - "nextPageToken": { - "description": "The token to retrieve the next page of tags, or empty if there are no more tags to return.", - "type": "string" - }, - "tags": { - "description": "The tags returned.", - "items": { - "$ref": "Tag" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListVersionsResponse": { - "description": "The response from listing versions.", - "id": "ListVersionsResponse", - "properties": { - "nextPageToken": { - "description": "The token to retrieve the next page of versions, or empty if there are no more versions to return.", - "type": "string" - }, - "versions": { - "description": "The versions returned.", - "items": { - "$ref": "Version" - }, - "type": "array" - } - }, - "type": "object" - }, - "Location": { - "description": "A resource that represents Google Cloud Platform location.", - "id": "Location", - "properties": { - "displayName": { - "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object" - }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", - "type": "string" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "Package": { - "description": "Packages are named collections of versions.", - "id": "Package", - "properties": { - "createTime": { - "description": "The time when the package was created.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the package.", - "type": "string" - }, - "name": { - "description": "The name of the package, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1\".", - "type": "string" - }, - "updateTime": { - "description": "The time when the package was last updated. This includes publishing a new version of the package.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "Policy": { - "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` to a single `role`. Members 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 < 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 < 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/).", - "id": "Policy", - "properties": { - "bindings": { - "description": "Associates a list of `members` to 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 member.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "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" - }, - "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).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Repository": { - "description": "A Repository for storing artifacts with a specific format.", - "id": "Repository", - "properties": { - "createTime": { - "description": "The time when the repository was created.", - "format": "google-datetime", - "type": "string" - }, - "description": { - "description": "The user-provided description of the repository.", - "type": "string" - }, - "format": { - "description": "The format of packages that are stored in the repository.", - "enum": [ - "FORMAT_UNSPECIFIED", - "DOCKER", - "MAVEN", - "NPM", - "APT" - ], - "enumDescriptions": [ - "Unspecified package format.", - "Docker package format.", - "Maven package format.", - "NPM package format.", - "APT package format." - ], - "type": "string" - }, - "kmsKeyName": { - "description": "The Cloud KMS resource name of the customer managed encryption key that’s used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes.", - "type": "object" - }, - "name": { - "description": "The name of the repository, for example: \"projects/p1/locations/us-central1/repositories/repo1\".", - "type": "string" - }, - "updateTime": { - "description": "The time when the repository was last updated.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "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 Cloud Platform services (such as Projects) might reject them." - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "Tag": { - "description": "Tags point to a version and represent an alternative name that can be used to access the version.", - "id": "Tag", - "properties": { - "name": { - "description": "The name of the tag, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1\".", - "type": "string" - }, - "version": { - "description": "The name of the version the tag refers to, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811\"", - "type": "string" - } - }, - "type": "object" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "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": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Version": { - "description": "The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes.", - "id": "Version", - "properties": { - "createTime": { - "description": "The time when the version was created.", - "format": "google-datetime", - "type": "string" - }, - "description": { - "description": "Optional. Description of the version, as specified in its metadata.", - "type": "string" - }, - "name": { - "description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\".", - "type": "string" - }, - "relatedTags": { - "description": "Output only. A list of related tags. Will contain up to 100 tags that reference this version.", - "items": { - "$ref": "Tag" - }, - "type": "array" - }, - "updateTime": { - "description": "The time when the version was last updated.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Artifact Registry API", - "version": "v1beta1", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/bigqueryconnection__v1beta1.json b/discovery/googleapis_beta/bigqueryconnection__v1beta1.json index 0edd0b8..2a59346 100644 --- a/discovery/googleapis_beta/bigqueryconnection__v1beta1.json +++ b/discovery/googleapis_beta/bigqueryconnection__v1beta1.json
@@ -384,7 +384,7 @@ } } }, - "revision": "20200930", + "revision": "20210121", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": {
diff --git a/discovery/googleapis_beta/clouderrorreporting__v1beta1.json b/discovery/googleapis_beta/clouderrorreporting__v1beta1.json index 7a5909e..2e42678 100644 --- a/discovery/googleapis_beta/clouderrorreporting__v1beta1.json +++ b/discovery/googleapis_beta/clouderrorreporting__v1beta1.json
@@ -423,7 +423,7 @@ } } }, - "revision": "20200923", + "revision": "20210121", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": {
diff --git a/discovery/googleapis_beta/cloudresourcemanager__v1beta1.json b/discovery/googleapis_beta/cloudresourcemanager__v1beta1.json deleted file mode 100644 index e830e0d..0000000 --- a/discovery/googleapis_beta/cloudresourcemanager__v1beta1.json +++ /dev/null
@@ -1,1040 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://cloudresourcemanager.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud Resource Manager", - "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/resource-manager", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "cloudresourcemanager:v1beta1", - "kind": "discovery#restDescription", - "name": "cloudresourcemanager", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "organizations": { - "methods": { - "get": { - "description": "Fetches an Organization resource identified by the specified resource name.", - "httpMethod": "GET", - "id": "cloudresourcemanager.organizations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as \"organizations/[organizationId]\". For example, \"organizations/1234\".", - "location": "path", - "pattern": "^organizations/[^/]+$", - "required": true, - "type": "string" - }, - "organizationId": { - "description": "The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Organization" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The `resource` field should be the organization's resource name, e.g. \"organizations/123\".", - "httpMethod": "POST", - "id": "cloudresourcemanager.organizations.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^organizations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.", - "httpMethod": "GET", - "id": "cloudresourcemanager.organizations.list", - "parameterOrder": [], - "parameters": { - "filter": { - "description": "An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive. Organizations may be filtered by `owner.directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Filter `owner.directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Filter `domain:google.com` returns Organization resources corresponding to the domain `google.com`. This field is optional.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Organizations to return in the response. This field is optional.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A pagination token returned from a previous call to `ListOrganizations` that indicates from where listing should continue. This field is optional.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/organizations", - "response": { - "$ref": "ListOrganizationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on an Organization resource. Replaces any existing policy. The `resource` field should be the organization's resource name, e.g. \"organizations/123\".", - "httpMethod": "POST", - "id": "cloudresourcemanager.organizations.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^organizations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified Organization. The `resource` field should be the organization's resource name, e.g. \"organizations/123\".", - "httpMethod": "POST", - "id": "cloudresourcemanager.organizations.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^organizations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "update": { - "description": "Updates an Organization resource identified by the specified resource name.", - "httpMethod": "PUT", - "id": "cloudresourcemanager.organizations.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is \"organizations/[organization_id]\". For example, \"organizations/1234\".", - "location": "path", - "pattern": "^organizations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Organization" - }, - "response": { - "$ref": "Organization" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "projects": { - "methods": { - "create": { - "description": "Creates a Project resource. Initially, the Project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the Project. Several APIs are activated automatically for the Project, including Google Cloud Storage. The parent is identified by a specified ResourceId, which must include both an ID and a type, such as project, folder, or organization. This method does not associate the new project with a billing account. You can set or update the billing account associated with a project using the [`projects.updateBillingInfo`] (/billing/reference/rest/v1/projects/updateBillingInfo) method.", - "httpMethod": "POST", - "id": "cloudresourcemanager.projects.create", - "parameterOrder": [], - "parameters": { - "useLegacyStack": { - "description": "A now unused experiment opt-out option.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/projects", - "request": { - "$ref": "Project" - }, - "response": { - "$ref": "Project" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Marks the Project identified by the specified `project_id` (for example, `my-project-123`) for deletion. This method will only affect the Project if it has a lifecycle state of ACTIVE. This method changes the Project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the project is no longer accessible. Until the deletion completes, you can check the lifecycle state checked by retrieving the Project with GetProject, and the Project remains visible to ListProjects. However, you cannot update the project. After the deletion completes, the Project is not retrievable by the GetProject and ListProjects methods. The caller must have delete permissions for this Project.", - "httpMethod": "DELETE", - "id": "cloudresourcemanager.projects.delete", - "parameterOrder": [ - "projectId" - ], - "parameters": { - "projectId": { - "description": "The Project ID (for example, `foo-bar-123`).", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{projectId}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Retrieves the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.", - "httpMethod": "GET", - "id": "cloudresourcemanager.projects.get", - "parameterOrder": [ - "projectId" - ], - "parameters": { - "projectId": { - "description": "Required. The Project ID (for example, `my-project-123`).", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{projectId}", - "response": { - "$ref": "Project" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "getAncestry": { - "description": "Gets a list of ancestors in the resource hierarchy for the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this Project.", - "httpMethod": "POST", - "id": "cloudresourcemanager.projects.getAncestry", - "parameterOrder": [ - "projectId" - ], - "parameters": { - "projectId": { - "description": "Required. The Project ID (for example, `my-project-123`).", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{projectId}:getAncestry", - "request": { - "$ref": "GetAncestryRequest" - }, - "response": { - "$ref": "GetAncestryResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "getIamPolicy": { - "description": "Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist. For additional information about resource structure and identification, see [Resource Names](/apis/design/resource_names).", - "httpMethod": "POST", - "id": "cloudresourcemanager.projects.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists Projects that the caller has the `resourcemanager.projects.get` permission on and satisfy the specified filter. This method returns Projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. NOTE: If the request filter contains a `parent.type` and `parent.id` and the caller has the `resourcemanager.projects.list` permission on the parent, the results will be drawn from an alternate index which provides more consistent results. In future versions of this API, this List method will be split into List and Search to properly capture the behavioral difference.", - "httpMethod": "GET", - "id": "cloudresourcemanager.projects.list", - "parameterOrder": [], - "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. If multiple fields are included in a filter query, the query will return results that match any of the fields. Some eligible fields for filtering are: + `name` + `id` + `labels.` (where *key* is the name of a label) + `parent.type` + `parent.id` Some examples of using labels as filters: | Filter | Description | |------------------|-----------------------------------------------------| | name:how* | The project's name starts with \"how\". | | name:Howl | The project's name is `Howl` or `howl`. | | name:HOWL | Equivalent to above. | | NAME:howl | Equivalent to above. | | labels.color:* | The project has the label `color`. | | labels.color:red | The project's label `color` has the value `red`. | | labels.color:red labels.size:big |The project's label `color` has the value `red` and its label `size` has the value `big`. | If no filter is specified, the call will return projects for which the user has the `resourcemanager.projects.get` permission. NOTE: To perform a by-parent query (eg., what projects are directly in a Folder), the caller must have the `resourcemanager.projects.list` permission on the parent and the filter must contain both a `parent.type` and a `parent.id` restriction (example: \"parent.type:folder parent.id:123\"). In this case an alternate search index is used which provides more consistent results. Optional.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Projects to return in the response. The server can return fewer Projects than requested. If unspecified, server picks an appropriate default. Optional.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A pagination token returned from a previous call to ListProjects that indicates from where listing should continue. Optional.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/projects", - "response": { - "$ref": "ListProjectsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "setIamPolicy": { - "description": "Sets the IAM access control policy for the specified Project. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. NOTE: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited via Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + Membership changes that leave the project without any owners that have accepted the Terms of Service (ToS) will be rejected. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. Authorization requires the Google IAM permission `resourcemanager.projects.setIamPolicy` on the project", - "httpMethod": "POST", - "id": "cloudresourcemanager.projects.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified Project.", - "httpMethod": "POST", - "id": "cloudresourcemanager.projects.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "undelete": { - "description": "Restores the Project identified by the specified `project_id` (for example, `my-project-123`). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored. The caller must have undelete permissions for this Project.", - "httpMethod": "POST", - "id": "cloudresourcemanager.projects.undelete", - "parameterOrder": [ - "projectId" - ], - "parameters": { - "projectId": { - "description": "Required. The project ID (for example, `foo-bar-123`).", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{projectId}:undelete", - "request": { - "$ref": "UndeleteProjectRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "update": { - "description": "Updates the attributes of the Project identified by the specified `project_id` (for example, `my-project-123`). The caller must have modify permissions for this Project.", - "httpMethod": "PUT", - "id": "cloudresourcemanager.projects.update", - "parameterOrder": [ - "projectId" - ], - "parameters": { - "projectId": { - "description": "The project ID (for example, `my-project-123`).", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{projectId}", - "request": { - "$ref": "Project" - }, - "response": { - "$ref": "Project" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - }, - "revision": "20201005", - "rootUrl": "https://cloudresourcemanager.googleapis.com/", - "schemas": { - "Ancestor": { - "description": "Identifying information for a single ancestor of a project.", - "id": "Ancestor", - "properties": { - "resourceId": { - "$ref": "ResourceId", - "description": "Resource id of the ancestor." - } - }, - "type": "object" - }, - "AuditConfig": { - "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.", - "id": "AuditConfig", - "properties": { - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.", - "items": { - "$ref": "AuditLogConfig" - }, - "type": "array" - }, - "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" - }, - "AuditLogConfig": { - "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.", - "id": "AuditLogConfig", - "properties": { - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", - "items": { - "type": "string" - }, - "type": "array" - }, - "logType": { - "description": "The log type that this config enables.", - "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" - ], - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], - "type": "string" - } - }, - "type": "object" - }, - "Binding": { - "description": "Associates `members` with a `role`.", - "id": "Binding", - "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, - "condition": { - "$ref": "Expr", - "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 members 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)." - }, - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", - "items": { - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Expr": { - "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() < 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", - "properties": { - "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" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "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" - }, - "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" - }, - "FolderOperation": { - "description": "Metadata describing a long running folder operation", - "id": "FolderOperation", - "properties": { - "destinationParent": { - "description": "The resource name of the folder or organization we are either creating the folder under or moving the folder to.", - "type": "string" - }, - "displayName": { - "description": "The display name of the folder.", - "type": "string" - }, - "operationType": { - "description": "The type of this operation.", - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "CREATE", - "MOVE" - ], - "enumDescriptions": [ - "Operation type not specified.", - "A create folder operation.", - "A move folder operation." - ], - "type": "string" - }, - "sourceParent": { - "description": "The resource name of the folder's parent. Only applicable when the operation_type is MOVE.", - "type": "string" - } - }, - "type": "object" - }, - "FolderOperationError": { - "description": "A classification of the Folder Operation error.", - "id": "FolderOperationError", - "properties": { - "errorMessageId": { - "description": "The type of operation error experienced.", - "enum": [ - "ERROR_TYPE_UNSPECIFIED", - "ACTIVE_FOLDER_HEIGHT_VIOLATION", - "MAX_CHILD_FOLDERS_VIOLATION", - "FOLDER_NAME_UNIQUENESS_VIOLATION", - "RESOURCE_DELETED_VIOLATION", - "PARENT_DELETED_VIOLATION", - "CYCLE_INTRODUCED_VIOLATION", - "FOLDER_BEING_MOVED_VIOLATION", - "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION", - "DELETED_FOLDER_HEIGHT_VIOLATION" - ], - "enumDescriptions": [ - "The error type was unrecognized or unspecified.", - "The attempted action would violate the max folder depth constraint.", - "The attempted action would violate the max child folders constraint.", - "The attempted action would violate the locally-unique folder display_name constraint.", - "The resource being moved has been deleted.", - "The resource a folder was being added to has been deleted.", - "The attempted action would introduce cycle in resource path.", - "The attempted action would move a folder that is already being moved.", - "The folder the caller is trying to delete contains active resources.", - "The attempted action would violate the max deleted folder depth constraint." - ], - "type": "string" - } - }, - "type": "object" - }, - "GetAncestryRequest": { - "description": "The request sent to the [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetAncestry] method.", - "id": "GetAncestryRequest", - "properties": {}, - "type": "object" - }, - "GetAncestryResponse": { - "description": "Response from the projects.getAncestry method.", - "id": "GetAncestryResponse", - "properties": { - "ancestor": { - "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The first ancestor is the project itself, followed by the project's parent, etc.", - "items": { - "$ref": "Ancestor" - }, - "type": "array" - } - }, - "type": "object" - }, - "GetIamPolicyRequest": { - "description": "Request message for `GetIamPolicy` method.", - "id": "GetIamPolicyRequest", - "properties": { - "options": { - "$ref": "GetPolicyOptions", - "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`." - } - }, - "type": "object" - }, - "GetPolicyOptions": { - "description": "Encapsulates settings provided to GetIamPolicy.", - "id": "GetPolicyOptions", - "properties": { - "requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ListOrganizationsResponse": { - "description": "The response returned from the `ListOrganizations` method.", - "id": "ListOrganizationsResponse", - "properties": { - "nextPageToken": { - "description": "A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results.", - "type": "string" - }, - "organizations": { - "description": "The list of Organizations that matched the list query, possibly paginated.", - "items": { - "$ref": "Organization" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListProjectsResponse": { - "description": "A page of the response received from the ListProjects method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.", - "id": "ListProjectsResponse", - "properties": { - "nextPageToken": { - "description": "Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.", - "type": "string" - }, - "projects": { - "description": "The list of Projects that matched the list filter. This list can be paginated.", - "items": { - "$ref": "Project" - }, - "type": "array" - } - }, - "type": "object" - }, - "Organization": { - "description": "The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.", - "id": "Organization", - "properties": { - "creationTime": { - "description": "Timestamp when the Organization was created. Assigned by the server.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "A human-readable string that refers to the Organization in the GCP Console UI. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, \"google.com\") of the G Suite customer that owns the organization.", - "type": "string" - }, - "lifecycleState": { - "description": "The organization's current lifecycle state. Assigned by the server.", - "enum": [ - "LIFECYCLE_STATE_UNSPECIFIED", - "ACTIVE", - "DELETE_REQUESTED" - ], - "enumDescriptions": [ - "Unspecified state. This is only useful for distinguishing unset values.", - "The normal and active state.", - "The organization has been marked for deletion by the user." - ], - "type": "string" - }, - "name": { - "description": "Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is \"organizations/[organization_id]\". For example, \"organizations/1234\".", - "type": "string" - }, - "organizationId": { - "description": "An immutable id for the Organization that is assigned on creation. This should be omitted when creating a new Organization. This field is read-only.", - "type": "string" - }, - "owner": { - "$ref": "OrganizationOwner", - "description": "The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required." - } - }, - "type": "object" - }, - "OrganizationOwner": { - "description": "The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the `OrganizationOwner`. If the `OrganizationOwner` is deleted, the Organization and all its descendants will be deleted.", - "id": "OrganizationOwner", - "properties": { - "directoryCustomerId": { - "description": "The G Suite customer id used in the Directory API.", - "type": "string" - } - }, - "type": "object" - }, - "Policy": { - "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` to a single `role`. Members 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 < 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 < 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/).", - "id": "Policy", - "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "items": { - "$ref": "AuditConfig" - }, - "type": "array" - }, - "bindings": { - "description": "Associates a list of `members` to 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 member.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "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" - }, - "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).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Project": { - "description": "A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.", - "id": "Project", - "properties": { - "createTime": { - "description": "Creation time. Read-only.", - "format": "google-datetime", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The labels associated with this Project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z{0,62}. Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}. A label value can be empty. No more than 256 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `\"environment\" : \"dev\"` Read-write.", - "type": "object" - }, - "lifecycleState": { - "description": "The Project lifecycle state. Read-only.", - "enum": [ - "LIFECYCLE_STATE_UNSPECIFIED", - "ACTIVE", - "DELETE_REQUESTED", - "DELETE_IN_PROGRESS" - ], - "enumDescriptions": [ - "Unspecified state. This is only used/useful for distinguishing unset values.", - "The normal and active state.", - "The project has been marked for deletion by the user (by invoking DeleteProject) or by the system (Google Cloud Platform). This can generally be reversed by invoking UndeleteProject.", - "This lifecycle state is no longer used and is not returned by the API." - ], - "type": "string" - }, - "name": { - "description": "The optional user-assigned display name of the Project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` Read-write.", - "type": "string" - }, - "parent": { - "$ref": "ResourceId", - "description": "An optional reference to a parent Resource. Supported parent types include \"organization\" and \"folder\". Once set, the parent cannot be cleared. The `parent` can be set on creation or using the `UpdateProject` method; the end user must have the `resourcemanager.projects.create` permission on the parent. Read-write." - }, - "projectId": { - "description": "The unique, user-assigned ID of the Project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123` Read-only after creation.", - "type": "string" - }, - "projectNumber": { - "description": "The number uniquely identifying the project. Example: `415104041262` Read-only.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "ProjectCreationStatus": { - "description": "A status object which is used as the `metadata` field for the Operation returned by CreateProject. It provides insight for when significant phases of Project creation have completed.", - "id": "ProjectCreationStatus", - "properties": { - "createTime": { - "description": "Creation time of the project creation workflow.", - "format": "google-datetime", - "type": "string" - }, - "gettable": { - "description": "True if the project can be retrieved using GetProject. No other operations on the project are guaranteed to work until the project creation is complete.", - "type": "boolean" - }, - "ready": { - "description": "True if the project creation process is complete.", - "type": "boolean" - } - }, - "type": "object" - }, - "ResourceId": { - "description": "A container to reference an id for any resource type. A `resource` in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on.", - "id": "ResourceId", - "properties": { - "id": { - "description": "Required field for the type-specific id. This should correspond to the id used in the type-specific API's.", - "type": "string" - }, - "type": { - "description": "Required field representing the resource type this id is for. At present, the valid types are \"project\", \"folder\", and \"organization\".", - "type": "string" - } - }, - "type": "object" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "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 Cloud Platform services (such as Projects) might reject them." - }, - "updateMask": { - "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\"`", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "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": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "UndeleteProjectRequest": { - "description": "The request sent to the UndeleteProject method.", - "id": "UndeleteProjectRequest", - "properties": {}, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Resource Manager API", - "version": "v1beta1" -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/containeranalysis__v1beta1.json b/discovery/googleapis_beta/containeranalysis__v1beta1.json index 70c66a4..1e564ff 100644 --- a/discovery/googleapis_beta/containeranalysis__v1beta1.json +++ b/discovery/googleapis_beta/containeranalysis__v1beta1.json
@@ -827,7 +827,7 @@ } } }, - "revision": "20201002", + "revision": "20210129", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -950,7 +950,7 @@ "additionalProperties": { "$ref": "Note" }, - "description": "Required. The notes to create. Max allowed length is 1000.", + "description": "Required. The notes to create, the key is expected to be the note ID. Max allowed length is 1000.", "type": "object" } }, @@ -1002,10 +1002,6 @@ "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -1486,6 +1482,10 @@ "description": "The severity (eg: distro assigned severity) for this vulnerability.", "type": "string" }, + "source": { + "description": "The source from which the information in this Detail was obtained.", + "type": "string" + }, "sourceUpdateTime": { "description": "The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.", "format": "google-datetime", @@ -1573,7 +1573,7 @@ "INTOTO" ], "enumDescriptions": [ - "Unknown.", + "Default value. This value is unused.", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", @@ -2379,7 +2379,7 @@ "INTOTO" ], "enumDescriptions": [ - "Unknown.", + "Default value. This value is unused.", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", @@ -2484,7 +2484,7 @@ "INTOTO" ], "enumDescriptions": [ - "Unknown.", + "Default value. This value is unused.", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", @@ -2874,6 +2874,10 @@ "format": "int32", "type": "integer" }, + "inclusive": { + "description": "Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.", + "type": "boolean" + }, "kind": { "description": "Required. Distinguishes between sentinel MIN/MAX versions and normal versions.", "enum": [
diff --git a/discovery/googleapis_beta/datacatalog__v1beta1.json b/discovery/googleapis_beta/datacatalog__v1beta1.json index 8e16727..6aea6c6 100644 --- a/discovery/googleapis_beta/datacatalog__v1beta1.json +++ b/discovery/googleapis_beta/datacatalog__v1beta1.json
@@ -1751,17 +1751,13 @@ } } }, - "revision": "20201003", + "revision": "20210123", "rootUrl": "https://datacatalog.googleapis.com/", "schemas": { "Binding": { "description": "Associates `members` with a `role`.", "id": "Binding", "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, "condition": { "$ref": "Expr", "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 members 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)." @@ -1946,12 +1942,14 @@ "enum": [ "INTEGRATED_SYSTEM_UNSPECIFIED", "BIGQUERY", - "CLOUD_PUBSUB" + "CLOUD_PUBSUB", + "DPMS" ], "enumDescriptions": [ "Default unknown system.", "BigQuery.", - "Cloud Pub/Sub." + "Cloud Pub/Sub.", + "Dataproc Metastore - Managed Hive Metastore." ], "readOnly": true, "type": "string" @@ -2072,7 +2070,6 @@ "id": "GoogleCloudDatacatalogV1beta1FieldTypeEnumType", "properties": { "allowedValues": { - "description": "The set of allowed values for this enum. This set must not be empty, the display names of the values in this set must not be empty and the display names of the values must be case-insensitively unique within this set. The order of items in this list is preserved. This field can be used to Required on create; optional on update. The set of allowed values for this enum. This set must not be empty, the display names of the values in this set must not be empty and the display names of the values must be case-insensitively unique within this set. Currently, enum values can only be added to the list of allowed values. Deletion and renaming of enum values are not supported. Can have up to 500 allowed values.", "items": { "$ref": "GoogleCloudDatacatalogV1beta1FieldTypeEnumTypeEnumValue" }, @@ -2425,6 +2422,11 @@ "description": "The full name of the cloud resource the entry belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Example: * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId`", "type": "string" }, + "modifyTime": { + "description": "Last-modified timestamp of the entry from the managing system.", + "format": "google-datetime", + "type": "string" + }, "relativeResourceName": { "description": "The relative resource name of the resource in URL format. Examples: * `projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}` * `projects/{project_id}/tagTemplates/{tag_template_id}`", "type": "string" @@ -2482,6 +2484,21 @@ "description": "Message capturing a taxonomy and its policy tag hierarchy as a nested proto. Used for taxonomy import/export and mutation.", "id": "GoogleCloudDatacatalogV1beta1SerializedTaxonomy", "properties": { + "activatedPolicyTypes": { + "description": "A list of policy types that are activated for a taxonomy.", + "items": { + "enum": [ + "POLICY_TYPE_UNSPECIFIED", + "FINE_GRAINED_ACCESS_CONTROL" + ], + "enumDescriptions": [ + "Unspecified policy type.", + "Fine grained access control policy, which enables access control on tagged resources." + ], + "type": "string" + }, + "type": "array" + }, "description": { "description": "Description of the serialized taxonomy. The length of the description is limited to 2000 bytes when encoded in UTF-8. If not set, defaults to an empty description.", "type": "string" @@ -2643,6 +2660,10 @@ "description": "The template for an individual field within a tag template.", "id": "GoogleCloudDatacatalogV1beta1TagTemplateField", "properties": { + "description": { + "description": "The description for this field. Defaults to an empty string.", + "type": "string" + }, "displayName": { "description": "The display name for this field. Defaults to an empty string.", "type": "string" @@ -2699,6 +2720,17 @@ "description": "Output only. Resource name of this taxonomy, whose format is: \"projects/{project_number}/locations/{location_id}/taxonomies/{id}\".", "readOnly": true, "type": "string" + }, + "policyTagCount": { + "description": "Output only. Number of policy tags contained in this taxonomy.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "taxonomyTimestamps": { + "$ref": "GoogleCloudDatacatalogV1beta1SystemTimestamps", + "description": "Output only. Timestamps about this taxonomy. Only create_time and update_time are used.", + "readOnly": true } }, "type": "object"
diff --git a/discovery/googleapis_beta/dataflow__v1b3.json b/discovery/googleapis_beta/dataflow__v1b3.json index 9714ff6..314aa1e 100644 --- a/discovery/googleapis_beta/dataflow__v1b3.json +++ b/discovery/googleapis_beta/dataflow__v1b3.json
@@ -20,6 +20,7 @@ "basePath": "", "baseUrl": "https://dataflow.googleapis.com/", "batchPath": "batch", + "canonicalName": "Dataflow", "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataflow", @@ -402,7 +403,7 @@ "type": "string" }, "view": { - "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", + "description": "Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.", "enum": [ "JOB_VIEW_UNKNOWN", "JOB_VIEW_SUMMARY", @@ -633,7 +634,7 @@ "type": "string" }, "view": { - "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", + "description": "Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.", "enum": [ "JOB_VIEW_UNKNOWN", "JOB_VIEW_SUMMARY", @@ -1324,7 +1325,7 @@ "type": "string" }, "view": { - "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", + "description": "Deprecated. ListJobs always returns summaries now. Use GetJob for other JobViews.", "enum": [ "JOB_VIEW_UNKNOWN", "JOB_VIEW_SUMMARY", @@ -2392,7 +2393,7 @@ } } }, - "revision": "20201003", + "revision": "20210123", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -2730,6 +2731,10 @@ "description": "Container Spec.", "id": "ContainerSpec", "properties": { + "defaultEnvironment": { + "$ref": "FlexTemplateRuntimeEnvironment", + "description": "Default runtime environment for the job." + }, "image": { "description": "Name of the docker container image. E.g., gcr.io/project/some-image", "type": "string" @@ -3334,7 +3339,8 @@ "JOB_STATE_DRAINED", "JOB_STATE_PENDING", "JOB_STATE_CANCELLING", - "JOB_STATE_QUEUED" + "JOB_STATE_QUEUED", + "JOB_STATE_RESOURCE_CLEANING_UP" ], "enumDescriptions": [ "The job's run state isn't specified.", @@ -3348,7 +3354,8 @@ "`JOB_STATE_DRAINED` indicates that the job has been drained. A drained job terminated by stopping pulling from its input sources and processing any data that remained in-flight when draining was requested. This state is a terminal state, may only be set by the Cloud Dataflow service, and only as a transition from `JOB_STATE_DRAINING`.", "`JOB_STATE_PENDING` indicates that the job has been created but is not yet running. Jobs that are pending may only transition to `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.", "`JOB_STATE_CANCELLING` indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.", - "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`." + "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.", + "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are intersted." ], "type": "string" } @@ -3420,6 +3427,13 @@ "$ref": "StageSource" }, "type": "array" + }, + "prerequisiteStage": { + "description": "Other stages that must complete before this stage can run.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3482,6 +3496,20 @@ "description": "Whether to enable Streaming Engine for the job.", "type": "boolean" }, + "flexrsGoal": { + "description": "Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs", + "enum": [ + "FLEXRS_UNSPECIFIED", + "FLEXRS_SPEED_OPTIMIZED", + "FLEXRS_COST_OPTIMIZED" + ], + "enumDescriptions": [ + "Run in the default mode.", + "Optimize for lower execution time.", + "Optimize for lower cost." + ], + "type": "string" + }, "ipConfiguration": { "description": "Configuration for VM IPs.", "enum": [ @@ -3777,7 +3805,7 @@ "type": "object" }, "Job": { - "description": "Defines a job to be run by the Cloud Dataflow service.", + "description": "Defines a job to be run by the Cloud Dataflow service. nextID: 26", "id": "Job", "properties": { "clientRequestId": { @@ -3807,7 +3835,8 @@ "JOB_STATE_DRAINED", "JOB_STATE_PENDING", "JOB_STATE_CANCELLING", - "JOB_STATE_QUEUED" + "JOB_STATE_QUEUED", + "JOB_STATE_RESOURCE_CLEANING_UP" ], "enumDescriptions": [ "The job's run state isn't specified.", @@ -3821,7 +3850,8 @@ "`JOB_STATE_DRAINED` indicates that the job has been drained. A drained job terminated by stopping pulling from its input sources and processing any data that remained in-flight when draining was requested. This state is a terminal state, may only be set by the Cloud Dataflow service, and only as a transition from `JOB_STATE_DRAINING`.", "`JOB_STATE_PENDING` indicates that the job has been created but is not yet running. Jobs that are pending may only transition to `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.", "`JOB_STATE_CANCELLING` indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.", - "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`." + "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.", + "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are intersted." ], "type": "string" }, @@ -3891,7 +3921,8 @@ "JOB_STATE_DRAINED", "JOB_STATE_PENDING", "JOB_STATE_CANCELLING", - "JOB_STATE_QUEUED" + "JOB_STATE_QUEUED", + "JOB_STATE_RESOURCE_CLEANING_UP" ], "enumDescriptions": [ "The job's run state isn't specified.", @@ -3905,10 +3936,15 @@ "`JOB_STATE_DRAINED` indicates that the job has been drained. A drained job terminated by stopping pulling from its input sources and processing any data that remained in-flight when draining was requested. This state is a terminal state, may only be set by the Cloud Dataflow service, and only as a transition from `JOB_STATE_DRAINING`.", "`JOB_STATE_PENDING` indicates that the job has been created but is not yet running. Jobs that are pending may only transition to `JOB_STATE_RUNNING`, or `JOB_STATE_FAILED`.", "`JOB_STATE_CANCELLING` indicates that the job has been explicitly cancelled and is in the process of stopping. Jobs that are cancelling may only transition to `JOB_STATE_CANCELLED` or `JOB_STATE_FAILED`.", - "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`." + "`JOB_STATE_QUEUED` indicates that the job has been created but is being delayed until launch. Jobs that are queued may only transition to `JOB_STATE_PENDING` or `JOB_STATE_CANCELLED`.", + "`JOB_STATE_RESOURCE_CLEANING_UP` indicates that the batch job's associated resources are currently being cleaned up after a successful run. Currently, this is an opt-in feature, please reach out to Cloud support team if you are intersted." ], "type": "string" }, + "satisfiesPzs": { + "description": "Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.", + "type": "boolean" + }, "stageStates": { "description": "This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.", "items": { @@ -4184,7 +4220,7 @@ "description": "The runtime environment for the FlexTemplate job" }, "jobName": { - "description": "Required. The job name to use for the created job.", + "description": "Required. The job name to use for the created job. For update job request, job name should be same as the existing running job.", "type": "string" }, "launchOptions": { @@ -4200,6 +4236,17 @@ }, "description": "The parameters for FlexTemplate. Ex. {\"num_workers\":\"5\"}", "type": "object" + }, + "transformNameMappings": { + "additionalProperties": { + "type": "string" + }, + "description": "Use this to pass transform_name_mappings for streaming update jobs. Ex:{\"oldTransformName\":\"newTransformName\",...}'", + "type": "object" + }, + "update": { + "description": "Set this to true if you are sending a request to update a running streaming job. When set, the job name should be the same as the running job.", + "type": "boolean" } }, "type": "object"
diff --git a/discovery/googleapis_beta/datalabeling__v1beta1.json b/discovery/googleapis_beta/datalabeling__v1beta1.json new file mode 100644 index 0000000..15ded49 --- /dev/null +++ b/discovery/googleapis_beta/datalabeling__v1beta1.json
@@ -0,0 +1,5609 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://datalabeling.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Data Labeling", + "description": "Public API for Google Cloud AI Data Labeling Service.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/data-labeling/docs/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "datalabeling:v1beta1", + "kind": "discovery#restDescription", + "name": "datalabeling", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "annotationSpecSets": { + "methods": { + "create": { + "description": "Creates an annotation spec set by providing a set of labels.", + "httpMethod": "POST", + "id": "datalabeling.projects.annotationSpecSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. AnnotationSpecSet resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/annotationSpecSets", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an annotation spec set by resource name.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.annotationSpecSets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an annotation spec set by resource name.", + "httpMethod": "GET", + "id": "datalabeling.projects.annotationSpecSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", + "location": "path", + "pattern": "^projects/[^/]+/annotationSpecSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists annotation spec sets for a project. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.annotationSpecSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotationSpecSetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotationSpecSets] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/annotationSpecSets", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "datasets": { + "methods": { + "create": { + "description": "Creates dataset. If success return a Dataset resource.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Dataset resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasets", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a dataset by resource name.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "exportData": { + "description": "Exports data and annotations from dataset.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.exportData", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:exportData", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1ExportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets dataset by resource name.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "importData": { + "description": "Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.importData", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:importData", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1ImportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists datasets under a project. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter on dataset is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDatasetsResponse.next_page_token of the previous [DataLabelingService.ListDatasets] call. Returns the first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Dataset resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasets", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "annotatedDatasets": { + "methods": { + "delete": { + "description": "Deletes an annotated dataset by resource name.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.annotatedDatasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the annotated dataset to delete, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an annotated dataset by resource name.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists annotated datasets for a dataset. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListAnnotatedDatasetsResponse.next_page_token of the previous [DataLabelingService.ListAnnotatedDatasets] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/annotatedDatasets", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "dataItems": { + "methods": { + "get": { + "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1DataItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.dataItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dataItems", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "examples": { + "methods": { + "get": { + "description": "Gets an example by resource name, including both data and annotation.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.examples.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/examples/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Example" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists examples in an annotated dataset. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.examples.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format \"annotation_spec.display_name = {display_name}\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example resource parent.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/examples", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "feedbackThreads": { + "methods": { + "delete": { + "description": "Delete a FeedbackThread.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the FeedbackThread that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a FeedbackThread object.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List FeedbackThreads with pagination.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackThreads.next_page_token of the previous [DataLabelingService.ListFeedbackThreads] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. FeedbackThread resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/feedbackThreads", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "feedbackMessages": { + "methods": { + "create": { + "description": "Create a FeedbackMessage object.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. FeedbackMessage resource parent, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/feedbackMessages", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a FeedbackMessage.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the FeedbackMessage that is going to be deleted. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a FeedbackMessage object.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the feedback. Format: 'projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessages/{feedback_message_id}'.", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+/feedbackMessages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List FeedbackMessages with pagination.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListFeedbackMessages.next_page_token of the previous [DataLabelingService.ListFeedbackMessages] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. FeedbackMessage resource parent. Format: \"projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/annotatedDatasets/[^/]+/feedbackThreads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/feedbackMessages", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "dataItems": { + "methods": { + "get": { + "description": "Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.dataItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1DataItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.dataItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListDataItemsResponse.next_page_token of the previous [DataLabelingService.ListDataItems] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dataItems", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluations": { + "methods": { + "get": { + "description": "Gets an evaluation by resource name (to search, use projects.evaluations.search).", + "httpMethod": "GET", + "id": "datalabeling.projects.datasets.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation. Format: \"projects/{project_id}/datasets/ {dataset_id}/evaluations/{evaluation_id}'", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "exampleComparisons": { + "methods": { + "search": { + "description": "Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.evaluations.exampleComparisons.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the Evaluation resource to search for example comparisons from. Format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/exampleComparisons:search", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "image": { + "methods": { + "label": { + "description": "Starts a labeling task for image. The type of image labeling task is configured by feature in the request.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.image.label", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/image:label", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "text": { + "methods": { + "label": { + "description": "Starts a labeling task for text. The type of text labeling task is configured by feature in the request.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.text.label", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/text:label", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelTextRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "video": { + "methods": { + "label": { + "description": "Starts a labeling task for video. The type of video labeling task is configured by feature in the request.", + "httpMethod": "POST", + "id": "datalabeling.projects.datasets.video.label", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}", + "location": "path", + "pattern": "^projects/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/video:label", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationJobs": { + "methods": { + "create": { + "description": "Creates an evaluation job.", + "httpMethod": "POST", + "id": "datalabeling.projects.evaluationJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationJobs", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Stops and deletes an evaluation job.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.evaluationJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job that is going to be deleted. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an evaluation job by resource name.", + "httpMethod": "GET", + "id": "datalabeling.projects.evaluationJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job. Format: \"projects/{project_id} /evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all evaluation jobs within a project with possible filters. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.evaluationJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the `AND` operator or the `OR` operator. For example, you can use the following string for your filter: \"evaluation_job.model_id = {model_name} AND evaluation_job.state = {evaluation_job_state}\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Evaluation job resource parent. Format: \"projects/{project_id}\"", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationJobs", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: `humanAnnotationConfig.instruction`, `exampleCount`, and `exampleSamplePercentage`. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.", + "httpMethod": "PATCH", + "id": "datalabeling.projects.evaluationJobs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask for which fields to update. You can only provide the following fields: * `evaluationJobConfig.humanAnnotationConfig.instruction` * `evaluationJobConfig.exampleCount` * `evaluationJobConfig.exampleSamplePercentage` You can provide more than one of these fields by separating them with commas.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pause": { + "description": "Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a no-op.", + "httpMethod": "POST", + "id": "datalabeling.projects.evaluationJobs.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job that is going to be paused. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:pause", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.", + "httpMethod": "POST", + "id": "datalabeling.projects.evaluationJobs.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the evaluation job that is going to be resumed. Format: \"projects/{project_id}/evaluationJobs/{evaluation_job_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/evaluationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:resume", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluations": { + "methods": { + "search": { + "description": "Searches evaluations within a project.", + "httpMethod": "GET", + "id": "datalabeling.projects.evaluations.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. To search evaluations, you can filter by the following: * evaluation_job.evaluation_job_id (the last part of EvaluationJob.name) * evaluation_job.model_id (the {model_name} portion of EvaluationJob.modelVersion) * evaluation_job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation) * evaluation_job.job_state (EvaluationJob.state) * annotation_spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName) To filter by multiple critiera, use the `AND` operator or the `OR` operator. The following examples shows a string that filters by several critiera: \"evaluation_job.evaluation_job_id = {evaluation_job_id} AND evaluation_job.model_id = {model_name} AND evaluation_job.evaluation_job_run_time_start = {timestamp_1} AND evaluation_job.evaluation_job_run_time_end = {timestamp_2} AND annotation_spec.display_name = {display_name}\"", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search request. If you don't specify this field, the API call requests the first page of the search.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Evaluation search parent (project ID). Format: \"projects/ {project_id}\"", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluations:search", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "instructions": { + "methods": { + "create": { + "description": "Creates an instruction for how data should be labeled.", + "httpMethod": "POST", + "id": "datalabeling.projects.instructions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Instruction resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/instructions", + "request": { + "$ref": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an instruction object by resource name.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.instructions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", + "location": "path", + "pattern": "^projects/[^/]+/instructions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an instruction by resource name.", + "httpMethod": "GET", + "id": "datalabeling.projects.instructions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", + "location": "path", + "pattern": "^projects/[^/]+/instructions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1Instruction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists instructions for a project. Pagination is supported.", + "httpMethod": "GET", + "id": "datalabeling.projects.instructions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by ListInstructionsResponse.next_page_token of the previous [DataLabelingService.ListInstructions] call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Instruction resource parent, format: projects/{project_id}", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/instructions", + "response": { + "$ref": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "GET", + "id": "datalabeling.projects.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "datalabeling.projects.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "datalabeling.projects.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "datalabeling.projects.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20210201", + "rootUrl": "https://datalabeling.googleapis.com/", + "schemas": { + "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1alpha1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1alpha1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1alpha1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1alpha1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1alpha1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1alpha1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1alpha1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1alpha1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1alpha1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1alpha1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotatedDataset": { + "description": "AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.", + "id": "GoogleCloudDatalabelingV1beta1AnnotatedDataset", + "properties": { + "annotationSource": { + "description": "Output only. Source of the annotation.", + "enum": [ + "ANNOTATION_SOURCE_UNSPECIFIED", + "OPERATOR" + ], + "enumDescriptions": [ + "", + "Answer is provided by a human contributor." + ], + "type": "string" + }, + "annotationType": { + "description": "Output only. Type of the annotation. It is specified when starting labeling task.", + "enum": [ + "ANNOTATION_TYPE_UNSPECIFIED", + "IMAGE_CLASSIFICATION_ANNOTATION", + "IMAGE_BOUNDING_BOX_ANNOTATION", + "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", + "IMAGE_BOUNDING_POLY_ANNOTATION", + "IMAGE_POLYLINE_ANNOTATION", + "IMAGE_SEGMENTATION_ANNOTATION", + "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", + "VIDEO_OBJECT_TRACKING_ANNOTATION", + "VIDEO_OBJECT_DETECTION_ANNOTATION", + "VIDEO_EVENT_ANNOTATION", + "TEXT_CLASSIFICATION_ANNOTATION", + "TEXT_ENTITY_EXTRACTION_ANNOTATION", + "GENERAL_CLASSIFICATION_ANNOTATION" + ], + "enumDescriptions": [ + "", + "Classification annotations in an image. Allowed for continuous evaluation.", + "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", + "Oriented bounding box. The box does not have to be parallel to horizontal line.", + "Bounding poly annotations in an image.", + "Polyline annotations in an image.", + "Segmentation annotations in an image.", + "Classification annotations in video shots.", + "Video object tracking annotation.", + "Video object detection annotation.", + "Video event annotation.", + "Classification for text. Allowed for continuous evaluation.", + "Entity extraction for text.", + "General classification. Allowed for continuous evaluation." + ], + "type": "string" + }, + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the annotated dataset.", + "items": { + "type": "string" + }, + "type": "array" + }, + "completedExampleCount": { + "description": "Output only. Number of examples that have annotation in the annotated dataset.", + "format": "int64", + "type": "string" + }, + "createTime": { + "description": "Output only. Time the AnnotatedDataset was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters.", + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters.", + "type": "string" + }, + "exampleCount": { + "description": "Output only. Number of examples in the annotated dataset.", + "format": "int64", + "type": "string" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", + "description": "Output only. Per label statistics." + }, + "metadata": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata", + "description": "Output only. Additional information about AnnotatedDataset." + }, + "name": { + "description": "Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata": { + "description": "Metadata on AnnotatedDataset.", + "id": "GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata", + "properties": { + "boundingPolyConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "description": "Configuration for image bounding box and bounding poly task." + }, + "eventConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", + "description": "Configuration for video event labeling task." + }, + "humanAnnotationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "HumanAnnotationConfig used when requesting the human labeling task for this AnnotatedDataset." + }, + "imageClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "description": "Configuration for image classification task." + }, + "objectDetectionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", + "description": "Configuration for video object detection task." + }, + "objectTrackingConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", + "description": "Configuration for video object tracking task." + }, + "polylineConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", + "description": "Configuration for image polyline task." + }, + "segmentationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", + "description": "Configuration for image segmentation task." + }, + "textClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "description": "Configuration for text classification task." + }, + "textEntityExtractionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", + "description": "Configuration for text entity extraction task." + }, + "videoClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", + "description": "Configuration for video classification task." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Annotation": { + "description": "Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.", + "id": "GoogleCloudDatalabelingV1beta1Annotation", + "properties": { + "annotationMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationMetadata", + "description": "Output only. Annotation metadata, including information like votes for labels." + }, + "annotationSentiment": { + "description": "Output only. Sentiment for this annotation.", + "enum": [ + "ANNOTATION_SENTIMENT_UNSPECIFIED", + "NEGATIVE", + "POSITIVE" + ], + "enumDescriptions": [ + "", + "This annotation describes negatively about the data.", + "This label describes positively about the data." + ], + "type": "string" + }, + "annotationSource": { + "description": "Output only. The source of the annotation.", + "enum": [ + "ANNOTATION_SOURCE_UNSPECIFIED", + "OPERATOR" + ], + "enumDescriptions": [ + "", + "Answer is provided by a human contributor." + ], + "type": "string" + }, + "annotationValue": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationValue", + "description": "Output only. This is the actual annotation value, e.g classification, bounding box values are stored here." + }, + "name": { + "description": "Output only. Unique name of this annotation, format is: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationMetadata": { + "description": "Additional information associated with the annotation.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationMetadata", + "properties": { + "operatorMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1OperatorMetadata", + "description": "Metadata related to human labeling." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationSpec": { + "description": "Container of information related to one possible annotation that can be used in a labeling task. For example, an image classification task where images are labeled as `dog` or `cat` must reference an AnnotationSpec for `dog` and an AnnotationSpec for `cat`.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "properties": { + "description": { + "description": "Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the AnnotationSpec. Maximum of 64 characters.", + "type": "string" + }, + "index": { + "description": "Output only. This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes `dog` and `cat`, might contain one AnnotationSpec with `{ display_name: \"dog\", index: 0 }` and one AnnotationSpec with `{ display_name: \"cat\", index: 1 }`. This is especially useful for model training as it encodes the string labels into numeric values.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationSpecSet": { + "description": "An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", + "properties": { + "annotationSpecs": { + "description": "Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" + }, + "type": "array" + }, + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the annotation spec set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.", + "type": "string" + }, + "name": { + "description": "Output only. The AnnotationSpecSet resource name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig": { + "description": "Annotation spec set with the setting of allowing multi labels or not.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig", + "properties": { + "allowMultiLabel": { + "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels from one annotation spec set.", + "type": "boolean" + }, + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1AnnotationValue": { + "description": "Annotation value for an example.", + "id": "GoogleCloudDatalabelingV1beta1AnnotationValue", + "properties": { + "imageBoundingPolyAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", + "description": "Annotation value for image bounding box, oriented bounding box and polygon cases." + }, + "imageClassificationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", + "description": "Annotation value for image classification case." + }, + "imagePolylineAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", + "description": "Annotation value for image polyline cases. Polyline here is different from BoundingPoly. It is formed by line segments connected to each other but not closed form(Bounding Poly). The line segments can cross each other." + }, + "imageSegmentationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation", + "description": "Annotation value for image segmentation." + }, + "textClassificationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", + "description": "Annotation value for text classification case." + }, + "textEntityExtractionAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", + "description": "Annotation value for text entity extraction case." + }, + "videoClassificationAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", + "description": "Annotation value for video classification case." + }, + "videoEventAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation", + "description": "Annotation value for video event case." + }, + "videoObjectTrackingAnnotation": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation", + "description": "Annotation value for video object detection and tracking case." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Attempt": { + "description": "Records a failed evaluation job run.", + "id": "GoogleCloudDatalabelingV1beta1Attempt", + "properties": { + "attemptTime": { + "format": "google-datetime", + "type": "string" + }, + "partialFailures": { + "description": "Details of errors that occurred.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BigQuerySource": { + "description": "The BigQuery location for input data. If used in an EvaluationJob, this is where the service saves the prediction input and output sampled from the model version.", + "id": "GoogleCloudDatalabelingV1beta1BigQuerySource", + "properties": { + "inputUri": { + "description": "Required. BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the [correct schema](/ml-engine/docs/continuous-evaluation/create-job#table-schema). Provide the table URI in the following format: \"bq://{your_project_id}/ {your_dataset_name}/{your_table_name}\" [Learn more](/ml-engine/docs/continuous-evaluation/create-job#table-schema).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions": { + "description": "Options regarding evaluation between bounding boxes.", + "id": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", + "properties": { + "iouThreshold": { + "description": "Minimum [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) required for 2 bounding boxes to be considered a match. This must be a number between 0 and 1.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BoundingPoly": { + "description": "A bounding polygon in the image.", + "id": "GoogleCloudDatalabelingV1beta1BoundingPoly", + "properties": { + "vertices": { + "description": "The bounding polygon vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Vertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1BoundingPolyConfig": { + "description": "Config for image bounding poly (and bounding box) human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "instructionMessage": { + "description": "Optional. Instruction message showed on contributors UI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ClassificationMetadata": { + "description": "Metadata for classification annotations.", + "id": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", + "properties": { + "isMultiLabel": { + "description": "Whether the classification task is multi-label or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ClassificationMetrics": { + "description": "Metrics calculated for a classification model.", + "id": "GoogleCloudDatalabelingV1beta1ClassificationMetrics", + "properties": { + "confusionMatrix": { + "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrix", + "description": "Confusion matrix of predicted labels vs. ground truth labels." + }, + "prCurve": { + "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", + "description": "Precision-recall curve based on ground truth labels, predicted labels, and scores for the predicted labels." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry": { + "id": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry", + "properties": { + "confidenceThreshold": { + "description": "Threshold used for this entry. For classification tasks, this is a classification threshold: a predicted label is categorized as positive or negative (in the context of this point on the PR curve) based on whether the label's score meets this threshold. For image object detection (bounding box) tasks, this is the [intersection-over-union (IOU)](/vision/automl/object-detection/docs/evaluate#intersection-over-union) threshold for the context of this point on the PR curve.", + "format": "float", + "type": "number" + }, + "f1Score": { + "description": "Harmonic mean of recall and precision.", + "format": "float", + "type": "number" + }, + "f1ScoreAt1": { + "description": "The harmonic mean of recall_at1 and precision_at1.", + "format": "float", + "type": "number" + }, + "f1ScoreAt5": { + "description": "The harmonic mean of recall_at5 and precision_at5.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "Precision value.", + "format": "float", + "type": "number" + }, + "precisionAt1": { + "description": "Precision value for entries with label that has highest score.", + "format": "float", + "type": "number" + }, + "precisionAt5": { + "description": "Precision value for entries with label that has highest 5 scores.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "Recall value.", + "format": "float", + "type": "number" + }, + "recallAt1": { + "description": "Recall value for entries with label that has highest score.", + "format": "float", + "type": "number" + }, + "recallAt5": { + "description": "Recall value for entries with label that has highest 5 scores.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ConfusionMatrix": { + "description": "Confusion matrix of the model running the classification. Only applicable when the metrics entry aggregates multiple labels. Not applicable when the entry is for a single label.", + "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrix", + "properties": { + "row": { + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Row" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry": { + "id": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "The annotation spec of a predicted label." + }, + "itemCount": { + "description": "Number of items predicted to have this label. (The ground truth label for these items is the `Row.annotationSpec` of this entry's parent.)", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest": { + "description": "Request message for CreateAnnotationSpecSet.", + "id": "GoogleCloudDatalabelingV1beta1CreateAnnotationSpecSetRequest", + "properties": { + "annotationSpecSet": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet", + "description": "Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateDatasetRequest": { + "description": "Request message for CreateDataset.", + "id": "GoogleCloudDatalabelingV1beta1CreateDatasetRequest", + "properties": { + "dataset": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset", + "description": "Required. The dataset to be created." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest": { + "description": "Request message for CreateEvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest", + "properties": { + "job": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob", + "description": "Required. The evaluation job to create." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1beta1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CreateInstructionRequest": { + "description": "Request message for CreateInstruction.", + "id": "GoogleCloudDatalabelingV1beta1CreateInstructionRequest", + "properties": { + "instruction": { + "$ref": "GoogleCloudDatalabelingV1beta1Instruction", + "description": "Required. Instruction of how to perform the labeling task." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1CsvInstruction": { + "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file.", + "id": "GoogleCloudDatalabelingV1beta1CsvInstruction", + "properties": { + "gcsFileUri": { + "description": "CSV file for the instruction. Only gcs path is allowed.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1DataItem": { + "description": "DataItem is a piece of data, without annotation. For example, an image.", + "id": "GoogleCloudDatalabelingV1beta1DataItem", + "properties": { + "imagePayload": { + "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload", + "description": "The image payload, a container of the image bytes/uri." + }, + "name": { + "description": "Output only. Name of the data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}", + "type": "string" + }, + "textPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", + "description": "The text payload, a container of text content." + }, + "videoPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload", + "description": "The video payload, a container of the video uri." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Dataset": { + "description": "Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.", + "id": "GoogleCloudDatalabelingV1beta1Dataset", + "properties": { + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the dataset.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Time the dataset is created.", + "format": "google-datetime", + "type": "string" + }, + "dataItemCount": { + "description": "Output only. The number of data items in the dataset.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the dataset. Maximum of 64 characters.", + "type": "string" + }, + "inputConfigs": { + "description": "Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1InputConfig" + }, + "type": "array" + }, + "lastMigrateTime": { + "description": "Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Evaluation": { + "description": "Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.", + "id": "GoogleCloudDatalabelingV1beta1Evaluation", + "properties": { + "annotationType": { + "description": "Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.", + "enum": [ + "ANNOTATION_TYPE_UNSPECIFIED", + "IMAGE_CLASSIFICATION_ANNOTATION", + "IMAGE_BOUNDING_BOX_ANNOTATION", + "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", + "IMAGE_BOUNDING_POLY_ANNOTATION", + "IMAGE_POLYLINE_ANNOTATION", + "IMAGE_SEGMENTATION_ANNOTATION", + "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", + "VIDEO_OBJECT_TRACKING_ANNOTATION", + "VIDEO_OBJECT_DETECTION_ANNOTATION", + "VIDEO_EVENT_ANNOTATION", + "TEXT_CLASSIFICATION_ANNOTATION", + "TEXT_ENTITY_EXTRACTION_ANNOTATION", + "GENERAL_CLASSIFICATION_ANNOTATION" + ], + "enumDescriptions": [ + "", + "Classification annotations in an image. Allowed for continuous evaluation.", + "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", + "Oriented bounding box. The box does not have to be parallel to horizontal line.", + "Bounding poly annotations in an image.", + "Polyline annotations in an image.", + "Segmentation annotations in an image.", + "Classification annotations in video shots.", + "Video object tracking annotation.", + "Video object detection annotation.", + "Video event annotation.", + "Classification for text. Allowed for continuous evaluation.", + "Entity extraction for text.", + "General classification. Allowed for continuous evaluation." + ], + "type": "string" + }, + "config": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig", + "description": "Output only. Options used in the evaluation job that created this evaluation." + }, + "createTime": { + "description": "Output only. Timestamp for when this evaluation was created.", + "format": "google-datetime", + "type": "string" + }, + "evaluatedItemCount": { + "description": "Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes.", + "format": "int64", + "type": "string" + }, + "evaluationJobRunTime": { + "description": "Output only. Timestamp for when the evaluation job that created this evaluation ran.", + "format": "google-datetime", + "type": "string" + }, + "evaluationMetrics": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", + "description": "Output only. Metrics comparing predictions to ground truth labels." + }, + "name": { + "description": "Output only. Resource name of an evaluation. The name has the following format: \"projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}'", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationConfig": { + "description": "Configuration details used for calculating evaluation metrics and creating an Evaluation.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationConfig", + "properties": { + "boundingBoxEvaluationOptions": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingBoxEvaluationOptions", + "description": "Only specify this field if the related model performs image object detection (`IMAGE_BOUNDING_BOX_ANNOTATION`). Describes how to evaluate bounding boxes." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationJob": { + "description": "Defines an evaluation job that runs periodically to generate Evaluations. [Creating an evaluation job](/ml-engine/docs/continuous-evaluation/create-job) is the starting point for using continuous evaluation.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationJob", + "properties": { + "annotationSpecSet": { + "description": "Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: \"projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}\"", + "type": "string" + }, + "attempts": { + "description": "Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Attempt" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Timestamp of when this evaluation job was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Required. Description of the job. The description can be up to 25,000 characters long.", + "type": "string" + }, + "evaluationJobConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", + "description": "Required. Configuration details for the evaluation job." + }, + "labelMissingGroundTruth": { + "description": "Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`.", + "type": "boolean" + }, + "modelVersion": { + "description": "Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: \"projects/{project_id}/models/{model_name}/versions/{version_name}\" There can only be one evaluation job per model version.", + "type": "string" + }, + "name": { + "description": "Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: \"projects/{project_id}/evaluationJobs/ {evaluation_job_id}\"", + "type": "string" + }, + "schedule": { + "description": "Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in [crontab format](/scheduler/docs/configuring/cron-job-schedules) or in an [English-like format](/appengine/docs/standard/python/config/cronref#schedule_format). Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day.", + "type": "string" + }, + "state": { + "description": "Output only. Describes the current state of the job.", + "enum": [ + "STATE_UNSPECIFIED", + "SCHEDULED", + "RUNNING", + "PAUSED", + "STOPPED" + ], + "enumDescriptions": [ + "", + "The job is scheduled to run at the configured interval. You can pause or delete the job. When the job is in this state, it samples prediction input and output from your model version into your BigQuery table as predictions occur.", + "The job is currently running. When the job runs, Data Labeling Service does several things: 1. If you have configured your job to use Data Labeling Service for ground truth labeling, the service creates a Dataset and a labeling task for all data sampled since the last time the job ran. Human labelers provide ground truth labels for your data. Human labeling may take hours, or even days, depending on how much data has been sampled. The job remains in the `RUNNING` state during this time, and it can even be running multiple times in parallel if it gets triggered again (for example 24 hours later) before the earlier run has completed. When human labelers have finished labeling the data, the next step occurs. If you have configured your job to provide your own ground truth labels, Data Labeling Service still creates a Dataset for newly sampled data, but it expects that you have already added ground truth labels to the BigQuery table by this time. The next step occurs immediately. 2. Data Labeling Service creates an Evaluation by comparing your model version's predictions with the ground truth labels. If the job remains in this state for a long time, it continues to sample prediction data into your BigQuery table and will run again at the next interval, even if it causes the job to run multiple times in parallel.", + "The job is not sampling prediction input and output into your BigQuery table and it will not run according to its schedule. You can resume the job.", + "The job has this state right before it is deleted." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig": { + "description": "Provides details for how an evaluation job sends email alerts based on the results of a run.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", + "properties": { + "email": { + "description": "Required. An email address to send alerts to.", + "type": "string" + }, + "minAcceptableMeanAveragePrecision": { + "description": "Required. A number between 0 and 1 that describes a minimum mean average precision threshold. When the evaluation job runs, if it calculates that your model version's predictions from the recent interval have meanAveragePrecision below this threshold, then it sends an alert to your specified email.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationJobConfig": { + "description": "Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1EvaluationJobConfig", + "properties": { + "bigqueryImportKeys": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Prediction keys that tell Data Labeling Service where to find the data for evaluation in your BigQuery table. When the service samples prediction input and output from your model version and saves it to BigQuery, the data gets stored as JSON strings in the BigQuery table. These keys tell Data Labeling Service how to parse the JSON. You can provide the following entries in this field: * `data_json_key`: the data key for prediction input. You must provide either this key or `reference_json_key`. * `reference_json_key`: the data reference key for prediction input. You must provide either this key or `data_json_key`. * `label_json_key`: the label key for prediction output. Required. * `label_score_json_key`: the score key for prediction output. Required. * `bounding_box_json_key`: the bounding box key for prediction output. Required if your model version perform image object detection. Learn [how to configure prediction keys](/ml-engine/docs/continuous-evaluation/create-job#prediction-keys).", + "type": "object" + }, + "boundingPolyConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "description": "Specify this field if your model version performs image object detection (bounding box detection). `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet." + }, + "evaluationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationConfig", + "description": "Required. Details for calculating evaluation metrics and creating Evaulations. If your model version performs image object detection, you must specify the `boundingBoxEvaluationOptions` field within this configuration. Otherwise, provide an empty object for this configuration." + }, + "evaluationJobAlertConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJobAlertConfig", + "description": "Optional. Configuration details for evaluation job alerts. Specify this field if you want to receive email alerts if the evaluation job finds that your predictions have low mean average precision during a run." + }, + "exampleCount": { + "description": "Required. The maximum number of predictions to sample and save to BigQuery during each evaluation interval. This limit overrides `example_sample_percentage`: even if the service has not sampled enough predictions to fulfill `example_sample_perecentage` during an interval, it stops sampling predictions when it meets this limit.", + "format": "int32", + "type": "integer" + }, + "exampleSamplePercentage": { + "description": "Required. Fraction of predictions to sample and save to BigQuery during each evaluation interval. For example, 0.1 means 10% of predictions served by your model version get saved to BigQuery.", + "format": "double", + "type": "number" + }, + "humanAnnotationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Optional. Details for human annotation of your data. If you set labelMissingGroundTruth to `true` for this evaluation job, then you must specify this field. If you plan to provide your own ground truth labels, then omit this field. Note that you must create an Instruction resource before you can specify this field. Provide the name of the instruction resource in the `instruction` field within this configuration." + }, + "imageClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "description": "Specify this field if your model version performs image classification or general classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config." + }, + "inputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1InputConfig", + "description": "Rquired. Details for the sampled prediction input. Within this configuration, there are requirements for several fields: * `dataType` must be one of `IMAGE`, `TEXT`, or `GENERAL_DATA`. * `annotationType` must be one of `IMAGE_CLASSIFICATION_ANNOTATION`, `TEXT_CLASSIFICATION_ANNOTATION`, `GENERAL_CLASSIFICATION_ANNOTATION`, or `IMAGE_BOUNDING_BOX_ANNOTATION` (image object detection). * If your machine learning model performs classification, you must specify `classificationMetadata.isMultiLabel`. * You must specify `bigquerySource` (not `gcsSource`)." + }, + "textClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "description": "Specify this field if your model version performs text classification. `annotationSpecSet` in this configuration must match EvaluationJob.annotationSpecSet. `allowMultiLabel` in this configuration must match `classificationMetadata.isMultiLabel` in input_config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EvaluationMetrics": { + "id": "GoogleCloudDatalabelingV1beta1EvaluationMetrics", + "properties": { + "classificationMetrics": { + "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetrics" + }, + "objectDetectionMetrics": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1EventConfig": { + "description": "Config for video event human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1EventConfig", + "properties": { + "annotationSpecSets": { + "description": "Required. The list of annotation spec set resource name. Similar to video classification, we support selecting event from multiple AnnotationSpecSet at the same time.", + "items": { + "type": "string" + }, + "type": "array" + }, + "clipLength": { + "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 60s.", + "format": "int32", + "type": "integer" + }, + "overlapLength": { + "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 1s.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Example": { + "description": "An Example is a piece of data and its annotation. For example, an image with label \"house\".", + "id": "GoogleCloudDatalabelingV1beta1Example", + "properties": { + "annotations": { + "description": "Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Annotation" + }, + "type": "array" + }, + "imagePayload": { + "$ref": "GoogleCloudDatalabelingV1beta1ImagePayload", + "description": "The image payload, a container of the image bytes/uri." + }, + "name": { + "description": "Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}", + "type": "string" + }, + "textPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1TextPayload", + "description": "The text payload, a container of the text content." + }, + "videoPayload": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoPayload", + "description": "The video payload, a container of the video uri." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExampleComparison": { + "description": "Example comparisons comparing ground truth output and predictions for a specific input.", + "id": "GoogleCloudDatalabelingV1beta1ExampleComparison", + "properties": { + "groundTruthExample": { + "$ref": "GoogleCloudDatalabelingV1beta1Example", + "description": "The ground truth output for the input." + }, + "modelCreatedExamples": { + "description": "Predictions by the model for the input.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Example" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1beta1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ExportDataRequest": { + "description": "Request message for ExportData API.", + "id": "GoogleCloudDatalabelingV1beta1ExportDataRequest", + "properties": { + "annotatedDataset": { + "description": "Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}", + "type": "string" + }, + "filter": { + "description": "Optional. Filter is not supported at this moment.", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1OutputConfig", + "description": "Required. Specify the output destination." + }, + "userEmailAddress": { + "description": "Email of the user who started the export task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1FeedbackMessage": { + "description": "A feedback message inside a feedback thread.", + "id": "GoogleCloudDatalabelingV1beta1FeedbackMessage", + "properties": { + "body": { + "description": "String content of the feedback. Maximum of 10000 characters.", + "type": "string" + }, + "createTime": { + "description": "Create time.", + "format": "google-datetime", + "type": "string" + }, + "image": { + "description": "The image storing this feedback if the feedback is an image representing operator's comments.", + "format": "byte", + "type": "string" + }, + "name": { + "description": "Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}'", + "type": "string" + }, + "operatorFeedbackMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata" + }, + "requesterFeedbackMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1FeedbackThread": { + "description": "A feedback thread of a certain labeling task on a certain annotated dataset.", + "id": "GoogleCloudDatalabelingV1beta1FeedbackThread", + "properties": { + "feedbackThreadMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", + "description": "Metadata regarding the feedback thread." + }, + "name": { + "description": "Name of the feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}'", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata": { + "id": "GoogleCloudDatalabelingV1beta1FeedbackThreadMetadata", + "properties": { + "createTime": { + "description": "When the thread is created", + "format": "google-datetime", + "type": "string" + }, + "lastUpdateTime": { + "description": "When the thread is last updated.", + "format": "google-datetime", + "type": "string" + }, + "status": { + "enum": [ + "FEEDBACK_THREAD_STATUS_UNSPECIFIED", + "NEW", + "REPLIED" + ], + "enumDescriptions": [ + "", + "Feedback thread is created with no reply;", + "Feedback thread is replied at least once;" + ], + "type": "string" + }, + "thumbnail": { + "description": "An image thumbnail of this thread.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1beta1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1GcsSource": { + "description": "Source of the Cloud Storage file to be imported.", + "id": "GoogleCloudDatalabelingV1beta1GcsSource", + "properties": { + "inputUri": { + "description": "Required. The input URI of source file. This must be a Cloud Storage path (`gs://...`).", + "type": "string" + }, + "mimeType": { + "description": "Required. The format of the source file. Only \"text/csv\" is supported.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation": { + "description": "Image bounding poly annotation. It represents a polygon including bounding box in the image.", + "id": "GoogleCloudDatalabelingV1beta1ImageBoundingPolyAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of object in this bounding polygon." + }, + "boundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" + }, + "normalizedBoundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation": { + "description": "Image classification annotation definition.", + "id": "GoogleCloudDatalabelingV1beta1ImageClassificationAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of image." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageClassificationConfig": { + "description": "Config for image classification human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "properties": { + "allowMultiLabel": { + "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one image.", + "type": "boolean" + }, + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "answerAggregationType": { + "description": "Optional. The type of how to aggregate answers.", + "enum": [ + "STRING_AGGREGATION_TYPE_UNSPECIFIED", + "MAJORITY_VOTE", + "UNANIMOUS_VOTE", + "NO_AGGREGATION" + ], + "enumDescriptions": [ + "", + "Majority vote to aggregate answers.", + "Unanimous answers will be adopted.", + "Preserve all answers by crowd compute." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImagePayload": { + "description": "Container of information about an image.", + "id": "GoogleCloudDatalabelingV1beta1ImagePayload", + "properties": { + "imageThumbnail": { + "description": "A byte string of a thumbnail image.", + "format": "byte", + "type": "string" + }, + "imageUri": { + "description": "Image uri from the user bucket.", + "type": "string" + }, + "mimeType": { + "description": "Image format.", + "type": "string" + }, + "signedUri": { + "description": "Signed uri of the image file in the service bucket.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation": { + "description": "A polyline for the image annotation.", + "id": "GoogleCloudDatalabelingV1beta1ImagePolylineAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of this polyline." + }, + "normalizedPolyline": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedPolyline" + }, + "polyline": { + "$ref": "GoogleCloudDatalabelingV1beta1Polyline" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation": { + "description": "Image segmentation annotation.", + "id": "GoogleCloudDatalabelingV1beta1ImageSegmentationAnnotation", + "properties": { + "annotationColors": { + "additionalProperties": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec" + }, + "description": "The mapping between rgb color and annotation spec. The key is the rgb color represented in format of rgb(0, 0, 0). The value is the AnnotationSpec.", + "type": "object" + }, + "imageBytes": { + "description": "A byte string of a full image's color map.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "Image format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1beta1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ImportDataRequest": { + "description": "Request message for ImportData API.", + "id": "GoogleCloudDatalabelingV1beta1ImportDataRequest", + "properties": { + "inputConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1InputConfig", + "description": "Required. Specify the input source of the data." + }, + "userEmailAddress": { + "description": "Email of the user who started the import task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1InputConfig": { + "description": "The configuration of input data, including data type, location, etc.", + "id": "GoogleCloudDatalabelingV1beta1InputConfig", + "properties": { + "annotationType": { + "description": "Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.", + "enum": [ + "ANNOTATION_TYPE_UNSPECIFIED", + "IMAGE_CLASSIFICATION_ANNOTATION", + "IMAGE_BOUNDING_BOX_ANNOTATION", + "IMAGE_ORIENTED_BOUNDING_BOX_ANNOTATION", + "IMAGE_BOUNDING_POLY_ANNOTATION", + "IMAGE_POLYLINE_ANNOTATION", + "IMAGE_SEGMENTATION_ANNOTATION", + "VIDEO_SHOTS_CLASSIFICATION_ANNOTATION", + "VIDEO_OBJECT_TRACKING_ANNOTATION", + "VIDEO_OBJECT_DETECTION_ANNOTATION", + "VIDEO_EVENT_ANNOTATION", + "TEXT_CLASSIFICATION_ANNOTATION", + "TEXT_ENTITY_EXTRACTION_ANNOTATION", + "GENERAL_CLASSIFICATION_ANNOTATION" + ], + "enumDescriptions": [ + "", + "Classification annotations in an image. Allowed for continuous evaluation.", + "Bounding box annotations in an image. A form of image object detection. Allowed for continuous evaluation.", + "Oriented bounding box. The box does not have to be parallel to horizontal line.", + "Bounding poly annotations in an image.", + "Polyline annotations in an image.", + "Segmentation annotations in an image.", + "Classification annotations in video shots.", + "Video object tracking annotation.", + "Video object detection annotation.", + "Video event annotation.", + "Classification for text. Allowed for continuous evaluation.", + "Entity extraction for text.", + "General classification. Allowed for continuous evaluation." + ], + "type": "string" + }, + "bigquerySource": { + "$ref": "GoogleCloudDatalabelingV1beta1BigQuerySource", + "description": "Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob." + }, + "classificationMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1ClassificationMetadata", + "description": "Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification." + }, + "dataType": { + "description": "Required. Data type must be specifed when user tries to import data.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "IMAGE", + "VIDEO", + "TEXT", + "GENERAL_DATA" + ], + "enumDescriptions": [ + "Data type is unspecified.", + "Allowed for continuous evaluation.", + "Video data type.", + "Allowed for continuous evaluation.", + "Allowed for continuous evaluation." + ], + "type": "string" + }, + "gcsSource": { + "$ref": "GoogleCloudDatalabelingV1beta1GcsSource", + "description": "Source located in Cloud Storage." + }, + "textMetadata": { + "$ref": "GoogleCloudDatalabelingV1beta1TextMetadata", + "description": "Required for text import, as language code must be specified." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Instruction": { + "description": "Instruction of how to perform the labeling task for human operators. Currently only PDF instruction is supported.", + "id": "GoogleCloudDatalabelingV1beta1Instruction", + "properties": { + "blockingResources": { + "description": "Output only. The names of any related resources that are blocking changes to the instruction.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. Creation time of instruction.", + "format": "google-datetime", + "type": "string" + }, + "csvInstruction": { + "$ref": "GoogleCloudDatalabelingV1beta1CsvInstruction", + "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data." + }, + "dataType": { + "description": "Required. The data type of this instruction.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "IMAGE", + "VIDEO", + "TEXT", + "GENERAL_DATA" + ], + "enumDescriptions": [ + "Data type is unspecified.", + "Allowed for continuous evaluation.", + "Video data type.", + "Allowed for continuous evaluation.", + "Allowed for continuous evaluation." + ], + "type": "string" + }, + "description": { + "description": "Optional. User-provided description of the instruction. The description can be up to 10000 characters long.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the instruction. Maximum of 64 characters.", + "type": "string" + }, + "name": { + "description": "Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "pdfInstruction": { + "$ref": "GoogleCloudDatalabelingV1beta1PdfInstruction", + "description": "Instruction from a PDF document. The PDF should be in a Cloud Storage bucket." + }, + "updateTime": { + "description": "Output only. Last update time of instruction.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageRequest": { + "description": "Request message for starting an image labeling task.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageRequest", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Required. Basic human annotation config." + }, + "boundingPolyConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPolyConfig", + "description": "Configuration for bounding box and bounding poly task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + }, + "feature": { + "description": "Required. The type of image labeling task.", + "enum": [ + "FEATURE_UNSPECIFIED", + "CLASSIFICATION", + "BOUNDING_BOX", + "ORIENTED_BOUNDING_BOX", + "BOUNDING_POLY", + "POLYLINE", + "SEGMENTATION" + ], + "enumDescriptions": [ + "", + "Label whole image with one or more of labels.", + "Label image with bounding boxes for labels.", + "Label oriented bounding box. The box does not have to be parallel to horizontal line.", + "Label images with bounding poly. A bounding poly is a plane figure that is bounded by a finite chain of straight line segments closing in a loop.", + "Label images with polyline. Polyline is formed by connected line segments which are not in closed form.", + "Label images with segmentation. Segmentation is different from bounding poly since it is more fine-grained, pixel level annotation." + ], + "type": "string" + }, + "imageClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ImageClassificationConfig", + "description": "Configuration for image classification task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + }, + "polylineConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1PolylineConfig", + "description": "Configuration for polyline task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + }, + "segmentationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1SegmentationConfig", + "description": "Configuration for segmentation task. One of image_classification_config, bounding_poly_config, polyline_config and segmentation_config are required." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1beta1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1beta1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelTextRequest": { + "description": "Request message for LabelText.", + "id": "GoogleCloudDatalabelingV1beta1LabelTextRequest", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Required. Basic human annotation config." + }, + "feature": { + "description": "Required. The type of text labeling task.", + "enum": [ + "FEATURE_UNSPECIFIED", + "TEXT_CLASSIFICATION", + "TEXT_ENTITY_EXTRACTION" + ], + "enumDescriptions": [ + "", + "Label text content to one of more labels.", + "Label entities and their span in text." + ], + "type": "string" + }, + "textClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "description": "Configuration for text classification task. One of text_classification_config and text_entity_extraction_config is required." + }, + "textEntityExtractionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", + "description": "Configuration for entity extraction task. One of text_classification_config and text_entity_extraction_config is required." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1LabelVideoRequest": { + "description": "Request message for LabelVideo.", + "id": "GoogleCloudDatalabelingV1beta1LabelVideoRequest", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1HumanAnnotationConfig", + "description": "Required. Basic human annotation config." + }, + "eventConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1EventConfig", + "description": "Configuration for video event task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + }, + "feature": { + "description": "Required. The type of video labeling task.", + "enum": [ + "FEATURE_UNSPECIFIED", + "CLASSIFICATION", + "OBJECT_DETECTION", + "OBJECT_TRACKING", + "EVENT" + ], + "enumDescriptions": [ + "", + "Label whole video or video segment with one or more labels.", + "Label objects with bounding box on image frames extracted from the video.", + "Label and track objects in video.", + "Label the range of video for the specified events." + ], + "type": "string" + }, + "objectDetectionConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", + "description": "Configuration for video object detection task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + }, + "objectTrackingConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", + "description": "Configuration for video object tracking task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + }, + "videoClassificationConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", + "description": "Configuration for video classification task. One of video_classification_config, object_detection_config, object_tracking_config and event_config is required." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse": { + "description": "Results of listing annotated datasets for a dataset.", + "id": "GoogleCloudDatalabelingV1beta1ListAnnotatedDatasetsResponse", + "properties": { + "annotatedDatasets": { + "description": "The list of annotated datasets to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotatedDataset" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse": { + "description": "Results of listing annotation spec set under a project.", + "id": "GoogleCloudDatalabelingV1beta1ListAnnotationSpecSetsResponse", + "properties": { + "annotationSpecSets": { + "description": "The list of annotation spec sets.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListDataItemsResponse": { + "description": "Results of listing data items in a dataset.", + "id": "GoogleCloudDatalabelingV1beta1ListDataItemsResponse", + "properties": { + "dataItems": { + "description": "The list of data items to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1DataItem" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListDatasetsResponse": { + "description": "Results of listing datasets within a project.", + "id": "GoogleCloudDatalabelingV1beta1ListDatasetsResponse", + "properties": { + "datasets": { + "description": "The list of datasets to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Dataset" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse": { + "description": "Results for listing evaluation jobs.", + "id": "GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse", + "properties": { + "evaluationJobs": { + "description": "The list of evaluation jobs to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1EvaluationJob" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListExamplesResponse": { + "description": "Results of listing Examples in and annotated dataset.", + "id": "GoogleCloudDatalabelingV1beta1ListExamplesResponse", + "properties": { + "examples": { + "description": "The list of examples to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Example" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse": { + "description": "Results for listing FeedbackMessages.", + "id": "GoogleCloudDatalabelingV1beta1ListFeedbackMessagesResponse", + "properties": { + "feedbackMessages": { + "description": "The list of feedback messages to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackMessage" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse": { + "description": "Results for listing FeedbackThreads.", + "id": "GoogleCloudDatalabelingV1beta1ListFeedbackThreadsResponse", + "properties": { + "feedbackThreads": { + "description": "The list of feedback threads to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1FeedbackThread" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ListInstructionsResponse": { + "description": "Results of listing instructions under a project.", + "id": "GoogleCloudDatalabelingV1beta1ListInstructionsResponse", + "properties": { + "instructions": { + "description": "The list of Instructions to return.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Instruction" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly": { + "description": "Normalized bounding polygon.", + "id": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly", + "properties": { + "normalizedVertices": { + "description": "The bounding polygon normalized vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1NormalizedPolyline": { + "description": "Normalized polyline.", + "id": "GoogleCloudDatalabelingV1beta1NormalizedPolyline", + "properties": { + "normalizedVertices": { + "description": "The normalized polyline vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedVertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1NormalizedVertex": { + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", + "id": "GoogleCloudDatalabelingV1beta1NormalizedVertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "float", + "type": "number" + }, + "y": { + "description": "Y coordinate.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig": { + "description": "Config for video object detection human labeling task. Object detection will be conducted on the images extracted from the video, and those objects will be labeled with bounding boxes. User need to specify the number of images to be extracted per second as the extraction frame rate.", + "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "extractionFrameRate": { + "description": "Required. Number of frames per second to be extracted from the video.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics": { + "description": "Metrics calculated for an image object detection (bounding box) model.", + "id": "GoogleCloudDatalabelingV1beta1ObjectDetectionMetrics", + "properties": { + "prCurve": { + "$ref": "GoogleCloudDatalabelingV1beta1PrCurve", + "description": "Precision-recall curve." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig": { + "description": "Config for video object tracking human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "clipLength": { + "description": "Videos will be cut to smaller clips to make it easier for labelers to work on. Users can configure is field in seconds, if not set, default value is 20s.", + "format": "int32", + "type": "integer" + }, + "overlapLength": { + "description": "The overlap length between different video clips. Users can configure is field in seconds, if not set, default value is 0.3s.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame": { + "description": "Video frame level annotation for object detection and tracking.", + "id": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame", + "properties": { + "boundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1BoundingPoly" + }, + "normalizedBoundingPoly": { + "$ref": "GoogleCloudDatalabelingV1beta1NormalizedBoundingPoly" + }, + "timeOffset": { + "description": "The time offset of this frame relative to the beginning of the video.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata": { + "description": "Metadata describing the feedback from the operator.", + "id": "GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1OperatorMetadata": { + "description": "General information useful for labels coming from contributors.", + "id": "GoogleCloudDatalabelingV1beta1OperatorMetadata", + "properties": { + "comments": { + "description": "Comments from contributors.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labelVotes": { + "description": "The total number of contributors that choose this label.", + "format": "int32", + "type": "integer" + }, + "score": { + "description": "Confidence score corresponding to a label. For examle, if 3 contributors have answered the question and 2 of them agree on the final label, the confidence score will be 0.67 (2/3).", + "format": "float", + "type": "number" + }, + "totalVotes": { + "description": "The total number of contributors that answer this question.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1beta1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1beta1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1beta1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest": { + "description": "Request message for PauseEvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PdfInstruction": { + "description": "Instruction from a PDF file.", + "id": "GoogleCloudDatalabelingV1beta1PdfInstruction", + "properties": { + "gcsFileUri": { + "description": "PDF file for the instruction. Only gcs path is allowed.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Polyline": { + "description": "A line with multiple line segments.", + "id": "GoogleCloudDatalabelingV1beta1Polyline", + "properties": { + "vertices": { + "description": "The polyline vertices.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Vertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PolylineConfig": { + "description": "Config for image polyline human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1PolylineConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "instructionMessage": { + "description": "Optional. Instruction message showed on contributors UI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1PrCurve": { + "id": "GoogleCloudDatalabelingV1beta1PrCurve", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "The annotation spec of the label for which the precision-recall curve calculated. If this field is empty, that means the precision-recall curve is an aggregate curve for all labels." + }, + "areaUnderCurve": { + "description": "Area under the precision-recall curve. Not to be confused with area under a receiver operating characteristic (ROC) curve.", + "format": "float", + "type": "number" + }, + "confidenceMetricsEntries": { + "description": "Entries that make up the precision-recall graph. Each entry is a \"point\" on the graph drawn for a different `confidence_threshold`.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ConfidenceMetricsEntry" + }, + "type": "array" + }, + "meanAveragePrecision": { + "description": "Mean average prcision of this curve.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata": { + "description": "Metadata describing the feedback from the labeling task requester.", + "id": "GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest": { + "description": "Request message ResumeEvaluationJob.", + "id": "GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Row": { + "description": "A row in the confusion matrix. Each entry in this row has the same ground truth label.", + "id": "GoogleCloudDatalabelingV1beta1Row", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "The annotation spec of the ground truth label for this row." + }, + "entries": { + "description": "A list of the confusion matrix entries. One entry for each possible predicted label.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ConfusionMatrixEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse": { + "description": "Results of searching evaluations.", + "id": "GoogleCloudDatalabelingV1beta1SearchEvaluationsResponse", + "properties": { + "evaluations": { + "description": "The list of evaluations matching the search.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1Evaluation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest": { + "description": "Request message of SearchExampleComparisons.", + "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsRequest", + "properties": { + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer results than requested. Default value is 100.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest. If you don't specify this field, the API call requests the first page of the search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse": { + "description": "Results of searching example comparisons.", + "id": "GoogleCloudDatalabelingV1beta1SearchExampleComparisonsResponse", + "properties": { + "exampleComparisons": { + "description": "A list of example comparisons matching the search criteria.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ExampleComparison" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SegmentationConfig": { + "description": "Config for image segmentation", + "id": "GoogleCloudDatalabelingV1beta1SegmentationConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name. format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}", + "type": "string" + }, + "instructionMessage": { + "description": "Instruction message showed on labelers UI.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SentimentConfig": { + "description": "Config for setting up sentiments.", + "id": "GoogleCloudDatalabelingV1beta1SentimentConfig", + "properties": { + "enableLabelSentimentSelection": { + "description": "If set to true, contributors will have the option to select sentiment of the label they selected, to mark it as negative or positive label. Default is false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1SequentialSegment": { + "description": "Start and end position in a sequence (e.g. text segment).", + "id": "GoogleCloudDatalabelingV1beta1SequentialSegment", + "properties": { + "end": { + "description": "End position (exclusive).", + "format": "int32", + "type": "integer" + }, + "start": { + "description": "Start position (inclusive).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation": { + "description": "Text classification annotation.", + "id": "GoogleCloudDatalabelingV1beta1TextClassificationAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the text." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextClassificationConfig": { + "description": "Config for text classification human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1TextClassificationConfig", + "properties": { + "allowMultiLabel": { + "description": "Optional. If allow_multi_label is true, contributors are able to choose multiple labels for one text segment.", + "type": "boolean" + }, + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + }, + "sentimentConfig": { + "$ref": "GoogleCloudDatalabelingV1beta1SentimentConfig", + "description": "Optional. Configs for sentiment selection. We deprecate sentiment analysis in data labeling side as it is incompatible with uCAIP." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation": { + "description": "Text entity extraction annotation.", + "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the text entities." + }, + "sequentialSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1SequentialSegment", + "description": "Position of the entity." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig": { + "description": "Config for text entity extraction human labeling task.", + "id": "GoogleCloudDatalabelingV1beta1TextEntityExtractionConfig", + "properties": { + "annotationSpecSet": { + "description": "Required. Annotation spec set resource name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextMetadata": { + "description": "Metadata for the text.", + "id": "GoogleCloudDatalabelingV1beta1TextMetadata", + "properties": { + "languageCode": { + "description": "The language of this text, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TextPayload": { + "description": "Container of information about a piece of text.", + "id": "GoogleCloudDatalabelingV1beta1TextPayload", + "properties": { + "textContent": { + "description": "Text content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1TimeSegment": { + "description": "A time period inside of an example that has a time dimension (e.g. video).", + "id": "GoogleCloudDatalabelingV1beta1TimeSegment", + "properties": { + "endTimeOffset": { + "description": "End of the time segment (exclusive), represented as the duration since the example start.", + "format": "google-duration", + "type": "string" + }, + "startTimeOffset": { + "description": "Start of the time segment (inclusive), represented as the duration since the example start.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1Vertex": { + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", + "id": "GoogleCloudDatalabelingV1beta1Vertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "int32", + "type": "integer" + }, + "y": { + "description": "Y coordinate.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation": { + "description": "Video classification annotation.", + "id": "GoogleCloudDatalabelingV1beta1VideoClassificationAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the segment specified by time_segment." + }, + "timeSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", + "description": "The time segment of the video to which the annotation applies." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoClassificationConfig": { + "description": "Config for video classification human labeling task. Currently two types of video classification are supported: 1. Assign labels on the entire video. 2. Split the video into multiple video clips based on camera shot, and assign labels on each video clip.", + "id": "GoogleCloudDatalabelingV1beta1VideoClassificationConfig", + "properties": { + "annotationSpecSetConfigs": { + "description": "Required. The list of annotation spec set configs. Since watching a video clip takes much longer time than an image, we support label with multiple AnnotationSpecSet at the same time. Labels in each AnnotationSpecSet will be shown in a group to contributors. Contributors can select one or more (depending on whether to allow multi label) from each group.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpecSetConfig" + }, + "type": "array" + }, + "applyShotDetection": { + "description": "Optional. Option to apply shot detection on the video.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoEventAnnotation": { + "description": "Video event annotation.", + "id": "GoogleCloudDatalabelingV1beta1VideoEventAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the event in this annotation." + }, + "timeSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", + "description": "The time segment of the video to which the annotation applies." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation": { + "description": "Video object tracking annotation.", + "id": "GoogleCloudDatalabelingV1beta1VideoObjectTrackingAnnotation", + "properties": { + "annotationSpec": { + "$ref": "GoogleCloudDatalabelingV1beta1AnnotationSpec", + "description": "Label of the object tracked in this annotation." + }, + "objectTrackingFrames": { + "description": "The list of frames where this object track appears.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1ObjectTrackingFrame" + }, + "type": "array" + }, + "timeSegment": { + "$ref": "GoogleCloudDatalabelingV1beta1TimeSegment", + "description": "The time segment of the video to which object tracking applies." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoPayload": { + "description": "Container of information of a video.", + "id": "GoogleCloudDatalabelingV1beta1VideoPayload", + "properties": { + "frameRate": { + "description": "FPS of the video.", + "format": "float", + "type": "number" + }, + "mimeType": { + "description": "Video format.", + "type": "string" + }, + "signedUri": { + "description": "Signed uri of the video file in the service bucket.", + "type": "string" + }, + "videoThumbnails": { + "description": "The list of video thumbnails.", + "items": { + "$ref": "GoogleCloudDatalabelingV1beta1VideoThumbnail" + }, + "type": "array" + }, + "videoUri": { + "description": "Video uri from the user bucket.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1beta1VideoThumbnail": { + "description": "Container of information of a video thumbnail.", + "id": "GoogleCloudDatalabelingV1beta1VideoThumbnail", + "properties": { + "thumbnail": { + "description": "A byte string of the video frame.", + "format": "byte", + "type": "string" + }, + "timeOffset": { + "description": "Time offset relative to the beginning of the video, corresponding to the video frame where the thumbnail has been extracted from.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1p1alpha1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata": { + "description": "Metadata of an GenerateAnalysisReport operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1GenerateAnalysisReportOperationMetadata", + "properties": { + "createTime": { + "description": "Timestamp when generate report request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "The name of the dataset for which the analysis report is generated. Format: \"projects/*/datasets/*\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1p1alpha1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p1alpha1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1p1alpha1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1p1alpha1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata": { + "description": "Metadata of a CreateInstruction operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1CreateInstructionMetadata", + "properties": { + "createTime": { + "description": "Timestamp when create instruction request was created.", + "format": "google-datetime", + "type": "string" + }, + "instruction": { + "description": "The name of the created Instruction. projects/{project_id}/instructions/{instruction_id}", + "type": "string" + }, + "partialFailures": { + "description": "Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata": { + "description": "Metadata of an ExportData operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when export dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be exported. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse": { + "description": "Response used for ExportDataset longrunning operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ExportDataOperationResponse", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "dataset": { + "description": "Ouptut only. The name of dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "exportCount": { + "description": "Output only. Number of examples exported successfully.", + "format": "int32", + "type": "integer" + }, + "labelStats": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelStats", + "description": "Output only. Statistic infos of labels in the exported dataset." + }, + "outputConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", + "description": "Output only. output_config in the ExportData request." + }, + "totalCount": { + "description": "Output only. Total number of examples requested to export", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1GcsDestination": { + "description": "Export destination of the data.Only gcs path is allowed in output_uri.", + "id": "GoogleCloudDatalabelingV1p2alpha1GcsDestination", + "properties": { + "mimeType": { + "description": "Required. The format of the gcs destination. Only \"text/csv\" and \"application/json\" are supported.", + "type": "string" + }, + "outputUri": { + "description": "Required. The output uri of destination file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination": { + "description": "Export folder destination of the data.", + "id": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination", + "properties": { + "outputFolderUri": { + "description": "Required. Cloud Storage directory to export data to.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig": { + "description": "Configuration for how human labeling task should be done.", + "id": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "properties": { + "annotatedDatasetDescription": { + "description": "Optional. A human-readable description for AnnotatedDataset. The description can be up to 10000 characters long.", + "type": "string" + }, + "annotatedDatasetDisplayName": { + "description": "Required. A human-readable name for AnnotatedDataset defined by users. Maximum of 64 characters .", + "type": "string" + }, + "contributorEmails": { + "description": "Optional. If you want your own labeling contributors to manage and work on this labeling request, you can set these contributors here. We will give them access to the question types in crowdcompute. Note that these emails must be registered in crowdcompute worker UI: https://crowd-compute.appspot.com/", + "items": { + "type": "string" + }, + "type": "array" + }, + "instruction": { + "description": "Required. Instruction resource name.", + "type": "string" + }, + "labelGroup": { + "description": "Optional. A human-readable label used to logically group labeling tasks. This string must match the regular expression `[a-zA-Z\\\\d_-]{0,128}`.", + "type": "string" + }, + "languageCode": { + "description": "Optional. The Language of this question, as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Default value is en-US. Only need to set this when task is language related. For example, French text classification.", + "type": "string" + }, + "questionDuration": { + "description": "Optional. Maximum duration for contributors to answer a question. Maximum is 3600 seconds. Default is 3600 seconds.", + "format": "google-duration", + "type": "string" + }, + "replicaCount": { + "description": "Optional. Replication of questions. Each question will be sent to up to this number of contributors to label. Aggregated answers will be returned. Default is set to 1. For image related labeling, valid values are 1, 3, 5.", + "format": "int32", + "type": "integer" + }, + "userEmailAddress": { + "description": "Email of the user who started the labeling task and should be notified by email. If empty no notification will be sent.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata": { + "description": "Metadata of an ImportData operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationMetadata", + "properties": { + "createTime": { + "description": "Output only. Timestamp when import dataset request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of imported dataset. \"projects/*/datasets/*\"", + "type": "string" + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse": { + "description": "Response used for ImportData longrunning operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1ImportDataOperationResponse", + "properties": { + "dataset": { + "description": "Ouptut only. The name of imported dataset.", + "type": "string" + }, + "importCount": { + "description": "Output only. Number of examples imported successfully.", + "format": "int32", + "type": "integer" + }, + "totalCount": { + "description": "Output only. Total number of examples requested to import", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata": { + "description": "Details of LabelImageBoundingPoly operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata": { + "description": "Metadata of a LabelImageClassification operation.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata": { + "description": "Details of a LabelImageOrientedBoundingBox operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata": { + "description": "Details of LabelImagePolyline operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata": { + "description": "Details of a LabelImageSegmentation operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata": { + "description": "Metadata of a labeling operation, such as LabelImage or LabelVideo. Next tag: 23", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelOperationMetadata", + "properties": { + "annotatedDataset": { + "description": "Output only. The name of annotated dataset in format \"projects/*/datasets/*/annotatedDatasets/*\".", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when labeling request was created.", + "format": "google-datetime", + "type": "string" + }, + "dataset": { + "description": "Output only. The name of dataset to be labeled. \"projects/*/datasets/*\"", + "type": "string" + }, + "imageBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingBoxOperationMetadata", + "description": "Details of label image bounding box operation." + }, + "imageBoundingPolyDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageBoundingPolyOperationMetadata", + "description": "Details of label image bounding poly operation." + }, + "imageClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageClassificationOperationMetadata", + "description": "Details of label image classification operation." + }, + "imageOrientedBoundingBoxDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageOrientedBoundingBoxOperationMetadata", + "description": "Details of label image oriented bounding box operation." + }, + "imagePolylineDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImagePolylineOperationMetadata", + "description": "Details of label image polyline operation." + }, + "imageSegmentationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelImageSegmentationOperationMetadata", + "description": "Details of label image segmentation operation." + }, + "partialFailures": { + "description": "Output only. Partial failures encountered. E.g. single files that couldn't be read. Status details field will contain standard GCP error details.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "progressPercent": { + "description": "Output only. Progress of label operation. Range: [0, 100].", + "format": "int32", + "type": "integer" + }, + "textClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", + "description": "Details of label text classification operation." + }, + "textEntityExtractionDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata", + "description": "Details of label text entity extraction operation." + }, + "videoClassificationDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", + "description": "Details of label video classification operation." + }, + "videoEventDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", + "description": "Details of label video event operation." + }, + "videoObjectDetectionDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata", + "description": "Details of label video object detection operation." + }, + "videoObjectTrackingDetails": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", + "description": "Details of label video object tracking operation." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelStats": { + "description": "Statistics about annotation specs.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelStats", + "properties": { + "exampleCount": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Map of each annotation spec's example count. Key is the annotation spec name and value is the number of examples for that annotation spec. If the annotated dataset does not have annotation spec, the map will return a pair where the key is empty string and value is the total number of annotations.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata": { + "description": "Details of a LabelTextClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata": { + "description": "Details of a LabelTextEntityExtraction operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelTextEntityExtractionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata": { + "description": "Details of a LabelVideoClassification operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoClassificationOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata": { + "description": "Details of a LabelVideoEvent operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoEventOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata": { + "description": "Details of a LabelVideoObjectDetection operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectDetectionOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata": { + "description": "Details of a LabelVideoObjectTracking operation metadata.", + "id": "GoogleCloudDatalabelingV1p2alpha1LabelVideoObjectTrackingOperationMetadata", + "properties": { + "basicConfig": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1HumanAnnotationConfig", + "description": "Basic human annotation config used in labeling request." + } + }, + "type": "object" + }, + "GoogleCloudDatalabelingV1p2alpha1OutputConfig": { + "description": "The configuration of output data.", + "id": "GoogleCloudDatalabelingV1p2alpha1OutputConfig", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsDestination", + "description": "Output to a file in Cloud Storage. Should be used for labeling output other than image segmentation." + }, + "gcsFolderDestination": { + "$ref": "GoogleCloudDatalabelingV1p2alpha1GcsFolderDestination", + "description": "Output to a folder in Cloud Storage. Should be used for image segmentation or document de-identification labeling outputs." + } + }, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Data Labeling API", + "version": "v1beta1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/datamigration__v1beta1.json b/discovery/googleapis_beta/datamigration__v1beta1.json new file mode 100644 index 0000000..96ab889 --- /dev/null +++ b/discovery/googleapis_beta/datamigration__v1beta1.json
@@ -0,0 +1,2147 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://datamigration.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Database Migration Service", + "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/database-migration/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "datamigration:v1beta1", + "kind": "discovery#restDescription", + "name": "datamigration", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "connectionProfiles": { + "methods": { + "create": { + "description": "Creates a new connection profile in a given project and location.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.connectionProfiles.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "connectionProfileId": { + "description": "Required. The connection profile identifier.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of connection profiles.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/connectionProfiles", + "request": { + "$ref": "ConnectionProfile" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.", + "httpMethod": "DELETE", + "id": "datamigration.projects.locations.connectionProfiles.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the connection profile resource to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single connection profile.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.connectionProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the connection profile resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "ConnectionProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.connectionProfiles.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Retrieve a list of all connection profiles in a given project and location.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.connectionProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can also filter nested fields. For example, you could specify **mySql.username = %lt;my_username%gt;** to list all connection profiles configured to connect with a specific username.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "the order by fields for the result.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectionProfiles` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of connection profiles.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/connectionProfiles", + "response": { + "$ref": "ListConnectionProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update the configuration of a single connection profile.", + "httpMethod": "PATCH", + "id": "datamigration.projects.locations.connectionProfiles.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "ConnectionProfile" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.connectionProfiles.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.connectionProfiles.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "migrationJobs": { + "methods": { + "create": { + "description": "Creates a new migration job in a given project and location.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "migrationJobId": { + "description": "Required. The ID of the instance to create.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of migration jobs.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/migrationJobs", + "request": { + "$ref": "MigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single migration job.", + "httpMethod": "DELETE", + "id": "datamigration.projects.locations.migrationJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "The destination CloudSQL connection profile is always deleted with the migration job. In case of force delete, the destination CloudSQL replica database is also deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the migration job resource to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSshScript": { + "description": "Generate a SSH configuration script to configure the reverse SSH connectivity.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.generateSshScript", + "parameterOrder": [ + "migrationJob" + ], + "parameters": { + "migrationJob": { + "description": "Name of the migration job resource to generate the SSH script.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+migrationJob}:generateSshScript", + "request": { + "$ref": "GenerateSshScriptRequest" + }, + "response": { + "$ref": "SshScript" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single migration job.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.migrationJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the migration job resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "MigrationJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.migrationJobs.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists migration jobs in a given project and location.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.migrationJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **reverseSshConnectivity.vmIp = \"1.2.3.4\"** to select all migration jobs connecting through the specific SSH tunnel bastion.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sort the results based on the migration job name. Valid values are: \"name\", \"name asc\", and \"name desc\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The nextPageToken value received in the previous call to migrationJobs.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to migrationJobs.list must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of migrationJobs.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/migrationJobs", + "response": { + "$ref": "ListMigrationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single migration job.", + "httpMethod": "PATCH", + "id": "datamigration.projects.locations.migrationJobs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "MigrationJob" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "promote": { + "description": "Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.promote", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to promote.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:promote", + "request": { + "$ref": "PromoteMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restart": { + "description": "Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.restart", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to restart.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:restart", + "request": { + "$ref": "RestartMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to resume.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:resume", + "request": { + "$ref": "ResumeMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "start": { + "description": "Start an already created migration job.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.start", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to start.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:start", + "request": { + "$ref": "StartMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stop": { + "description": "Stops a running migration job.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.stop", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to stop.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:stop", + "request": { + "$ref": "StopMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "verify": { + "description": "Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.verify", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the migration job resource to verify.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:verify", + "request": { + "$ref": "VerifyMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "datamigration.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "datamigration.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "datamigration.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210121", + "rootUrl": "https://datamigration.googleapis.com/", + "schemas": { + "AuditConfig": { + "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.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "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" + }, + "AuditLogConfig": { + "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.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "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 members 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)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CloudSqlConnectionProfile": { + "description": "Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance.", + "id": "CloudSqlConnectionProfile", + "properties": { + "cloudSqlId": { + "description": "Output only. The Cloud SQL instance ID that this connection profile is associated with.", + "readOnly": true, + "type": "string" + }, + "privateIp": { + "description": "Output only. The Cloud SQL database instance's private IP.", + "readOnly": true, + "type": "string" + }, + "publicIp": { + "description": "Output only. The Cloud SQL database instance's public IP.", + "readOnly": true, + "type": "string" + }, + "settings": { + "$ref": "CloudSqlSettings", + "description": "Immutable. Metadata used to create the destination Cloud SQL database." + } + }, + "type": "object" + }, + "CloudSqlSettings": { + "description": "Settings for creating a Cloud SQL database instance.", + "id": "CloudSqlSettings", + "properties": { + "activationPolicy": { + "description": "The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.", + "enum": [ + "SQL_ACTIVATION_POLICY_UNSPECIFIED", + "ALWAYS", + "NEVER" + ], + "enumDescriptions": [ + "unspecified policy.", + "The instance is always up and running.", + "The instance should never spin up." + ], + "type": "string" + }, + "autoStorageIncrease": { + "description": "[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.", + "type": "boolean" + }, + "dataDiskSizeGb": { + "description": "The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.", + "format": "int64", + "type": "string" + }, + "dataDiskType": { + "description": "The type of storage: `PD_SSD` (default) or `PD_HDD`.", + "enum": [ + "SQL_DATA_DISK_TYPE_UNSPECIFIED", + "PD_SSD", + "PD_HDD" + ], + "enumDescriptions": [ + "Unspecified.", + "SSD disk.", + "HDD disk." + ], + "type": "string" + }, + "databaseFlags": { + "additionalProperties": { + "type": "string" + }, + "description": "The database flags passed to the Cloud SQL instance at startup. An object containing a list of \"key\": value pairs. Example: { \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }.", + "type": "object" + }, + "databaseVersion": { + "description": "The database engine type and version.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_6", + "MYSQL_5_7", + "MYSQL_8_0" + ], + "enumDescriptions": [ + "Unspecified version.", + "MySQL 5.6.", + "MySQL 5.7.", + "MySQL 8.0." + ], + "type": "string" + }, + "ipConfig": { + "$ref": "SqlIpConfig", + "description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled." + }, + "rootPassword": { + "description": "Input only. Initial root password.", + "type": "string" + }, + "rootPasswordSet": { + "description": "Output only. Indicates If this connection profile root password is stored.", + "readOnly": true, + "type": "boolean" + }, + "sourceId": { + "description": "The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`", + "type": "string" + }, + "storageAutoResizeLimit": { + "description": "The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.", + "format": "int64", + "type": "string" + }, + "tier": { + "description": "The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).", + "type": "string" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of \"key\": \"value\" pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"18kg\", \"count\": \"3\" }`.", + "type": "object" + }, + "zone": { + "description": "The Google Cloud Platform zone where your Cloud SQL datdabse instance is located.", + "type": "string" + } + }, + "type": "object" + }, + "ConnectionProfile": { + "description": "A connection profile definition.", + "id": "ConnectionProfile", + "properties": { + "cloudsql": { + "$ref": "CloudSqlConnectionProfile", + "description": "A CloudSQL database connection profile." + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The connection profile display name.", + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. The error details in case of state FAILED.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of \"key\": \"value\" pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`.", + "type": "object" + }, + "mysql": { + "$ref": "MySqlConnectionProfile", + "description": "A MySQL database connection profile." + }, + "name": { + "description": "The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.", + "type": "string" + }, + "provider": { + "description": "The database provider.", + "enum": [ + "DATABASE_PROVIDER_UNSPECIFIED", + "CLOUDSQL", + "RDS" + ], + "enumDescriptions": [ + "The database provider is unknown.", + "CloudSQL runs the database.", + "RDS runs the database." + ], + "type": "string" + }, + "state": { + "description": "The current connection profile state (e.g. DRAFT, READY, or FAILED).", + "enum": [ + "STATE_UNSPECIFIED", + "DRAFT", + "CREATING", + "READY", + "UPDATING", + "DELETING", + "DELETED", + "FAILED" + ], + "enumDescriptions": [ + "The state of the connection profile is unknown.", + "The connection profile is in draft mode and fully editable.", + "The connection profile is being created.", + "The connection profile is ready.", + "The connection profile is being updated.", + "The connection profile is being deleted.", + "The connection profile has been deleted.", + "The last action on the connection profile failed." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DatabaseType": { + "description": "A message defining the database engine and provider.", + "id": "DatabaseType", + "properties": { + "engine": { + "description": "The database engine.", + "enum": [ + "DATABASE_ENGINE_UNSPECIFIED", + "MYSQL" + ], + "enumDescriptions": [ + "The source database engine of the migration job is unknown.", + "The source engine is MySQL." + ], + "type": "string" + }, + "provider": { + "description": "The database provider.", + "enum": [ + "DATABASE_PROVIDER_UNSPECIFIED", + "CLOUDSQL", + "RDS" + ], + "enumDescriptions": [ + "The database provider is unknown.", + "CloudSQL runs the database.", + "RDS runs the database." + ], + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Expr": { + "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() < 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", + "properties": { + "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" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "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" + }, + "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" + }, + "GenerateSshScriptRequest": { + "description": "Request message for 'GenerateSshScript' request.", + "id": "GenerateSshScriptRequest", + "properties": { + "vm": { + "description": "Required. Bastion VM Instance name to use or to create.", + "type": "string" + }, + "vmCreationConfig": { + "$ref": "VmCreationConfig", + "description": "The VM creation configuration" + }, + "vmPort": { + "description": "The port that will be open on the bastion host", + "format": "int32", + "type": "integer" + }, + "vmSelectionConfig": { + "$ref": "VmSelectionConfig", + "description": "The VM selection configuration" + } + }, + "type": "object" + }, + "GoogleCloudClouddmsV1beta1OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudClouddmsV1beta1OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListConnectionProfilesResponse": { + "description": "Response message for 'ListConnectionProfiles' request.", + "id": "ListConnectionProfilesResponse", + "properties": { + "connectionProfiles": { + "description": "The response list of connection profiles.", + "items": { + "$ref": "ConnectionProfile" + }, + "type": "array" + }, + "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" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListMigrationJobsResponse": { + "description": "Response message for 'ListMigrationJobs' request.", + "id": "ListMigrationJobsResponse", + "properties": { + "migrationJobs": { + "description": "The list of migration jobs objects.", + "items": { + "$ref": "MigrationJob" + }, + "type": "array" + }, + "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" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "MigrationJob": { + "description": "Represents a Database Migration Service migration job object.", + "id": "MigrationJob", + "properties": { + "createTime": { + "description": "Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "destination": { + "description": "Required. The resource name (URI) of the destination connection profile.", + "type": "string" + }, + "destinationDatabase": { + "$ref": "DatabaseType", + "description": "The database engine type and provider of the destination." + }, + "displayName": { + "description": "The migration job display name.", + "type": "string" + }, + "dumpPath": { + "description": "The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).", + "type": "string" + }, + "duration": { + "description": "Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: \"3.5s\".", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. If the migration job is completed, the time when it was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "Output only. The error details in case of state FAILED.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of \"key\": \"value\" pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`.", + "type": "object" + }, + "name": { + "description": "The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.", + "type": "string" + }, + "phase": { + "description": "Output only. The current migration job phase.", + "enum": [ + "PHASE_UNSPECIFIED", + "FULL_DUMP", + "CDC", + "PROMOTE_IN_PROGRESS", + "WAITING_FOR_SOURCE_WRITES_TO_STOP", + "PREPARING_THE_DUMP" + ], + "enumDescriptions": [ + "The phase of the migration job is unknown.", + "The migration job is in the full dump phase.", + "The migration job is CDC phase.", + "The migration job is running the promote phase.", + "Only RDS flow - waiting for source writes to stop", + "Only RDS flow - the sources writes stopped, waiting for dump to begin" + ], + "readOnly": true, + "type": "string" + }, + "reverseSshConnectivity": { + "$ref": "ReverseSshConnectivity", + "description": "The details needed to communicate to the source over Reverse SSH tunnel connectivity." + }, + "source": { + "description": "Required. The resource name (URI) of the source connection profile.", + "type": "string" + }, + "sourceDatabase": { + "$ref": "DatabaseType", + "description": "The database engine type and provider of the source." + }, + "state": { + "description": "The current migration job state.", + "enum": [ + "STATE_UNSPECIFIED", + "MAINTENANCE", + "DRAFT", + "CREATING", + "NOT_STARTED", + "RUNNING", + "FAILED", + "COMPLETED", + "DELETING", + "STOPPING", + "STOPPED", + "DELETED", + "UPDATING", + "STARTING", + "RESTARTING", + "RESUMING" + ], + "enumDescriptions": [ + "The state of the migration job is unknown.", + "The migration job is down for maintenance.", + "The migration job is in draft mode and no resources are created.", + "The migration job is being created.", + "The migration job is created, not started and is fully editable.", + "The migration job is running.", + "The migration job failed.", + "The migration job has been completed.", + "The migration job is being deleted.", + "The migration job is being stopped.", + "The migration job is currently stopped.", + "The migration job has been deleted.", + "The migration job is being updated.", + "The migration job is starting.", + "The migration job is restarting.", + "The migration job is resuming." + ], + "type": "string" + }, + "staticIpConnectivity": { + "$ref": "StaticIpConnectivity", + "description": "static ip connectivity data (default, no additional details needed)." + }, + "type": { + "description": "Required. The migration job type.", + "enum": [ + "TYPE_UNSPECIFIED", + "ONE_TIME", + "CONTINUOUS" + ], + "enumDescriptions": [ + "The type of the migration job is unknown.", + "The migration job is a one time migration.", + "The migration job is a continuous migration." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: \"2014-10-02T15:01:23.045123456Z\".", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vpcPeeringConnectivity": { + "$ref": "VpcPeeringConnectivity", + "description": "The details of the VPC network that the source database is located in." + } + }, + "type": "object" + }, + "MigrationJobVerificationError": { + "description": "Error message of a verification Migration job.", + "id": "MigrationJobVerificationError", + "properties": { + "errorCode": { + "description": "Output only. An instance of ErrorCode specifying the error that occurred.", + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "CONNECTION_FAILURE", + "AUTHENTICATION_FAILURE", + "INVALID_CONNECTION_PROFILE_CONFIG", + "VERSION_INCOMPATIBILITY", + "CONNECTION_PROFILE_TYPES_INCOMPATIBILITY", + "UNSUPPORTED_GTID_MODE", + "UNSUPPORTED_DEFINER" + ], + "enumDescriptions": [ + "An unknown error occurred", + "We failed to connect to one of the connection profile.", + "We failed to authenticate to one of the connection profile.", + "One of the involved connection profiles has an invalid configuration.", + "The versions of the source and the destination are incompatible.", + "The types of the source and the destination are incompatible.", + "The gtid_mode is not supported, applicable for MySQL.", + "The definer is not supported." + ], + "readOnly": true, + "type": "string" + }, + "errorDetailMessage": { + "description": "Output only. A specific detailed error message, if supplied by the engine.", + "readOnly": true, + "type": "string" + }, + "errorMessage": { + "description": "Output only. A formatted message with further details about the error and a CTA.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MySqlConnectionProfile": { + "description": "Specifies connection parameters required specifically for MySQL databases.", + "id": "MySqlConnectionProfile", + "properties": { + "cloudSqlId": { + "description": "If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.", + "type": "string" + }, + "host": { + "description": "Required. The IP or hostname of the source MySQL database.", + "type": "string" + }, + "password": { + "description": "Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.", + "type": "string" + }, + "passwordSet": { + "description": "Output only. Indicates If this connection profile password is stored.", + "readOnly": true, + "type": "boolean" + }, + "port": { + "description": "Required. The network port of the source MySQL database.", + "format": "int32", + "type": "integer" + }, + "ssl": { + "$ref": "SslConfig", + "description": "SSL configuration for the destination to connect to the source database." + }, + "username": { + "description": "Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "Policy": { + "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` to a single `role`. Members 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 < 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 < 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/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to 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 member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "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" + }, + "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PromoteMigrationJobRequest": { + "description": "Request message for 'PromoteMigrationJob' request.", + "id": "PromoteMigrationJobRequest", + "properties": {}, + "type": "object" + }, + "RestartMigrationJobRequest": { + "description": "Request message for 'RestartMigrationJob' request.", + "id": "RestartMigrationJobRequest", + "properties": {}, + "type": "object" + }, + "ResumeMigrationJobRequest": { + "description": "Request message for 'ResumeMigrationJob' request.", + "id": "ResumeMigrationJobRequest", + "properties": {}, + "type": "object" + }, + "ReverseSshConnectivity": { + "description": "The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1beta1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.", + "id": "ReverseSshConnectivity", + "properties": { + "vm": { + "description": "The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.", + "type": "string" + }, + "vmIp": { + "description": "Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.", + "type": "string" + }, + "vmPort": { + "description": "Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.", + "format": "int32", + "type": "integer" + }, + "vpc": { + "description": "The name of the VPC to peer with the Cloud SQL private network.", + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "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 Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "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\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "SqlAclEntry": { + "description": "An entry for an Access Control list.", + "id": "SqlAclEntry", + "properties": { + "expireTime": { + "description": "The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.", + "format": "google-datetime", + "type": "string" + }, + "label": { + "description": "A label to identify this entry.", + "type": "string" + }, + "ttl": { + "description": "Input only. The time-to-leave of this access control entry.", + "format": "google-duration", + "type": "string" + }, + "value": { + "description": "The allowlisted value for the access control list.", + "type": "string" + } + }, + "type": "object" + }, + "SqlIpConfig": { + "description": "IP Management configuration.", + "id": "SqlIpConfig", + "properties": { + "authorizedNetworks": { + "description": "The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).", + "items": { + "$ref": "SqlAclEntry" + }, + "type": "array" + }, + "enableIpv4": { + "description": "Whether the instance should be assigned an IPv4 address or not.", + "type": "boolean" + }, + "privateNetwork": { + "description": "The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.", + "type": "string" + }, + "requireSsl": { + "description": "Whether SSL connections over IP should be enforced or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "SshScript": { + "description": "Response message for 'GenerateSshScript' request.", + "id": "SshScript", + "properties": { + "script": { + "description": "The ssh configuration script.", + "type": "string" + } + }, + "type": "object" + }, + "SslConfig": { + "description": "SSL configuration information.", + "id": "SslConfig", + "properties": { + "caCertificate": { + "description": "Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.", + "type": "string" + }, + "clientCertificate": { + "description": "Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.", + "type": "string" + }, + "clientKey": { + "description": "Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.", + "type": "string" + }, + "type": { + "description": "Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.", + "enum": [ + "SSL_TYPE_UNSPECIFIED", + "SERVER_ONLY", + "SERVER_CLIENT" + ], + "enumDescriptions": [ + "Unspecified.", + "Only 'ca_certificate' specified.", + "Both server ('ca_certificate'), and client ('client_key', 'client_certificate') specified." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "StartMigrationJobRequest": { + "description": "Request message for 'StartMigrationJob' request.", + "id": "StartMigrationJobRequest", + "properties": {}, + "type": "object" + }, + "StaticIpConnectivity": { + "description": "The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required.", + "id": "StaticIpConnectivity", + "properties": {}, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "StopMigrationJobRequest": { + "description": "Request message for 'StopMigrationJob' request.", + "id": "StopMigrationJobRequest", + "properties": {}, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "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": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "VerifyMigrationJobRequest": { + "description": "Request message for 'VerifyMigrationJob' request.", + "id": "VerifyMigrationJobRequest", + "properties": {}, + "type": "object" + }, + "VmCreationConfig": { + "description": "VM creation configuration message", + "id": "VmCreationConfig", + "properties": { + "subnet": { + "description": "The subnet name the vm needs to be created in.", + "type": "string" + }, + "vmMachineType": { + "description": "Required. VM instance machine type to create.", + "type": "string" + }, + "vmZone": { + "description": "The Google Cloud Platform zone to create the VM in.", + "type": "string" + } + }, + "type": "object" + }, + "VmSelectionConfig": { + "description": "VM selection configuration message", + "id": "VmSelectionConfig", + "properties": { + "vmZone": { + "description": "Required. The Google Cloud Platform zone the VM is located.", + "type": "string" + } + }, + "type": "object" + }, + "VpcPeeringConnectivity": { + "description": "The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC.", + "id": "VpcPeeringConnectivity", + "properties": { + "vpc": { + "description": "The name of the VPC network to peer with the Cloud SQL private network.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Database Migration API", + "version": "v1beta1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/dialogflow__v2beta1.json b/discovery/googleapis_beta/dialogflow__v2beta1.json deleted file mode 100644 index ccf3005..0000000 --- a/discovery/googleapis_beta/dialogflow__v2beta1.json +++ /dev/null
@@ -1,9468 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/dialogflow": { - "description": "View, manage and query your Dialogflow agents" - } - } - } - }, - "basePath": "", - "baseUrl": "https://dialogflow.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Dialogflow", - "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/dialogflow/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "dialogflow:v2beta1", - "kind": "discovery#restDescription", - "name": "dialogflow", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "methods": { - "deleteAgent": { - "description": "Deletes the specified agent.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.deleteAgent", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to delete is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "getAgent": { - "description": "Retrieves the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.getAgent", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to fetch is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Agent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "setAgent": { - "description": "Creates/updates the specified agent.", - "httpMethod": "POST", - "id": "dialogflow.projects.setAgent", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Agent" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Agent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "agent": { - "methods": { - "export": { - "description": "Exports the specified agent to a ZIP file. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.export", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to export is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:export", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1ExportAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "getFulfillment": { - "description": "Retrieves the fulfillment.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.getFulfillment", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`", - "location": "path", - "pattern": "^projects/[^/]+/agent/fulfillment$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "getValidationResult": { - "description": "Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.getValidationResult", - "parameterOrder": [ - "parent" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project that the agent is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent/validationResult", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ValidationResult" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "import": { - "description": "Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.import", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to import is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:import", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1ImportAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "restore": { - "description": "Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.restore", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to restore is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:restore", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1RestoreAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "search": { - "description": "Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id \"-\". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.search", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project to list agents from. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:search", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SearchAgentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "train": { - "description": "Trains the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.train", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to train is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:train", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1TrainAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "updateFulfillment": { - "description": "Updates the fulfillment.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.updateFulfillment", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`", - "location": "path", - "pattern": "^projects/[^/]+/agent/fulfillment$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "entityTypes": { - "methods": { - "batchDelete": { - "description": "Deletes entity types in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.entityTypes.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent`, - `projects//locations//agent`.", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes:batchDelete", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchUpdate": { - "description": "Updates/Creates multiple entity types in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.entityTypes.batchUpdate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to update or create entity types in. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes:batchUpdate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "create": { - "description": "Creates an entity type in the specified agent.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.entityTypes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to create a entity type for. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified entity type.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.entityTypes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified entity type.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.entityTypes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the entity type. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all entity types in the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.entityTypes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to list all entity types from. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified entity type.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "entities": { - "methods": { - "batchCreate": { - "description": "Creates multiple new entities in the specified entity type. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the entity type to create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entities:batchCreate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchDelete": { - "description": "Deletes entities in the specified entity type. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the entity type to delete entries for. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entities:batchDelete", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchUpdate": { - "description": "Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the entity type to update or create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entities:batchUpdate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - }, - "environments": { - "methods": { - "list": { - "description": "Returns the list of all non-draft environments of the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.environments.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/environments", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "users": { - "resources": { - "sessions": { - "methods": { - "deleteContexts": { - "description": "Deletes all active contexts in the specified session.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.environments.users.sessions.deleteContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "detectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.environments.users.sessions.detectIntent", - "parameterOrder": [ - "session" - ], - "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+session}:detectIntent", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "contexts": { - "methods": { - "create": { - "description": "Creates a context. If the specified context already exists, overrides the context.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.environments.users.sessions.contexts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified context.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.environments.users.sessions.contexts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified context.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.environments.users.sessions.contexts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all contexts in the specified session.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.environments.users.sessions.contexts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified context.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.environments.users.sessions.contexts.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - }, - "entityTypes": { - "methods": { - "create": { - "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.environments.users.sessions.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "location": "path", - "pattern": "^projects/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - } - } - } - } - }, - "intents": { - "methods": { - "batchDelete": { - "description": "Deletes intents in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.intents.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents:batchDelete", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchUpdate": { - "description": "Updates/Creates multiple intents in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.intents.batchUpdate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to update or create intents in. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents:batchUpdate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "create": { - "description": "Creates an intent in the specified agent.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.intents.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to create a intent for. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified intent and its direct or indirect followup intents.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.intents.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/intents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified intent.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.intents.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the intent. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/intents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all intents in the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.intents.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to list all intents from. Format: `projects//agent`.", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified intent.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.intents.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/intents/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - }, - "knowledgeBases": { - "methods": { - "create": { - "description": "Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.knowledgeBases.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project to create a knowledge base for. Format: `projects/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/knowledgeBases", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.knowledgeBases.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the knowledge base to delete. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.knowledgeBases.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the knowledge base to retrieve. Format `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all knowledge bases of the specified agent. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.knowledgeBases.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains \"articles\". * 'display_name:\"Best Articles\"' matches knowledge bases whose display name contains \"Best Articles\". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains \"articles\" and whose language code is \"en-gb\". Note: An empty filter string (i.e. \"\") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project to list of knowledge bases for. Format: `projects/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/knowledgeBases", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.knowledgeBases.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "documents": { - "methods": { - "create": { - "description": "Creates a new document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.knowledgeBases.documents.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/documents", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Document" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.knowledgeBases.documents.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the document to delete. Format: `projects//knowledgeBases//documents/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.knowledgeBases.documents.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Document" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all documents of the knowledge base. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.knowledgeBases.documents.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * \"knowledge_types:FAQ\" matches documents with FAQ knowledge type. * \"display_name:customer\" matches documents whose display name contains \"customer\". * \"state=ACTIVE\" matches documents with ACTIVE state. * \"knowledge_types:FAQ AND state=ACTIVE\" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The knowledge base to list all documents for. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/documents", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.knowledgeBases.documents.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Optional. The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`.", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Document" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "reload": { - "description": "Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.knowledgeBases.documents.reload", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the document to reload. Format: `projects//knowledgeBases//documents/`", - "location": "path", - "pattern": "^projects/[^/]+/agent/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}:reload", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - }, - "sessions": { - "methods": { - "deleteContexts": { - "description": "Deletes all active contexts in the specified session.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.sessions.deleteContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "detectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.sessions.detectIntent", - "parameterOrder": [ - "session" - ], - "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+session}:detectIntent", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "contexts": { - "methods": { - "create": { - "description": "Creates a context. If the specified context already exists, overrides the context.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.sessions.contexts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified context.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.sessions.contexts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified context.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.sessions.contexts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all contexts in the specified session.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.sessions.contexts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified context.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.sessions.contexts.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - }, - "entityTypes": { - "methods": { - "create": { - "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "POST", - "id": "dialogflow.projects.agent.sessions.entityTypes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.agent.sessions.entityTypes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.sessions.entityTypes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.agent.sessions.entityTypes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.agent.sessions.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "location": "path", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - } - } - }, - "knowledgeBases": { - "methods": { - "create": { - "description": "Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "POST", - "id": "dialogflow.projects.knowledgeBases.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project to create a knowledge base for. Format: `projects/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/knowledgeBases", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.knowledgeBases.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the knowledge base to delete. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "GET", - "id": "dialogflow.projects.knowledgeBases.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the knowledge base to retrieve. Format `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all knowledge bases of the specified agent. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "GET", - "id": "dialogflow.projects.knowledgeBases.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The filter expression used to filter knowledge bases returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * display_name with has(:) operator * language_code with equals(=) operator Examples: * 'language_code=en-us' matches knowledge bases with en-us language code. * 'display_name:articles' matches knowledge bases whose display name contains \"articles\". * 'display_name:\"Best Articles\"' matches knowledge bases whose display name contains \"Best Articles\". * 'language_code=en-gb AND display_name=articles' matches all knowledge bases whose display name contains \"articles\" and whose language code is \"en-gb\". Note: An empty filter string (i.e. \"\") is a no-op and will result in no filtering. For more information about filtering, see [API Filtering](https://aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project to list of knowledge bases for. Format: `projects/`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/knowledgeBases", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.knowledgeBases.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "documents": { - "methods": { - "create": { - "description": "Creates a new document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "POST", - "id": "dialogflow.projects.knowledgeBases.documents.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The knoweldge base to create a document for. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/documents", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Document" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.knowledgeBases.documents.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the document to delete. Format: `projects//knowledgeBases//documents/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "GET", - "id": "dialogflow.projects.knowledgeBases.documents.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the document to retrieve. Format `projects//knowledgeBases//documents/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Document" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all documents of the knowledge base. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "GET", - "id": "dialogflow.projects.knowledgeBases.documents.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The filter expression used to filter documents returned by the list method. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * knowledge_types with has(:) operator * display_name with has(:) operator * state with equals(=) operator Examples: * \"knowledge_types:FAQ\" matches documents with FAQ knowledge type. * \"display_name:customer\" matches documents whose display name contains \"customer\". * \"state=ACTIVE\" matches documents with ACTIVE state. * \"knowledge_types:FAQ AND state=ACTIVE\" matches all active FAQ documents. For more information about filtering, see [API Filtering](https://aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return in a single page. By default 10 and at most 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The knowledge base to list all documents for. Format: `projects//knowledgeBases/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/documents", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListDocumentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified document. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.knowledgeBases.documents.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Optional. The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`.", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Document" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "reload": { - "description": "Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "httpMethod": "POST", - "id": "dialogflow.projects.knowledgeBases.documents.reload", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the document to reload. Format: `projects//knowledgeBases//documents/`", - "location": "path", - "pattern": "^projects/[^/]+/knowledgeBases/[^/]+/documents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}:reload", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - }, - "locations": { - "methods": { - "deleteAgent": { - "description": "Deletes the specified agent.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.deleteAgent", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to delete is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "getAgent": { - "description": "Retrieves the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.getAgent", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to fetch is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Agent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "setAgent": { - "description": "Creates/updates the specified agent.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.setAgent", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Agent" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Agent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "agent": { - "methods": { - "export": { - "description": "Exports the specified agent to a ZIP file. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.export", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to export is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:export", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1ExportAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "getFulfillment": { - "description": "Retrieves the fulfillment.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.getFulfillment", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/fulfillment$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "getValidationResult": { - "description": "Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.getValidationResult", - "parameterOrder": [ - "parent" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project that the agent is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent/validationResult", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ValidationResult" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "import": { - "description": "Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when importing is complete. It only tracks when the draft agent is updated not when it is done training.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.import", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to import is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:import", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1ImportAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "restore": { - "description": "Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly. Operation An operation which tracks when restoring is complete. It only tracks when the draft agent is updated not when it is done training.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.restore", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to restore is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:restore", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1RestoreAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "search": { - "description": "Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id \"-\". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.search", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The project to list agents from. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:search", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SearchAgentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "train": { - "description": "Trains the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.train", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to train is associated with. Format: `projects/` or `projects//locations/`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/agent:train", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1TrainAgentRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "updateFulfillment": { - "description": "Updates the fulfillment.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.updateFulfillment", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/fulfillment$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Fulfillment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "entityTypes": { - "methods": { - "batchDelete": { - "description": "Deletes entity types in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.entityTypes.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent`, - `projects//locations//agent`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes:batchDelete", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchUpdate": { - "description": "Updates/Creates multiple entity types in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.entityTypes.batchUpdate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to update or create entity types in. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes:batchUpdate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "create": { - "description": "Creates an entity type in the specified agent.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.entityTypes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to create a entity type for. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified entity type.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.entityTypes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified entity type.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.entityTypes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the entity type. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all entity types in the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.entityTypes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to list all entity types from. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified entity type.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "entities": { - "methods": { - "batchCreate": { - "description": "Creates multiple new entities in the specified entity type. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.entityTypes.entities.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the entity type to create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entities:batchCreate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchDelete": { - "description": "Deletes entities in the specified entity type. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.entityTypes.entities.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the entity type to delete entries for. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entities:batchDelete", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchUpdate": { - "description": "Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.entityTypes.entities.batchUpdate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the entity type to update or create entities in. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entities:batchUpdate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - }, - "environments": { - "methods": { - "list": { - "description": "Returns the list of all non-draft environments of the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.environments.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to list all environments from. Format: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/environments", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "users": { - "resources": { - "sessions": { - "methods": { - "deleteContexts": { - "description": "Deletes all active contexts in the specified session.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.deleteContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "detectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.detectIntent", - "parameterOrder": [ - "session" - ], - "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+session}:detectIntent", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "contexts": { - "methods": { - "create": { - "description": "Creates a context. If the specified context already exists, overrides the context.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified context.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified context.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all contexts in the specified session.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified context.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.contexts.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - }, - "entityTypes": { - "methods": { - "create": { - "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.environments.users.sessions.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/environments/[^/]+/users/[^/]+/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - } - } - } - } - }, - "intents": { - "methods": { - "batchDelete": { - "description": "Deletes intents in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.intents.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to delete all entities types for. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents:batchDelete", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "batchUpdate": { - "description": "Updates/Creates multiple intents in the specified agent. Operation ", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.intents.batchUpdate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the agent to update or create intents in. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents:batchUpdate", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "create": { - "description": "Creates an intent in the specified agent.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.intents.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to create a intent for. Supported formats: - `projects//agent` - `projects//locations//agent`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified intent and its direct or indirect followup intents.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.intents.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the intent to delete. If this intent has direct or indirect followup intents, we also delete them. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified intent.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.intents.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the intent. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all intents in the specified agent.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.intents.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The agent to list all intents from. Format: `projects//agent`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/intents", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListIntentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified intent.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.intents.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "location": "query", - "type": "string" - }, - "name": { - "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/intents/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - }, - "sessions": { - "methods": { - "deleteContexts": { - "description": "Deletes all active contexts in the specified session.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.sessions.deleteContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the session to delete all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "detectIntent": { - "description": "Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.sessions.detectIntent", - "parameterOrder": [ - "session" - ], - "parameters": { - "session": { - "description": "Required. The name of the session this query is sent to. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we are using \"-\". It's up to the API caller to choose an appropriate `Session ID` and `User Id`. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the `Session ID` and `User ID` must not exceed 36 characters. For more information, see the [API interactions guide](https://cloud.google.com/dialogflow/docs/api-overview).", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+session}:detectIntent", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentRequest" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1DetectIntentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - }, - "resources": { - "contexts": { - "methods": { - "create": { - "description": "Creates a context. If the specified context already exists, overrides the context.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.sessions.contexts.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a context for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified context.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.sessions.contexts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context to delete. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified context.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.sessions.contexts.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all contexts in the specified session.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.sessions.contexts.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all contexts from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/contexts", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListContextsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified context.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.sessions.contexts.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - }, - "entityTypes": { - "methods": { - "create": { - "description": "Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.agent.sessions.entityTypes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The session to create a session entity type for. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "delete": { - "description": "Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "DELETE", - "id": "dialogflow.projects.locations.agent.sessions.entityTypes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the entity type to delete. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.sessions.entityTypes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.agent.sessions.entityTypes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The session to list all session entity types from. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`, If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+parent}/entityTypes", - "response": { - "$ref": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "patch": { - "description": "Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.", - "httpMethod": "PATCH", - "id": "dialogflow.projects.locations.agent.sessions.entityTypes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "request": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "response": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "httpMethod": "POST", - "id": "dialogflow.projects.locations.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", - "id": "dialogflow.projects.locations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "httpMethod": "POST", - "id": "dialogflow.projects.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "dialogflow.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", - "id": "dialogflow.projects.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/dialogflow" - ] - } - } - } - } - } - }, - "revision": "20201006", - "rootUrl": "https://dialogflow.googleapis.com/", - "schemas": { - "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { - "description": "Metadata associated with the long running operation for Versions.CreateVersion.", - "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", - "properties": { - "version": { - "description": "Name of the created version. Format: `projects//locations//agents//flows//versions/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ExportAgentResponse": { - "description": "The response message for Agents.ExportAgent.", - "id": "GoogleCloudDialogflowCxV3beta1ExportAgentResponse", - "properties": { - "agentContent": { - "description": "Uncompressed raw byte content for agent.", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ImportAgentResponse": { - "description": "The response message for Agents.ImportAgent.", - "id": "GoogleCloudDialogflowCxV3beta1ImportAgentResponse", - "properties": { - "agent": { - "description": "The unique identifier of the new agent. Format: `projects//locations//agents/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1PageInfo": { - "description": "Represents page information communicated to and from the webhook.", - "id": "GoogleCloudDialogflowCxV3beta1PageInfo", - "properties": { - "currentPage": { - "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: `projects//locations//agents//flows//pages/`.", - "type": "string" - }, - "formInfo": { - "$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo", - "description": "Optional for both WebhookRequest and WebhookResponse. Information about the form." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo": { - "description": "Represents form information.", - "id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfo", - "properties": { - "parameterInfo": { - "description": "Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.", - "items": { - "$ref": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo": { - "description": "Represents parameter information.", - "id": "GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo", - "properties": { - "displayName": { - "description": "Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.", - "type": "string" - }, - "justCollected": { - "description": "Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.", - "type": "boolean" - }, - "required": { - "description": "Optional for both WebhookRequest and WebhookResponse. Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.", - "type": "boolean" - }, - "state": { - "description": "Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.", - "enum": [ - "PARAMETER_STATE_UNSPECIFIED", - "EMPTY", - "INVALID", - "FILLED" - ], - "enumDescriptions": [ - "Not specified. This value should be never used.", - "Indicates that the parameter does not have a value.", - "Indicates that the parameter value is invalid. This field can be used by the webhook to invalidate the parameter and ask the server to collect it from the user again.", - "Indicates that the parameter has a value." - ], - "type": "string" - }, - "value": { - "description": "Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.", - "type": "any" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessage": { - "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessage", - "properties": { - "conversationSuccess": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess", - "description": "Indicates that the conversation succeeded." - }, - "endInteraction": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction", - "description": "Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` or `END_PAGE` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.", - "readOnly": true - }, - "liveAgentHandoff": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff", - "description": "Hands off conversation to a human agent." - }, - "mixedAudio": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio", - "description": "Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", - "readOnly": true - }, - "outputAudioText": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText", - "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message." - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Returns a response containing a custom, platform-specific payload.", - "type": "object" - }, - "playAudio": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio", - "description": "Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way." - }, - "text": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", - "description": "Returns a text response." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess": { - "description": "Indicates that the conversation succeeded, i.e., the bot handled the issue that the customer talked to it about. Dialogflow only uses this to determine which conversations should be counted as successful and doesn't process the metadata in this message in any way. Note that Dialogflow also considers conversations that get to the conversation end page as successful even if they don't return ConversationSuccess. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates that the conversation succeeded. * In a webhook response when you determine that you handled the customer issue.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess", - "properties": { - "metadata": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Custom metadata. Dialogflow doesn't impose any structure on this.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction": { - "description": "Indicates that interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only and not supposed to be defined by the user.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff": { - "description": "Indicates that the conversation should be handed off to a live agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff", - "properties": { - "metadata": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio": { - "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. The external URIs are specified via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio", - "properties": { - "segments": { - "description": "Segments this audio response is composed of.", - "items": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment": { - "description": "Represents one segment of audio.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment", - "properties": { - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", - "readOnly": true, - "type": "boolean" - }, - "audio": { - "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", - "format": "byte", - "type": "string" - }, - "uri": { - "description": "Client-specific URI that points to an audio clip accessible to the client. Dialogflow does not impose any validation on it.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": { - "description": "A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText", - "properties": { - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", - "readOnly": true, - "type": "boolean" - }, - "ssml": { - "description": "The SSML text to be synthesized. For more information, see [SSML](/speech/text-to-speech/docs/ssml).", - "type": "string" - }, - "text": { - "description": "The raw text to be synthesized.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": { - "description": "Specifies an audio clip to be played by the client as part of the response.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio", - "properties": { - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", - "readOnly": true, - "type": "boolean" - }, - "audioUri": { - "description": "Required. URI of the audio clip. Dialogflow does not impose any validation on this value. It is specific to the client that reads it.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1ResponseMessageText": { - "description": "The text response message.", - "id": "GoogleCloudDialogflowCxV3beta1ResponseMessageText", - "properties": { - "allowPlaybackInterruption": { - "description": "Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request.", - "readOnly": true, - "type": "boolean" - }, - "text": { - "description": "Required. A collection of text responses.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1SessionInfo": { - "description": "Represents session information communicated to and from the webhook.", - "id": "GoogleCloudDialogflowCxV3beta1SessionInfo", - "properties": { - "parameters": { - "additionalProperties": { - "type": "any" - }, - "description": "Optional for WebhookRequest. Optional for WebhookResponse. All parameters collected from forms and intents during the session. Parameters can be created, updated, or removed by the webhook. To remove a parameter from the session, the webhook should explicitly set the parameter value to null in WebhookResponse. The map is keyed by parameters' display names.", - "type": "object" - }, - "session": { - "description": "Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the session. This field can be used by the webhook to identify a user. Format: `projects//locations//agents//sessions/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1WebhookRequest": { - "description": "The request message for a webhook call.", - "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", - "properties": { - "detectIntentResponseId": { - "description": "Always present. The unique identifier of the DetectIntentResponse that will be returned to the API caller.", - "type": "string" - }, - "fulfillmentInfo": { - "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo", - "description": "Always present. Information about the fulfillment that triggered this webhook call." - }, - "intentInfo": { - "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", - "description": "Information about the last matched intent." - }, - "messages": { - "description": "The list of rich message responses to present to the user. Webhook can choose to append or replace this list in WebhookResponse.fulfillment_response;", - "items": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" - }, - "type": "array" - }, - "pageInfo": { - "$ref": "GoogleCloudDialogflowCxV3beta1PageInfo", - "description": "Information about page status." - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Custom data set in QueryParameters.payload.", - "type": "object" - }, - "sessionInfo": { - "$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo", - "description": "Information about session status." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo": { - "description": "Represents fulfillment information communicated to the webhook.", - "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo", - "properties": { - "tag": { - "description": "Always present. The tag used to identify which fulfillment is being called.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo": { - "description": "Represents intent information communicated to the webhook.", - "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo", - "properties": { - "lastMatchedIntent": { - "description": "Always present. The unique identifier of the last matched intent. Format: `projects//locations//agents//intents/`.", - "type": "string" - }, - "parameters": { - "additionalProperties": { - "$ref": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue" - }, - "description": "Parameters identified as a result of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from the user's utterance. All parameters defined in the matched intent that are identified will be surfaced here.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue": { - "description": "Represents a value for an intent parameter.", - "id": "GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue", - "properties": { - "originalValue": { - "description": "Always present. Original text value extracted from user utterance.", - "type": "string" - }, - "resolvedValue": { - "description": "Always present. Structured value for the parameter extracted from user utterance.", - "type": "any" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1WebhookResponse": { - "description": "The response message for a webhook call.", - "id": "GoogleCloudDialogflowCxV3beta1WebhookResponse", - "properties": { - "fulfillmentResponse": { - "$ref": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse", - "description": "The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user." - }, - "pageInfo": { - "$ref": "GoogleCloudDialogflowCxV3beta1PageInfo", - "description": "Information about page status. This field can be omitted by the webhook if it does not intend to modify page status." - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Value to append directly to QueryResult.webhook_payloads.", - "type": "object" - }, - "sessionInfo": { - "$ref": "GoogleCloudDialogflowCxV3beta1SessionInfo", - "description": "Information about session status. This field can be omitted by the webhook if it does not intend to modify session status." - }, - "targetFlow": { - "description": "The target flow to transition to. Format: `projects//locations//agents//flows/`.", - "type": "string" - }, - "targetPage": { - "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse": { - "description": "Represents a fulfillment response to the user.", - "id": "GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse", - "properties": { - "mergeBehavior": { - "description": "Merge behavior for `messages`.", - "enum": [ - "MERGE_BEHAVIOR_UNSPECIFIED", - "APPEND", - "REPLACE" - ], - "enumDescriptions": [ - "Not specified. `APPEND` will be used.", - "`messages` will be appended to the list of messages waiting to be sent to the user.", - "`messages` will replace the list of messages waiting to be sent to the user." - ], - "type": "string" - }, - "messages": { - "description": "The list of rich message responses to present to the user.", - "items": { - "$ref": "GoogleCloudDialogflowCxV3beta1ResponseMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2AnnotatedMessagePart": { - "description": "Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.", - "id": "GoogleCloudDialogflowV2AnnotatedMessagePart", - "properties": { - "entityType": { - "description": "The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity.", - "type": "string" - }, - "formattedValue": { - "description": "The [Dialogflow system entity formatted value ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. For example for a system entity of type `@sys.unit-currency`, this may contain: { \"amount\": 5, \"currency\": \"USD\" } ", - "type": "any" - }, - "text": { - "description": "A part of a message possibly annotated with an entity.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse": { - "description": "The response message for EntityTypes.BatchUpdateEntityTypes.", - "id": "GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse", - "properties": { - "entityTypes": { - "description": "The collection of updated or created entity types.", - "items": { - "$ref": "GoogleCloudDialogflowV2EntityType" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2BatchUpdateIntentsResponse": { - "description": "The response message for Intents.BatchUpdateIntents.", - "id": "GoogleCloudDialogflowV2BatchUpdateIntentsResponse", - "properties": { - "intents": { - "description": "The collection of updated or created intents.", - "items": { - "$ref": "GoogleCloudDialogflowV2Intent" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2Context": { - "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", - "id": "GoogleCloudDialogflowV2Context", - "properties": { - "lifespanCount": { - "description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", - "type": "string" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2ConversationEvent": { - "description": "Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.", - "id": "GoogleCloudDialogflowV2ConversationEvent", - "properties": { - "conversation": { - "description": "The unique identifier of the conversation this notification refers to. Format: `projects//conversations/`.", - "type": "string" - }, - "errorStatus": { - "$ref": "GoogleRpcStatus", - "description": "More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL." - }, - "newMessagePayload": { - "$ref": "GoogleCloudDialogflowV2Message", - "description": "Payload of NEW_MESSAGE event." - }, - "type": { - "description": "The type of the event that this notification refers to.", - "enum": [ - "TYPE_UNSPECIFIED", - "CONVERSATION_STARTED", - "CONVERSATION_FINISHED", - "HUMAN_INTERVENTION_NEEDED", - "NEW_MESSAGE", - "UNRECOVERABLE_ERROR" - ], - "enumDescriptions": [ - "Type not set.", - "A new conversation has been opened. This is fired when a telephone call is answered, or a conversation is created via the API.", - "An existing conversation has closed. This is fired when a telephone call is terminated, or a conversation is closed via the API.", - "An existing conversation has received notification from Dialogflow that human intervention is required.", - "An existing conversation has received a new message, either from API or telephony. It is configured in ConversationProfile.new_message_event_notification_config", - "Unrecoverable error during a telephone call. In general non-recoverable errors only occur if something was misconfigured in the ConversationProfile corresponding to the call. After a non-recoverable error, Dialogflow may stop responding. We don't fire this event: * in an API call because we can directly return the error, or, * when we can recover from an error." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2EntityType": { - "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", - "id": "GoogleCloudDialogflowV2EntityType", - "properties": { - "autoExpansionMode": { - "description": "Optional. Indicates whether the entity type can be automatically expanded.", - "enum": [ - "AUTO_EXPANSION_MODE_UNSPECIFIED", - "AUTO_EXPANSION_MODE_DEFAULT" - ], - "enumDescriptions": [ - "Auto expansion disabled for the entity.", - "Allows an agent to recognize values that have not been explicitly listed in the entity." - ], - "type": "string" - }, - "displayName": { - "description": "Required. The name of the entity type.", - "type": "string" - }, - "enableFuzzyExtraction": { - "description": "Optional. Enables fuzzy entity extraction during classification.", - "type": "boolean" - }, - "entities": { - "description": "Optional. The collection of entity entries associated with the entity type.", - "items": { - "$ref": "GoogleCloudDialogflowV2EntityTypeEntity" - }, - "type": "array" - }, - "kind": { - "description": "Required. Indicates the kind of entity type.", - "enum": [ - "KIND_UNSPECIFIED", - "KIND_MAP", - "KIND_LIST", - "KIND_REGEXP" - ], - "enumDescriptions": [ - "Not specified. This value should be never used.", - "Map entity types allow mapping of a group of synonyms to a reference value.", - "List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).", - "Regexp entity types allow to specify regular expressions in entries values." - ], - "type": "string" - }, - "name": { - "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2EntityTypeEntity": { - "description": "An **entity entry** for an associated entity type.", - "id": "GoogleCloudDialogflowV2EntityTypeEntity", - "properties": { - "synonyms": { - "description": "Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "value": { - "description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2EventInput": { - "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", - "id": "GoogleCloudDialogflowV2EventInput", - "properties": { - "languageCode": { - "description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", - "type": "string" - }, - "name": { - "description": "Required. The unique identifier of the event.", - "type": "string" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2ExportAgentResponse": { - "description": "The response message for Agents.ExportAgent.", - "id": "GoogleCloudDialogflowV2ExportAgentResponse", - "properties": { - "agentContent": { - "description": "Zip compressed raw byte content for agent.", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2ImportDocumentsResponse": { - "description": "Response message for Documents.ImportDocuments.", - "id": "GoogleCloudDialogflowV2ImportDocumentsResponse", - "properties": { - "warnings": { - "description": "Includes details about skipped documents or any other warnings.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2Intent": { - "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", - "id": "GoogleCloudDialogflowV2Intent", - "properties": { - "action": { - "description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.", - "type": "string" - }, - "defaultResponsePlatforms": { - "description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).", - "items": { - "enum": [ - "PLATFORM_UNSPECIFIED", - "FACEBOOK", - "SLACK", - "TELEGRAM", - "KIK", - "SKYPE", - "LINE", - "VIBER", - "ACTIONS_ON_GOOGLE", - "GOOGLE_HANGOUTS" - ], - "enumDescriptions": [ - "Default platform.", - "Facebook.", - "Slack.", - "Telegram.", - "Kik.", - "Skype.", - "Line.", - "Viber.", - "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", - "Google Hangouts." - ], - "type": "string" - }, - "type": "array" - }, - "displayName": { - "description": "Required. The name of this intent.", - "type": "string" - }, - "events": { - "description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.", - "items": { - "type": "string" - }, - "type": "array" - }, - "followupIntentInfo": { - "description": "Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentFollowupIntentInfo" - }, - "type": "array" - }, - "inputContextNames": { - "description": "Optional. The list of context names required for this intent to be triggered. Format: `projects//agent/sessions/-/contexts/`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "isFallback": { - "description": "Optional. Indicates whether this is a fallback intent.", - "type": "boolean" - }, - "messages": { - "description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessage" - }, - "type": "array" - }, - "mlDisabled": { - "description": "Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.", - "type": "boolean" - }, - "name": { - "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`.", - "type": "string" - }, - "outputContexts": { - "description": "Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.", - "items": { - "$ref": "GoogleCloudDialogflowV2Context" - }, - "type": "array" - }, - "parameters": { - "description": "Optional. The collection of parameters associated with the intent.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentParameter" - }, - "type": "array" - }, - "parentFollowupIntentName": { - "description": "Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.", - "type": "string" - }, - "priority": { - "description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", - "format": "int32", - "type": "integer" - }, - "resetContexts": { - "description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.", - "type": "boolean" - }, - "rootFollowupIntentName": { - "description": "Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects//agent/intents/`.", - "type": "string" - }, - "trainingPhrases": { - "description": "Optional. The collection of examples that the agent is trained on.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentTrainingPhrase" - }, - "type": "array" - }, - "webhookState": { - "description": "Optional. Indicates whether webhooks are enabled for the intent.", - "enum": [ - "WEBHOOK_STATE_UNSPECIFIED", - "WEBHOOK_STATE_ENABLED", - "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" - ], - "enumDescriptions": [ - "Webhook is disabled in the agent and in the intent.", - "Webhook is enabled in the agent and in the intent.", - "Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentFollowupIntentInfo": { - "description": "Represents a single followup intent in the chain.", - "id": "GoogleCloudDialogflowV2IntentFollowupIntentInfo", - "properties": { - "followupIntentName": { - "description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.", - "type": "string" - }, - "parentFollowupIntentName": { - "description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessage": { - "description": "A rich response message. Corresponds to the intent `Response` field in the Dialogflow console. For more information, see [Rich response messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages).", - "id": "GoogleCloudDialogflowV2IntentMessage", - "properties": { - "basicCard": { - "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCard", - "description": "The basic card response for Actions on Google." - }, - "browseCarouselCard": { - "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard", - "description": "Browse carousel card for Actions on Google." - }, - "card": { - "$ref": "GoogleCloudDialogflowV2IntentMessageCard", - "description": "The card response." - }, - "carouselSelect": { - "$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelect", - "description": "The carousel card response for Actions on Google." - }, - "image": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "The image response." - }, - "linkOutSuggestion": { - "$ref": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion", - "description": "The link out suggestion chip for Actions on Google." - }, - "listSelect": { - "$ref": "GoogleCloudDialogflowV2IntentMessageListSelect", - "description": "The list card response for Actions on Google." - }, - "mediaContent": { - "$ref": "GoogleCloudDialogflowV2IntentMessageMediaContent", - "description": "The media content card for Actions on Google." - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "A custom platform-specific response.", - "type": "object" - }, - "platform": { - "description": "Optional. The platform that this message is intended for.", - "enum": [ - "PLATFORM_UNSPECIFIED", - "FACEBOOK", - "SLACK", - "TELEGRAM", - "KIK", - "SKYPE", - "LINE", - "VIBER", - "ACTIONS_ON_GOOGLE", - "GOOGLE_HANGOUTS" - ], - "enumDescriptions": [ - "Default platform.", - "Facebook.", - "Slack.", - "Telegram.", - "Kik.", - "Skype.", - "Line.", - "Viber.", - "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", - "Google Hangouts." - ], - "type": "string" - }, - "quickReplies": { - "$ref": "GoogleCloudDialogflowV2IntentMessageQuickReplies", - "description": "The quick replies response." - }, - "simpleResponses": { - "$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponses", - "description": "The voice and text-only responses for Actions on Google." - }, - "suggestions": { - "$ref": "GoogleCloudDialogflowV2IntentMessageSuggestions", - "description": "The suggestion chips for Actions on Google." - }, - "tableCard": { - "$ref": "GoogleCloudDialogflowV2IntentMessageTableCard", - "description": "Table card for Actions on Google." - }, - "text": { - "$ref": "GoogleCloudDialogflowV2IntentMessageText", - "description": "The text response." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageBasicCard": { - "description": "The basic card message. Useful for displaying information.", - "id": "GoogleCloudDialogflowV2IntentMessageBasicCard", - "properties": { - "buttons": { - "description": "Optional. The collection of card buttons.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton" - }, - "type": "array" - }, - "formattedText": { - "description": "Required, unless image is present. The body text of the card.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "Optional. The image for the card." - }, - "subtitle": { - "description": "Optional. The subtitle of the card.", - "type": "string" - }, - "title": { - "description": "Optional. The title of the card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageBasicCardButton": { - "description": "The button object that appears at the bottom of a card.", - "id": "GoogleCloudDialogflowV2IntentMessageBasicCardButton", - "properties": { - "openUriAction": { - "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction", - "description": "Required. Action to take when a user taps on the button." - }, - "title": { - "description": "Required. The title of the button.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": { - "description": "Opens the given URI.", - "id": "GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction", - "properties": { - "uri": { - "description": "Required. The HTTP or HTTPS scheme URI.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard": { - "description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel", - "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard", - "properties": { - "imageDisplayOptions": { - "description": "Optional. Settings for displaying the image. Applies to every image in items.", - "enum": [ - "IMAGE_DISPLAY_OPTIONS_UNSPECIFIED", - "GRAY", - "WHITE", - "CROPPED", - "BLURRED_BACKGROUND" - ], - "enumDescriptions": [ - "Fill the gaps between the image and the image container with gray bars.", - "Fill the gaps between the image and the image container with gray bars.", - "Fill the gaps between the image and the image container with white bars.", - "Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.", - "Pad the gaps between image and image frame with a blurred copy of the same image." - ], - "type": "string" - }, - "items": { - "description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem": { - "description": "Browsing carousel tile", - "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem", - "properties": { - "description": { - "description": "Optional. Description of the carousel item. Maximum of four lines of text.", - "type": "string" - }, - "footer": { - "description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "Optional. Hero image for the carousel item." - }, - "openUriAction": { - "$ref": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", - "description": "Required. Action to present to the user." - }, - "title": { - "description": "Required. Title of the carousel item. Maximum of two lines of text.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": { - "description": "Actions on Google action to open a given url.", - "id": "GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", - "properties": { - "url": { - "description": "Required. URL", - "type": "string" - }, - "urlTypeHint": { - "description": "Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.", - "enum": [ - "URL_TYPE_HINT_UNSPECIFIED", - "AMP_ACTION", - "AMP_CONTENT" - ], - "enumDescriptions": [ - "Unspecified", - "Url would be an amp action", - "URL that points directly to AMP content, or to a canonical URL which refers to AMP content via ." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageCard": { - "description": "The card response message.", - "id": "GoogleCloudDialogflowV2IntentMessageCard", - "properties": { - "buttons": { - "description": "Optional. The collection of card buttons.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageCardButton" - }, - "type": "array" - }, - "imageUri": { - "description": "Optional. The public URI to an image file for the card.", - "type": "string" - }, - "subtitle": { - "description": "Optional. The subtitle of the card.", - "type": "string" - }, - "title": { - "description": "Optional. The title of the card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageCardButton": { - "description": "Contains information about a button.", - "id": "GoogleCloudDialogflowV2IntentMessageCardButton", - "properties": { - "postback": { - "description": "Optional. The text to send back to the Dialogflow API or a URI to open.", - "type": "string" - }, - "text": { - "description": "Optional. The text to show on the button.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageCarouselSelect": { - "description": "The card for presenting a carousel of options to select from.", - "id": "GoogleCloudDialogflowV2IntentMessageCarouselSelect", - "properties": { - "items": { - "description": "Required. Carousel items.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": { - "description": "An item in the carousel.", - "id": "GoogleCloudDialogflowV2IntentMessageCarouselSelectItem", - "properties": { - "description": { - "description": "Optional. The body text of the card.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "Optional. The image to display." - }, - "info": { - "$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo", - "description": "Required. Additional info about the option item." - }, - "title": { - "description": "Required. Title of the carousel item.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageColumnProperties": { - "description": "Column properties for TableCard.", - "id": "GoogleCloudDialogflowV2IntentMessageColumnProperties", - "properties": { - "header": { - "description": "Required. Column heading.", - "type": "string" - }, - "horizontalAlignment": { - "description": "Optional. Defines text alignment for all cells in this column.", - "enum": [ - "HORIZONTAL_ALIGNMENT_UNSPECIFIED", - "LEADING", - "CENTER", - "TRAILING" - ], - "enumDescriptions": [ - "Text is aligned to the leading edge of the column.", - "Text is aligned to the leading edge of the column.", - "Text is centered in the column.", - "Text is aligned to the trailing edge of the column." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageImage": { - "description": "The image response message.", - "id": "GoogleCloudDialogflowV2IntentMessageImage", - "properties": { - "accessibilityText": { - "description": "Optional. A text description of the image to be used for accessibility, e.g., screen readers.", - "type": "string" - }, - "imageUri": { - "description": "Optional. The public URI to an image file.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion": { - "description": "The suggestion chip message that allows the user to jump out to the app or website associated with this agent.", - "id": "GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion", - "properties": { - "destinationName": { - "description": "Required. The name of the app or site this chip is linking to.", - "type": "string" - }, - "uri": { - "description": "Required. The URI of the app or site to open when the user taps the suggestion chip.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageListSelect": { - "description": "The card for presenting a list of options to select from.", - "id": "GoogleCloudDialogflowV2IntentMessageListSelect", - "properties": { - "items": { - "description": "Required. List items.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageListSelectItem" - }, - "type": "array" - }, - "subtitle": { - "description": "Optional. Subtitle of the list.", - "type": "string" - }, - "title": { - "description": "Optional. The overall title of the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageListSelectItem": { - "description": "An item in the list.", - "id": "GoogleCloudDialogflowV2IntentMessageListSelectItem", - "properties": { - "description": { - "description": "Optional. The main text describing the item.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "Optional. The image to display." - }, - "info": { - "$ref": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo", - "description": "Required. Additional information about this option." - }, - "title": { - "description": "Required. The title of the list item.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageMediaContent": { - "description": "The media content card for Actions on Google.", - "id": "GoogleCloudDialogflowV2IntentMessageMediaContent", - "properties": { - "mediaObjects": { - "description": "Required. List of media objects.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject" - }, - "type": "array" - }, - "mediaType": { - "description": "Optional. What type of media is the content (ie \"audio\").", - "enum": [ - "RESPONSE_MEDIA_TYPE_UNSPECIFIED", - "AUDIO" - ], - "enumDescriptions": [ - "Unspecified.", - "Response media type is audio." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject": { - "description": "Response media object for media content card.", - "id": "GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject", - "properties": { - "contentUrl": { - "description": "Required. Url where the media is stored.", - "type": "string" - }, - "description": { - "description": "Optional. Description of media card.", - "type": "string" - }, - "icon": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "Optional. Icon to display above media content." - }, - "largeImage": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "Optional. Image to display above media content." - }, - "name": { - "description": "Required. Name of media card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageQuickReplies": { - "description": "The quick replies response message.", - "id": "GoogleCloudDialogflowV2IntentMessageQuickReplies", - "properties": { - "quickReplies": { - "description": "Optional. The collection of quick replies.", - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "description": "Optional. The title of the collection of quick replies.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageSelectItemInfo": { - "description": "Additional info about the select item for when it is triggered in a dialog.", - "id": "GoogleCloudDialogflowV2IntentMessageSelectItemInfo", - "properties": { - "key": { - "description": "Required. A unique key that will be sent back to the agent if this response is given.", - "type": "string" - }, - "synonyms": { - "description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageSimpleResponse": { - "description": "The simple response message containing speech or text.", - "id": "GoogleCloudDialogflowV2IntentMessageSimpleResponse", - "properties": { - "displayText": { - "description": "Optional. The text to display.", - "type": "string" - }, - "ssml": { - "description": "One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.", - "type": "string" - }, - "textToSpeech": { - "description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageSimpleResponses": { - "description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.", - "id": "GoogleCloudDialogflowV2IntentMessageSimpleResponses", - "properties": { - "simpleResponses": { - "description": "Required. The list of simple responses.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageSimpleResponse" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageSuggestion": { - "description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.", - "id": "GoogleCloudDialogflowV2IntentMessageSuggestion", - "properties": { - "title": { - "description": "Required. The text shown the in the suggestion chip.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageSuggestions": { - "description": "The collection of suggestions.", - "id": "GoogleCloudDialogflowV2IntentMessageSuggestions", - "properties": { - "suggestions": { - "description": "Required. The list of suggested replies.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageSuggestion" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageTableCard": { - "description": "Table card for Actions on Google.", - "id": "GoogleCloudDialogflowV2IntentMessageTableCard", - "properties": { - "buttons": { - "description": "Optional. List of buttons for the card.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageBasicCardButton" - }, - "type": "array" - }, - "columnProperties": { - "description": "Optional. Display properties for the columns in this table.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageColumnProperties" - }, - "type": "array" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2IntentMessageImage", - "description": "Optional. Image which should be displayed on the card." - }, - "rows": { - "description": "Optional. Rows in this table of data.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageTableCardRow" - }, - "type": "array" - }, - "subtitle": { - "description": "Optional. Subtitle to the title.", - "type": "string" - }, - "title": { - "description": "Required. Title of the card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageTableCardCell": { - "description": "Cell of TableCardRow.", - "id": "GoogleCloudDialogflowV2IntentMessageTableCardCell", - "properties": { - "text": { - "description": "Required. Text in this cell.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageTableCardRow": { - "description": "Row of TableCard.", - "id": "GoogleCloudDialogflowV2IntentMessageTableCardRow", - "properties": { - "cells": { - "description": "Optional. List of cells that make up this row.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessageTableCardCell" - }, - "type": "array" - }, - "dividerAfter": { - "description": "Optional. Whether to add a visual divider after this row.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentMessageText": { - "description": "The text response message.", - "id": "GoogleCloudDialogflowV2IntentMessageText", - "properties": { - "text": { - "description": "Optional. The collection of the agent's responses.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentParameter": { - "description": "Represents intent parameters.", - "id": "GoogleCloudDialogflowV2IntentParameter", - "properties": { - "defaultValue": { - "description": "Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.", - "type": "string" - }, - "displayName": { - "description": "Required. The name of the parameter.", - "type": "string" - }, - "entityTypeDisplayName": { - "description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.", - "type": "string" - }, - "isList": { - "description": "Optional. Indicates whether the parameter represents a list of values.", - "type": "boolean" - }, - "mandatory": { - "description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.", - "type": "boolean" - }, - "name": { - "description": "The unique identifier of this parameter.", - "type": "string" - }, - "prompts": { - "description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.", - "items": { - "type": "string" - }, - "type": "array" - }, - "value": { - "description": "Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentTrainingPhrase": { - "description": "Represents an example that the agent is trained on.", - "id": "GoogleCloudDialogflowV2IntentTrainingPhrase", - "properties": { - "name": { - "description": "Output only. The unique identifier of this training phrase.", - "type": "string" - }, - "parts": { - "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentTrainingPhrasePart" - }, - "type": "array" - }, - "timesAddedCount": { - "description": "Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "Required. The type of the training phrase.", - "enum": [ - "TYPE_UNSPECIFIED", - "EXAMPLE", - "TEMPLATE" - ], - "enumDescriptions": [ - "Not specified. This value should never be used.", - "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", - "Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2IntentTrainingPhrasePart": { - "description": "Represents a part of a training phrase.", - "id": "GoogleCloudDialogflowV2IntentTrainingPhrasePart", - "properties": { - "alias": { - "description": "Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.", - "type": "string" - }, - "entityType": { - "description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.", - "type": "string" - }, - "text": { - "description": "Required. The text for this part.", - "type": "string" - }, - "userDefined": { - "description": "Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2Message": { - "description": "Represents a message posted into a conversation.", - "id": "GoogleCloudDialogflowV2Message", - "properties": { - "content": { - "description": "Required. The message content.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time when the message was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "languageCode": { - "description": "Optional. The message language. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\".", - "type": "string" - }, - "messageAnnotation": { - "$ref": "GoogleCloudDialogflowV2MessageAnnotation", - "description": "Output only. The annotation for the message.", - "readOnly": true - }, - "name": { - "description": "The unique identifier of the message. Format: `projects//conversations//messages/`.", - "type": "string" - }, - "participant": { - "description": "Output only. The participant that sends this message.", - "readOnly": true, - "type": "string" - }, - "participantRole": { - "description": "Output only. The role of the participant.", - "enum": [ - "ROLE_UNSPECIFIED", - "HUMAN_AGENT", - "AUTOMATED_AGENT", - "END_USER" - ], - "enumDescriptions": [ - "Participant role not set.", - "Participant is a human agent.", - "Participant is an automated agent, such as a Dialogflow agent.", - "Participant is an end user that has called or chatted with Dialogflow services." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2MessageAnnotation": { - "description": "Represents the result of annotation for the message.", - "id": "GoogleCloudDialogflowV2MessageAnnotation", - "properties": { - "containEntities": { - "description": "Indicates whether the text message contains entities.", - "type": "boolean" - }, - "parts": { - "description": "The collection of annotated message parts ordered by their position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text].", - "items": { - "$ref": "GoogleCloudDialogflowV2AnnotatedMessagePart" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2OriginalDetectIntentRequest": { - "description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.", - "id": "GoogleCloudDialogflowV2OriginalDetectIntentRequest", - "properties": { - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.", - "type": "object" - }, - "source": { - "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.", - "type": "string" - }, - "version": { - "description": "Optional. The version of the protocol used for this request. This field is AoG-specific.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2QueryResult": { - "description": "Represents the result of conversational query or event processing.", - "id": "GoogleCloudDialogflowV2QueryResult", - "properties": { - "action": { - "description": "The action name from the matched intent.", - "type": "string" - }, - "allRequiredParamsPresent": { - "description": "This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.", - "type": "boolean" - }, - "diagnosticInfo": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors", - "type": "object" - }, - "fulfillmentMessages": { - "description": "The collection of rich messages to present to the user.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessage" - }, - "type": "array" - }, - "fulfillmentText": { - "description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.", - "type": "string" - }, - "intent": { - "$ref": "GoogleCloudDialogflowV2Intent", - "description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`." - }, - "intentDetectionConfidence": { - "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", - "type": "string" - }, - "outputContexts": { - "description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.", - "items": { - "$ref": "GoogleCloudDialogflowV2Context" - }, - "type": "array" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", - "type": "object" - }, - "queryText": { - "description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.", - "type": "string" - }, - "sentimentAnalysisResult": { - "$ref": "GoogleCloudDialogflowV2SentimentAnalysisResult", - "description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request." - }, - "speechRecognitionConfidence": { - "description": "The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.", - "format": "float", - "type": "number" - }, - "webhookPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.", - "type": "object" - }, - "webhookSource": { - "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2Sentiment": { - "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.", - "id": "GoogleCloudDialogflowV2Sentiment", - "properties": { - "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", - "format": "float", - "type": "number" - }, - "score": { - "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2SentimentAnalysisResult": { - "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config", - "id": "GoogleCloudDialogflowV2SentimentAnalysisResult", - "properties": { - "queryTextSentiment": { - "$ref": "GoogleCloudDialogflowV2Sentiment", - "description": "The sentiment analysis result for `query_text`." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2SessionEntityType": { - "description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).", - "id": "GoogleCloudDialogflowV2SessionEntityType", - "properties": { - "entities": { - "description": "Required. The collection of entities associated with this session entity type.", - "items": { - "$ref": "GoogleCloudDialogflowV2EntityTypeEntity" - }, - "type": "array" - }, - "entityOverrideMode": { - "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", - "enum": [ - "ENTITY_OVERRIDE_MODE_UNSPECIFIED", - "ENTITY_OVERRIDE_MODE_OVERRIDE", - "ENTITY_OVERRIDE_MODE_SUPPLEMENT" - ], - "enumDescriptions": [ - "Not specified. This value should be never used.", - "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", - "The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge." - ], - "type": "string" - }, - "name": { - "description": "Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2WebhookRequest": { - "description": "The request message for a webhook call.", - "id": "GoogleCloudDialogflowV2WebhookRequest", - "properties": { - "originalDetectIntentRequest": { - "$ref": "GoogleCloudDialogflowV2OriginalDetectIntentRequest", - "description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call." - }, - "queryResult": { - "$ref": "GoogleCloudDialogflowV2QueryResult", - "description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`." - }, - "responseId": { - "description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.", - "type": "string" - }, - "session": { - "description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects//agent/sessions/`, or `projects//agent/environments//users//sessions/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2WebhookResponse": { - "description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).", - "id": "GoogleCloudDialogflowV2WebhookResponse", - "properties": { - "followupEventInput": { - "$ref": "GoogleCloudDialogflowV2EventInput", - "description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields." - }, - "fulfillmentMessages": { - "description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.", - "items": { - "$ref": "GoogleCloudDialogflowV2IntentMessage" - }, - "type": "array" - }, - "fulfillmentText": { - "description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.", - "type": "string" - }, - "outputContexts": { - "description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.", - "items": { - "$ref": "GoogleCloudDialogflowV2Context" - }, - "type": "array" - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", - "type": "object" - }, - "sessionEntityTypes": { - "description": "Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.", - "items": { - "$ref": "GoogleCloudDialogflowV2SessionEntityType" - }, - "type": "array" - }, - "source": { - "description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1Agent": { - "description": "A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview).", - "id": "GoogleCloudDialogflowV2beta1Agent", - "properties": { - "apiVersion": { - "description": "Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version.", - "enum": [ - "API_VERSION_UNSPECIFIED", - "API_VERSION_V1", - "API_VERSION_V2", - "API_VERSION_V2_BETA_1" - ], - "enumDescriptions": [ - "Not specified.", - "Legacy V1 API.", - "V2 API.", - "V2beta1 API." - ], - "type": "string" - }, - "avatarUri": { - "description": "Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.", - "type": "string" - }, - "classificationThreshold": { - "description": "Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.", - "format": "float", - "type": "number" - }, - "defaultLanguageCode": { - "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method.", - "type": "string" - }, - "description": { - "description": "Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.", - "type": "string" - }, - "displayName": { - "description": "Required. The name of this agent.", - "type": "string" - }, - "enableLogging": { - "description": "Optional. Determines whether this agent should log conversation queries.", - "type": "boolean" - }, - "matchMode": { - "description": "Optional. Determines how intents are detected from user queries.", - "enum": [ - "MATCH_MODE_UNSPECIFIED", - "MATCH_MODE_HYBRID", - "MATCH_MODE_ML_ONLY" - ], - "enumDescriptions": [ - "Not specified.", - "Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.", - "Can be used for agents with a large number of examples in intents, especially the ones using @sys.any or very large custom entities." - ], - "type": "string" - }, - "parent": { - "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`", - "type": "string" - }, - "supportedLanguageCodes": { - "description": "Optional. The list of all languages supported by this agent (except for the `default_language_code`).", - "items": { - "type": "string" - }, - "type": "array" - }, - "tier": { - "description": "Optional. The agent tier. If not specified, TIER_STANDARD is assumed.", - "enum": [ - "TIER_UNSPECIFIED", - "TIER_STANDARD", - "TIER_ENTERPRISE", - "TIER_ENTERPRISE_PLUS" - ], - "enumDescriptions": [ - "Not specified. This value should never be used.", - "Standard tier.", - "Enterprise tier (Essentials).", - "Enterprise tier (Plus)." - ], - "type": "string" - }, - "timeZone": { - "description": "Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset": { - "description": "Represents an annotated conversation dataset. ConversationDataset can have multiple AnnotatedConversationDataset, each of them represents one result from one annotation task. AnnotatedConversationDataset can only be generated from annotation task, which will be triggered by LabelConversation.", - "id": "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset", - "properties": { - "completedExampleCount": { - "description": "Output only. Number of examples that have annotations in the annotated conversation dataset.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "createTime": { - "description": "Output only. Creation time of this annotated conversation dataset.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Optional. The description of the annotated conversation dataset. Maximum of 10000 bytes.", - "type": "string" - }, - "displayName": { - "description": "Required. The display name of the annotated conversation dataset. It's specified when user starts an annotation task. Maximum of 64 bytes.", - "type": "string" - }, - "exampleCount": { - "description": "Output only. Number of examples in the annotated conversation dataset.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. AnnotatedConversationDataset resource name. Format: `projects//conversationDatasets//annotatedConversationDatasets/`", - "readOnly": true, - "type": "string" - }, - "questionTypeName": { - "description": "Output only. Question type name that identifies a labeling task. A question is a single task that a worker answers. A question type is set of related questions. Each question belongs to a particular question type. It can be used in CrowdCompute UI to filter and manage labeling tasks.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse": { - "description": "Response message for [Documents.AutoApproveSmartMessagingEntries].", - "id": "GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse", - "properties": { - "disabledCount": { - "description": "Number of smart messaging entries disabled.", - "format": "int32", - "type": "integer" - }, - "enabledCount": { - "description": "Number of smart messaging entries enabled.", - "format": "int32", - "type": "integer" - }, - "unreviewedCount": { - "description": "Number of smart messaging entries unreviewed.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest": { - "description": "The request message for EntityTypes.BatchCreateEntities.", - "id": "GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest", - "properties": { - "entities": { - "description": "Required. The entities to create.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" - }, - "type": "array" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest": { - "description": "The request message for EntityTypes.BatchDeleteEntities.", - "id": "GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest", - "properties": { - "entityValues": { - "description": "Required. The reference `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest": { - "description": "The request message for EntityTypes.BatchDeleteEntityTypes.", - "id": "GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest", - "properties": { - "entityTypeNames": { - "description": "Required. The names entity types to delete. All names must point to the same agent as `parent`.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest": { - "description": "The request message for Intents.BatchDeleteIntents.", - "id": "GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest", - "properties": { - "intents": { - "description": "Required. The collection of intents to delete. Only intent `name` must be filled in.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest": { - "description": "The request message for EntityTypes.BatchUpdateEntities.", - "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest", - "properties": { - "entities": { - "description": "Required. The entities to update or create.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" - }, - "type": "array" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest": { - "description": "The request message for EntityTypes.BatchUpdateEntityTypes.", - "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest", - "properties": { - "entityTypeBatchInline": { - "$ref": "GoogleCloudDialogflowV2beta1EntityTypeBatch", - "description": "The collection of entity types to update or create." - }, - "entityTypeBatchUri": { - "description": "The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with \"gs://\".", - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": { - "description": "The response message for EntityTypes.BatchUpdateEntityTypes.", - "id": "GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse", - "properties": { - "entityTypes": { - "description": "The collection of updated or created entity types.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest": { - "description": "The request message for Intents.BatchUpdateIntents.", - "id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest", - "properties": { - "intentBatchInline": { - "$ref": "GoogleCloudDialogflowV2beta1IntentBatch", - "description": "The collection of intents to update or create." - }, - "intentBatchUri": { - "description": "The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with \"gs://\".", - "type": "string" - }, - "intentView": { - "description": "Optional. The resource view to apply to the returned intent.", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "type": "string" - }, - "languageCode": { - "description": "Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see [Multilingual intent and entity data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).", - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse": { - "description": "The response message for Intents.BatchUpdateIntents.", - "id": "GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse", - "properties": { - "intents": { - "description": "The collection of updated or created intents.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1BatchUpdateSmartMessagingEntriesResponse": { - "description": "Response message for [Documents.BatchUpdateSmartMessagingEntries]", - "id": "GoogleCloudDialogflowV2beta1BatchUpdateSmartMessagingEntriesResponse", - "properties": { - "smartMessagingEntries": { - "description": "List of updated smart message entries.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1SmartMessagingEntry" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1Context": { - "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", - "id": "GoogleCloudDialogflowV2beta1Context", - "properties": { - "lifespanCount": { - "description": "Optional. The number of conversational query requests after which the context expires. The default is `0`. If set to `0`, the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Required. The unique identifier of the context. Supported formats: - `projects//agent/sessions//contexts/`, - `projects//locations//agent/sessions//contexts/`, - `projects//agent/environments//users//sessions//contexts/`, - `projects//locations//agent/environments//users//sessions//contexts/`, The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size`", - "type": "string" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1DetectIntentRequest": { - "description": "The request to detect user's intent.", - "id": "GoogleCloudDialogflowV2beta1DetectIntentRequest", - "properties": { - "inputAudio": { - "description": "The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data.", - "format": "byte", - "type": "string" - }, - "outputAudioConfig": { - "$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig", - "description": "Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated." - }, - "outputAudioConfigMask": { - "description": "Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.", - "format": "google-fieldmask", - "type": "string" - }, - "queryInput": { - "$ref": "GoogleCloudDialogflowV2beta1QueryInput", - "description": "Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger." - }, - "queryParams": { - "$ref": "GoogleCloudDialogflowV2beta1QueryParameters", - "description": "The parameters of this query." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1DetectIntentResponse": { - "description": "The message returned from the DetectIntent method.", - "id": "GoogleCloudDialogflowV2beta1DetectIntentResponse", - "properties": { - "alternativeQueryResults": { - "description": "If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing `QueryResult.intent_detection_confidence`. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1QueryResult" - }, - "type": "array" - }, - "outputAudio": { - "description": "The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.fulfillment_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.", - "format": "byte", - "type": "string" - }, - "outputAudioConfig": { - "$ref": "GoogleCloudDialogflowV2beta1OutputAudioConfig", - "description": "The config used by the speech synthesizer to generate the output audio." - }, - "queryResult": { - "$ref": "GoogleCloudDialogflowV2beta1QueryResult", - "description": "The selected results of the conversational query or event processing. See `alternative_query_results` for additional potential results." - }, - "responseId": { - "description": "The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.", - "type": "string" - }, - "webhookStatus": { - "$ref": "GoogleRpcStatus", - "description": "Specifies the status of the webhook request." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1Document": { - "description": "A knowledge document to be used by a KnowledgeBase. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`.", - "id": "GoogleCloudDialogflowV2beta1Document", - "properties": { - "content": { - "description": "The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.", - "type": "string" - }, - "contentUri": { - "description": "The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form `gs:///`. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use the `gs://` format URI described above.", - "type": "string" - }, - "displayName": { - "description": "Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.", - "type": "string" - }, - "enableAutoReload": { - "description": "Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see `source` field for the source types. Reload status can be tracked in `latest_reload_status`. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling `ReloadDocument` and clear the errors.", - "type": "boolean" - }, - "knowledgeTypes": { - "description": "Required. The knowledge type of document content.", - "items": { - "enum": [ - "KNOWLEDGE_TYPE_UNSPECIFIED", - "FAQ", - "EXTRACTIVE_QA" - ], - "enumDescriptions": [ - "The type is unspecified or arbitrary.", - "The document content contains question and answer pairs as either HTML or CSV. Typical FAQ HTML formats are parsed accurately, but unusual formats may fail to be parsed. CSV must have questions in the first column and answers in the second, with no header. Because of this explicit format, they are always parsed accurately.", - "Documents for which unstructured text is extracted and used for question answering." - ], - "type": "string" - }, - "type": "array" - }, - "latestReloadStatus": { - "$ref": "GoogleCloudDialogflowV2beta1DocumentReloadStatus", - "description": "Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.", - "readOnly": true - }, - "mimeType": { - "description": "Required. The MIME type of this document.", - "type": "string" - }, - "name": { - "description": "Optional. The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`.", - "type": "string" - }, - "rawContent": { - "description": "The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1DocumentReloadStatus": { - "description": "The status of a reload attempt.", - "id": "GoogleCloudDialogflowV2beta1DocumentReloadStatus", - "properties": { - "status": { - "$ref": "GoogleRpcStatus", - "description": "Output only. The status of a reload attempt or the initial load." - }, - "time": { - "description": "Output only. The time of a reload attempt. This reload may have been triggered automatically or manually and may not have succeeded.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1EntityType": { - "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", - "id": "GoogleCloudDialogflowV2beta1EntityType", - "properties": { - "autoExpansionMode": { - "description": "Optional. Indicates whether the entity type can be automatically expanded.", - "enum": [ - "AUTO_EXPANSION_MODE_UNSPECIFIED", - "AUTO_EXPANSION_MODE_DEFAULT" - ], - "enumDescriptions": [ - "Auto expansion disabled for the entity.", - "Allows an agent to recognize values that have not been explicitly listed in the entity." - ], - "type": "string" - }, - "displayName": { - "description": "Required. The name of the entity type.", - "type": "string" - }, - "enableFuzzyExtraction": { - "description": "Optional. Enables fuzzy entity extraction during classification.", - "type": "boolean" - }, - "entities": { - "description": "Optional. The collection of entity entries associated with the entity type.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" - }, - "type": "array" - }, - "kind": { - "description": "Required. Indicates the kind of entity type.", - "enum": [ - "KIND_UNSPECIFIED", - "KIND_MAP", - "KIND_LIST", - "KIND_REGEXP" - ], - "enumDescriptions": [ - "Not specified. This value should be never used.", - "Map entity types allow mapping of a group of synonyms to a reference value.", - "List entity types contain a set of entries that do not map to reference values. However, list entity types can contain references to other entity types (with or without aliases).", - "Regexp entity types allow to specify regular expressions in entries values." - ], - "type": "string" - }, - "name": { - "description": "The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Supported formats: - `projects//agent/entityTypes/` - `projects//locations//agent/entityTypes/`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1EntityTypeBatch": { - "description": "This message is a wrapper around a collection of entity types.", - "id": "GoogleCloudDialogflowV2beta1EntityTypeBatch", - "properties": { - "entityTypes": { - "description": "A collection of entity types.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1EntityTypeEntity": { - "description": "An **entity entry** for an associated entity type.", - "id": "GoogleCloudDialogflowV2beta1EntityTypeEntity", - "properties": { - "synonyms": { - "description": "Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "value": { - "description": "Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1Environment": { - "description": "You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions).", - "id": "GoogleCloudDialogflowV2beta1Environment", - "properties": { - "agentVersion": { - "description": "Optional. The agent version loaded into this environment. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/`", - "type": "string" - }, - "description": { - "description": "Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected.", - "type": "string" - }, - "name": { - "description": "Output only. The unique identifier of this agent environment. Supported formats: - `projects//agent/environments/` - `projects//locations//agent/environments/`", - "readOnly": true, - "type": "string" - }, - "state": { - "description": "Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods.", - "enum": [ - "STATE_UNSPECIFIED", - "STOPPED", - "LOADING", - "RUNNING" - ], - "enumDescriptions": [ - "Not specified. This value is not used.", - "Stopped.", - "Loading.", - "Running." - ], - "readOnly": true, - "type": "string" - }, - "updateTime": { - "description": "Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1EventInput": { - "description": "Events allow for matching intents by event name instead of the natural language input. For instance, input `` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `\"Hello #welcome_event.name! What can I do for you today?\"`.", - "id": "GoogleCloudDialogflowV2beta1EventInput", - "properties": { - "languageCode": { - "description": "Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", - "type": "string" - }, - "name": { - "description": "Required. The unique identifier of the event.", - "type": "string" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ExportAgentRequest": { - "description": "The request message for Agents.ExportAgent.", - "id": "GoogleCloudDialogflowV2beta1ExportAgentRequest", - "properties": { - "agentUri": { - "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs:///`. If left unspecified, the serialized agent is returned inline.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ExportAgentResponse": { - "description": "The response message for Agents.ExportAgent.", - "id": "GoogleCloudDialogflowV2beta1ExportAgentResponse", - "properties": { - "agentContent": { - "description": "Zip compressed raw byte content for agent.", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1Fulfillment": { - "description": "By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview).", - "id": "GoogleCloudDialogflowV2beta1Fulfillment", - "properties": { - "displayName": { - "description": "The human-readable name of the fulfillment, unique within the agent.", - "type": "string" - }, - "enabled": { - "description": "Whether fulfillment is enabled.", - "type": "boolean" - }, - "features": { - "description": "The field defines whether the fulfillment is enabled for certain features.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1FulfillmentFeature" - }, - "type": "array" - }, - "genericWebService": { - "$ref": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService", - "description": "Configuration for a generic web service." - }, - "name": { - "description": "Required. The unique identifier of the fulfillment. Supported formats: - `projects//agent/fulfillment` - `projects//locations//agent/fulfillment`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1FulfillmentFeature": { - "description": "Whether fulfillment is enabled for the specific feature.", - "id": "GoogleCloudDialogflowV2beta1FulfillmentFeature", - "properties": { - "type": { - "description": "The type of the feature that enabled for fulfillment.", - "enum": [ - "TYPE_UNSPECIFIED", - "SMALLTALK" - ], - "enumDescriptions": [ - "Feature type not specified.", - "Fulfillment is enabled for SmallTalk." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService": { - "description": "Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.", - "id": "GoogleCloudDialogflowV2beta1FulfillmentGenericWebService", - "properties": { - "isCloudFunction": { - "description": "Indicates if generic web service is created through Cloud Functions integration. Defaults to false.", - "type": "boolean" - }, - "password": { - "description": "The password for HTTP Basic authentication.", - "type": "string" - }, - "requestHeaders": { - "additionalProperties": { - "type": "string" - }, - "description": "The HTTP request headers to send together with fulfillment requests.", - "type": "object" - }, - "uri": { - "description": "Required. The fulfillment URI for receiving POST requests. It must use https protocol.", - "type": "string" - }, - "username": { - "description": "The user name for HTTP Basic authentication.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1GcsSource": { - "description": "Google Cloud Storage location for single input.", - "id": "GoogleCloudDialogflowV2beta1GcsSource", - "properties": { - "uri": { - "description": "Required. The Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ImportAgentRequest": { - "description": "The request message for Agents.ImportAgent.", - "id": "GoogleCloudDialogflowV2beta1ImportAgentRequest", - "properties": { - "agentContent": { - "description": "Zip compressed raw byte content for agent.", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with \"gs://\".", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ImportDocumentsResponse": { - "description": "Response message for Documents.ImportDocuments.", - "id": "GoogleCloudDialogflowV2beta1ImportDocumentsResponse", - "properties": { - "warnings": { - "description": "Includes details about skipped documents or any other warnings.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1InputAudioConfig": { - "description": "Instructs the speech recognizer on how to process the audio content.", - "id": "GoogleCloudDialogflowV2beta1InputAudioConfig", - "properties": { - "audioEncoding": { - "description": "Required. Audio encoding of the audio content to process.", - "enum": [ - "AUDIO_ENCODING_UNSPECIFIED", - "AUDIO_ENCODING_LINEAR_16", - "AUDIO_ENCODING_FLAC", - "AUDIO_ENCODING_MULAW", - "AUDIO_ENCODING_AMR", - "AUDIO_ENCODING_AMR_WB", - "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" - ], - "enumDescriptions": [ - "Not specified.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM).", - "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", - "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", - "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", - "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." - ], - "type": "string" - }, - "enableWordInfo": { - "description": "If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", - "type": "boolean" - }, - "languageCode": { - "description": "Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", - "type": "string" - }, - "model": { - "description": "Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details.", - "type": "string" - }, - "modelVariant": { - "description": "Which variant of the Speech model to use.", - "enum": [ - "SPEECH_MODEL_VARIANT_UNSPECIFIED", - "USE_BEST_AVAILABLE", - "USE_STANDARD", - "USE_ENHANCED" - ], - "enumDescriptions": [ - "No model variant specified. In this case Dialogflow defaults to USE_BEST_AVAILABLE.", - "Use the best available variant of the Speech model that the caller is eligible for. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible for enhanced models.", - "Use standard model variant even if an enhanced model is available. See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) for details about enhanced models.", - "Use an enhanced model variant: * If an enhanced variant does not exist for the given model and request language, Dialogflow falls back to the standard variant. The [Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/enhanced-models) describes which models have enhanced variants. * If the API caller isn't eligible for enhanced models, Dialogflow returns an error. Please see the [Dialogflow docs](https://cloud.google.com/dialogflow/docs/data-logging) for how to make your project eligible." - ], - "type": "string" - }, - "phraseHints": { - "description": "A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [speech_contexts]() instead. If you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will treat the [phrase_hints]() as a single additional [SpeechContext]().", - "items": { - "type": "string" - }, - "type": "array" - }, - "sampleRateHertz": { - "description": "Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", - "format": "int32", - "type": "integer" - }, - "singleUtterance": { - "description": "If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance.", - "type": "boolean" - }, - "speechContexts": { - "description": "Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1SpeechContext" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1Intent": { - "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", - "id": "GoogleCloudDialogflowV2beta1Intent", - "properties": { - "action": { - "description": "Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces.", - "type": "string" - }, - "defaultResponsePlatforms": { - "description": "Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform).", - "items": { - "enum": [ - "PLATFORM_UNSPECIFIED", - "FACEBOOK", - "SLACK", - "TELEGRAM", - "KIK", - "SKYPE", - "LINE", - "VIBER", - "ACTIONS_ON_GOOGLE", - "TELEPHONY", - "GOOGLE_HANGOUTS" - ], - "enumDescriptions": [ - "Not specified.", - "Facebook.", - "Slack.", - "Telegram.", - "Kik.", - "Skype.", - "Line.", - "Viber.", - "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", - "Telephony Gateway.", - "Google Hangouts." - ], - "type": "string" - }, - "type": "array" - }, - "displayName": { - "description": "Required. The name of this intent.", - "type": "string" - }, - "endInteraction": { - "description": "Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.", - "type": "boolean" - }, - "events": { - "description": "Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. Event names are limited to 150 characters.", - "items": { - "type": "string" - }, - "type": "array" - }, - "followupIntentInfo": { - "description": "Output only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo" - }, - "readOnly": true, - "type": "array" - }, - "inputContextNames": { - "description": "Optional. The list of context names required for this intent to be triggered. Formats: - `projects//agent/sessions/-/contexts/` - `projects//locations//agent/sessions/-/contexts/`", - "items": { - "type": "string" - }, - "type": "array" - }, - "isFallback": { - "description": "Optional. Indicates whether this is a fallback intent.", - "type": "boolean" - }, - "messages": { - "description": "Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" - }, - "type": "array" - }, - "mlDisabled": { - "description": "Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off.", - "type": "boolean" - }, - "mlEnabled": { - "description": "Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false.", - "type": "boolean" - }, - "name": { - "description": "Optional. The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Supported formats: - `projects//agent/intents/` - `projects//locations//agent/intents/`", - "type": "string" - }, - "outputContexts": { - "description": "Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects//agent/sessions/-/contexts/`.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "type": "array" - }, - "parameters": { - "description": "Optional. The collection of parameters associated with the intent.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentParameter" - }, - "type": "array" - }, - "parentFollowupIntentName": { - "description": "Optional. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects//agent/intents/`.", - "type": "string" - }, - "priority": { - "description": "Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests.", - "format": "int32", - "type": "integer" - }, - "resetContexts": { - "description": "Optional. Indicates whether to delete all contexts in the current session when this intent is matched.", - "type": "boolean" - }, - "rootFollowupIntentName": { - "description": "Output only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. Format: `projects//agent/intents/`.", - "readOnly": true, - "type": "string" - }, - "trainingPhrases": { - "description": "Optional. The collection of examples that the agent is trained on.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase" - }, - "type": "array" - }, - "webhookState": { - "description": "Optional. Indicates whether webhooks are enabled for the intent.", - "enum": [ - "WEBHOOK_STATE_UNSPECIFIED", - "WEBHOOK_STATE_ENABLED", - "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" - ], - "enumDescriptions": [ - "Webhook is disabled in the agent and in the intent.", - "Webhook is enabled in the agent and in the intent.", - "Webhook is enabled in the agent and in the intent. Also, each slot filling prompt is forwarded to the webhook." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentBatch": { - "description": "This message is a wrapper around a collection of intents.", - "id": "GoogleCloudDialogflowV2beta1IntentBatch", - "properties": { - "intents": { - "description": "A collection of intents.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo": { - "description": "Represents a single followup intent in the chain.", - "id": "GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo", - "properties": { - "followupIntentName": { - "description": "The unique identifier of the followup intent. Format: `projects//agent/intents/`.", - "type": "string" - }, - "parentFollowupIntentName": { - "description": "The unique identifier of the followup intent's parent. Format: `projects//agent/intents/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessage": { - "description": "Corresponds to the `Response` field in the Dialogflow console.", - "id": "GoogleCloudDialogflowV2beta1IntentMessage", - "properties": { - "basicCard": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard", - "description": "Displays a basic card for Actions on Google." - }, - "browseCarouselCard": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard", - "description": "Browse carousel card for Actions on Google." - }, - "card": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCard", - "description": "Displays a card." - }, - "carouselSelect": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect", - "description": "Displays a carousel card for Actions on Google." - }, - "image": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Displays an image." - }, - "linkOutSuggestion": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion", - "description": "Displays a link out suggestion chip for Actions on Google." - }, - "listSelect": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelect", - "description": "Displays a list card for Actions on Google." - }, - "mediaContent": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent", - "description": "The media content card for Actions on Google." - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "A custom platform-specific response.", - "type": "object" - }, - "platform": { - "description": "Optional. The platform that this message is intended for.", - "enum": [ - "PLATFORM_UNSPECIFIED", - "FACEBOOK", - "SLACK", - "TELEGRAM", - "KIK", - "SKYPE", - "LINE", - "VIBER", - "ACTIONS_ON_GOOGLE", - "TELEPHONY", - "GOOGLE_HANGOUTS" - ], - "enumDescriptions": [ - "Not specified.", - "Facebook.", - "Slack.", - "Telegram.", - "Kik.", - "Skype.", - "Line.", - "Viber.", - "Google Assistant See [Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", - "Telephony Gateway.", - "Google Hangouts." - ], - "type": "string" - }, - "quickReplies": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies", - "description": "Displays quick replies." - }, - "rbmCarouselRichCard": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard", - "description": "Rich Business Messaging (RBM) carousel rich card response." - }, - "rbmStandaloneRichCard": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard", - "description": "Standalone Rich Business Messaging (RBM) rich card response." - }, - "rbmText": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmText", - "description": "Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging." - }, - "simpleResponses": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses", - "description": "Returns a voice or text-only response for Actions on Google." - }, - "suggestions": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions", - "description": "Displays suggestion chips for Actions on Google." - }, - "tableCard": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCard", - "description": "Table card for Actions on Google." - }, - "telephonyPlayAudio": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio", - "description": "Plays audio from a file in Telephony Gateway." - }, - "telephonySynthesizeSpeech": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech", - "description": "Synthesizes speech in Telephony Gateway." - }, - "telephonyTransferCall": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall", - "description": "Transfers the call in Telephony Gateway." - }, - "text": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageText", - "description": "Returns a text response." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageBasicCard": { - "description": "The basic card message. Useful for displaying information.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCard", - "properties": { - "buttons": { - "description": "Optional. The collection of card buttons.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton" - }, - "type": "array" - }, - "formattedText": { - "description": "Required, unless image is present. The body text of the card.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Optional. The image for the card." - }, - "subtitle": { - "description": "Optional. The subtitle of the card.", - "type": "string" - }, - "title": { - "description": "Optional. The title of the card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton": { - "description": "The button object that appears at the bottom of a card.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton", - "properties": { - "openUriAction": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction", - "description": "Required. Action to take when a user taps on the button." - }, - "title": { - "description": "Required. The title of the button.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": { - "description": "Opens the given URI.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction", - "properties": { - "uri": { - "description": "Required. The HTTP or HTTPS scheme URI.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard": { - "description": "Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel", - "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard", - "properties": { - "imageDisplayOptions": { - "description": "Optional. Settings for displaying the image. Applies to every image in items.", - "enum": [ - "IMAGE_DISPLAY_OPTIONS_UNSPECIFIED", - "GRAY", - "WHITE", - "CROPPED", - "BLURRED_BACKGROUND" - ], - "enumDescriptions": [ - "Fill the gaps between the image and the image container with gray bars.", - "Fill the gaps between the image and the image container with gray bars.", - "Fill the gaps between the image and the image container with white bars.", - "Image is scaled such that the image width and height match or exceed the container dimensions. This may crop the top and bottom of the image if the scaled image height is greater than the container height, or crop the left and right of the image if the scaled image width is greater than the container width. This is similar to \"Zoom Mode\" on a widescreen TV when playing a 4:3 video.", - "Pad the gaps between image and image frame with a blurred copy of the same image." - ], - "type": "string" - }, - "items": { - "description": "Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem": { - "description": "Browsing carousel tile", - "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem", - "properties": { - "description": { - "description": "Optional. Description of the carousel item. Maximum of four lines of text.", - "type": "string" - }, - "footer": { - "description": "Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Optional. Hero image for the carousel item." - }, - "openUriAction": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", - "description": "Required. Action to present to the user." - }, - "title": { - "description": "Required. Title of the carousel item. Maximum of two lines of text.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": { - "description": "Actions on Google action to open a given url.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction", - "properties": { - "url": { - "description": "Required. URL", - "type": "string" - }, - "urlTypeHint": { - "description": "Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser.", - "enum": [ - "URL_TYPE_HINT_UNSPECIFIED", - "AMP_ACTION", - "AMP_CONTENT" - ], - "enumDescriptions": [ - "Unspecified", - "Url would be an amp action", - "URL that points directly to AMP content, or to a canonical URL which refers to AMP content via ." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageCard": { - "description": "The card response message.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageCard", - "properties": { - "buttons": { - "description": "Optional. The collection of card buttons.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCardButton" - }, - "type": "array" - }, - "imageUri": { - "description": "Optional. The public URI to an image file for the card.", - "type": "string" - }, - "subtitle": { - "description": "Optional. The subtitle of the card.", - "type": "string" - }, - "title": { - "description": "Optional. The title of the card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageCardButton": { - "description": "Optional. Contains information about a button.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageCardButton", - "properties": { - "postback": { - "description": "Optional. The text to send back to the Dialogflow API or a URI to open.", - "type": "string" - }, - "text": { - "description": "Optional. The text to show on the button.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect": { - "description": "The card for presenting a carousel of options to select from.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect", - "properties": { - "items": { - "description": "Required. Carousel items.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": { - "description": "An item in the carousel.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem", - "properties": { - "description": { - "description": "Optional. The body text of the card.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Optional. The image to display." - }, - "info": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo", - "description": "Required. Additional info about the option item." - }, - "title": { - "description": "Required. Title of the carousel item.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties": { - "description": "Column properties for TableCard.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties", - "properties": { - "header": { - "description": "Required. Column heading.", - "type": "string" - }, - "horizontalAlignment": { - "description": "Optional. Defines text alignment for all cells in this column.", - "enum": [ - "HORIZONTAL_ALIGNMENT_UNSPECIFIED", - "LEADING", - "CENTER", - "TRAILING" - ], - "enumDescriptions": [ - "Text is aligned to the leading edge of the column.", - "Text is aligned to the leading edge of the column.", - "Text is centered in the column.", - "Text is aligned to the trailing edge of the column." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageImage": { - "description": "The image response message.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "properties": { - "accessibilityText": { - "description": "A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect.", - "type": "string" - }, - "imageUri": { - "description": "Optional. The public URI to an image file.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion": { - "description": "The suggestion chip message that allows the user to jump out to the app or website associated with this agent.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion", - "properties": { - "destinationName": { - "description": "Required. The name of the app or site this chip is linking to.", - "type": "string" - }, - "uri": { - "description": "Required. The URI of the app or site to open when the user taps the suggestion chip.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageListSelect": { - "description": "The card for presenting a list of options to select from.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageListSelect", - "properties": { - "items": { - "description": "Required. List items.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem" - }, - "type": "array" - }, - "subtitle": { - "description": "Optional. Subtitle of the list.", - "type": "string" - }, - "title": { - "description": "Optional. The overall title of the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": { - "description": "An item in the list.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageListSelectItem", - "properties": { - "description": { - "description": "Optional. The main text describing the item.", - "type": "string" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Optional. The image to display." - }, - "info": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo", - "description": "Required. Additional information about this option." - }, - "title": { - "description": "Required. The title of the list item.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageMediaContent": { - "description": "The media content card for Actions on Google.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContent", - "properties": { - "mediaObjects": { - "description": "Required. List of media objects.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject" - }, - "type": "array" - }, - "mediaType": { - "description": "Optional. What type of media is the content (ie \"audio\").", - "enum": [ - "RESPONSE_MEDIA_TYPE_UNSPECIFIED", - "AUDIO" - ], - "enumDescriptions": [ - "Unspecified.", - "Response media type is audio." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject": { - "description": "Response media object for media content card.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject", - "properties": { - "contentUrl": { - "description": "Required. Url where the media is stored.", - "type": "string" - }, - "description": { - "description": "Optional. Description of media card.", - "type": "string" - }, - "icon": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Optional. Icon to display above media content." - }, - "largeImage": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Optional. Image to display above media content." - }, - "name": { - "description": "Required. Name of media card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies": { - "description": "The quick replies response message.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageQuickReplies", - "properties": { - "quickReplies": { - "description": "Optional. The collection of quick replies.", - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "description": "Optional. The title of the collection of quick replies.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent": { - "description": "Rich Business Messaging (RBM) Card content", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent", - "properties": { - "description": { - "description": "Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set.", - "type": "string" - }, - "media": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia", - "description": "Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card." - }, - "suggestions": { - "description": "Optional. List of suggestions to include in the card.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion" - }, - "type": "array" - }, - "title": { - "description": "Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia": { - "description": "Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: Image Types * image/jpeg * image/jpg' * image/gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * video/mpeg4 * video/webm", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia", - "properties": { - "fileUri": { - "description": "Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL.", - "type": "string" - }, - "height": { - "description": "Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored.", - "enum": [ - "HEIGHT_UNSPECIFIED", - "SHORT", - "MEDIUM", - "TALL" - ], - "enumDescriptions": [ - "Not specified.", - "112 DP.", - "168 DP.", - "264 DP. Not available for rich card carousels when the card width is set to small." - ], - "type": "string" - }, - "thumbnailUri": { - "description": "Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard": { - "description": "Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard", - "properties": { - "cardContents": { - "description": "Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent" - }, - "type": "array" - }, - "cardWidth": { - "description": "Required. The width of the cards in the carousel.", - "enum": [ - "CARD_WIDTH_UNSPECIFIED", - "SMALL", - "MEDIUM" - ], - "enumDescriptions": [ - "Not specified.", - "120 DP. Note that tall media cannot be used.", - "232 DP." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard": { - "description": "Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard", - "properties": { - "cardContent": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent", - "description": "Required. Card content." - }, - "cardOrientation": { - "description": "Required. Orientation of the card.", - "enum": [ - "CARD_ORIENTATION_UNSPECIFIED", - "HORIZONTAL", - "VERTICAL" - ], - "enumDescriptions": [ - "Not specified.", - "Horizontal layout.", - "Vertical layout." - ], - "type": "string" - }, - "thumbnailImageAlignment": { - "description": "Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout.", - "enum": [ - "THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED", - "LEFT", - "RIGHT" - ], - "enumDescriptions": [ - "Not specified.", - "Thumbnail preview is left-aligned.", - "Thumbnail preview is right-aligned." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction": { - "description": "Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction", - "properties": { - "dial": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial", - "description": "Suggested client side action: Dial a phone number" - }, - "openUrl": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri", - "description": "Suggested client side action: Open a URI on device" - }, - "postbackData": { - "description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic.", - "type": "string" - }, - "shareLocation": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation", - "description": "Suggested client side action: Share user location" - }, - "text": { - "description": "Text to display alongside the action.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial": { - "description": "Opens the user's default dialer app with the specified phone number but does not dial automatically.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial", - "properties": { - "phoneNumber": { - "description": "Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri": { - "description": "Opens the user's default web browser app to the specified uri If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri", - "properties": { - "uri": { - "description": "Required. The uri to open on the user device", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation": { - "description": "Opens the device's location chooser so the user can pick a location to send back to the agent.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply": { - "description": "Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply", - "properties": { - "postbackData": { - "description": "Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic.", - "type": "string" - }, - "text": { - "description": "Suggested reply text.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion": { - "description": "Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri).", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion", - "properties": { - "action": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction", - "description": "Predefined client side actions that user can choose" - }, - "reply": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply", - "description": "Predefined replies for user to select instead of typing" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageRbmText": { - "description": "Rich Business Messaging (RBM) text response with suggestions.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageRbmText", - "properties": { - "rbmSuggestion": { - "description": "Optional. One or more suggestions to show to the user.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion" - }, - "type": "array" - }, - "text": { - "description": "Required. Text sent and displayed to the user.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": { - "description": "Additional info about the select item for when it is triggered in a dialog.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo", - "properties": { - "key": { - "description": "Required. A unique key that will be sent back to the agent if this response is given.", - "type": "string" - }, - "synonyms": { - "description": "Optional. A list of synonyms that can also be used to trigger this item in dialog.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": { - "description": "The simple response message containing speech or text.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse", - "properties": { - "displayText": { - "description": "Optional. The text to display.", - "type": "string" - }, - "ssml": { - "description": "One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.", - "type": "string" - }, - "textToSpeech": { - "description": "One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses": { - "description": "The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses", - "properties": { - "simpleResponses": { - "description": "Required. The list of simple responses.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageSuggestion": { - "description": "The suggestion chip message that the user can tap to quickly post a reply to the conversation.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion", - "properties": { - "title": { - "description": "Required. The text shown the in the suggestion chip.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageSuggestions": { - "description": "The collection of suggestions.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageSuggestions", - "properties": { - "suggestions": { - "description": "Required. The list of suggested replies.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageSuggestion" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageTableCard": { - "description": "Table card for Actions on Google.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCard", - "properties": { - "buttons": { - "description": "Optional. List of buttons for the card.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton" - }, - "type": "array" - }, - "columnProperties": { - "description": "Optional. Display properties for the columns in this table.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageColumnProperties" - }, - "type": "array" - }, - "image": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageImage", - "description": "Optional. Image which should be displayed on the card." - }, - "rows": { - "description": "Optional. Rows in this table of data.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow" - }, - "type": "array" - }, - "subtitle": { - "description": "Optional. Subtitle to the title.", - "type": "string" - }, - "title": { - "description": "Required. Title of the card.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell": { - "description": "Cell of TableCardRow.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell", - "properties": { - "text": { - "description": "Required. Text in this cell.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow": { - "description": "Row of TableCard.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageTableCardRow", - "properties": { - "cells": { - "description": "Optional. List of cells that make up this row.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessageTableCardCell" - }, - "type": "array" - }, - "dividerAfter": { - "description": "Optional. Whether to add a visual divider after this row.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio": { - "description": "Plays audio from a file in Telephony Gateway.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio", - "properties": { - "audioUri": { - "description": "Required. URI to a Google Cloud Storage object containing the audio to play, e.g., \"gs://bucket/object\". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech": { - "description": "Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech", - "properties": { - "ssml": { - "description": "The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml).", - "type": "string" - }, - "text": { - "description": "The raw text to be synthesized.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall": { - "description": "Transfers the call in Telephony Gateway.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall", - "properties": { - "phoneNumber": { - "description": "Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentMessageText": { - "description": "The text response message.", - "id": "GoogleCloudDialogflowV2beta1IntentMessageText", - "properties": { - "text": { - "description": "Optional. The collection of the agent's responses.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentParameter": { - "description": "Represents intent parameters.", - "id": "GoogleCloudDialogflowV2beta1IntentParameter", - "properties": { - "defaultValue": { - "description": "Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`.", - "type": "string" - }, - "displayName": { - "description": "Required. The name of the parameter.", - "type": "string" - }, - "entityTypeDisplayName": { - "description": "Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided.", - "type": "string" - }, - "isList": { - "description": "Optional. Indicates whether the parameter represents a list of values.", - "type": "boolean" - }, - "mandatory": { - "description": "Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.", - "type": "boolean" - }, - "name": { - "description": "The unique identifier of this parameter.", - "type": "string" - }, - "prompts": { - "description": "Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter.", - "items": { - "type": "string" - }, - "type": "array" - }, - "value": { - "description": "Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentTrainingPhrase": { - "description": "Represents an example that the agent is trained on.", - "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrase", - "properties": { - "name": { - "description": "Output only. The unique identifier of this training phrase.", - "type": "string" - }, - "parts": { - "description": "Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart" - }, - "type": "array" - }, - "timesAddedCount": { - "description": "Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "Required. The type of the training phrase.", - "enum": [ - "TYPE_UNSPECIFIED", - "EXAMPLE", - "TEMPLATE" - ], - "enumDescriptions": [ - "Not specified. This value should never be used.", - "Examples do not contain @-prefixed entity type names, but example parts can be annotated with entity types.", - "Templates are not annotated with entity types, but they can contain @-prefixed entity type names as substrings. Template mode has been deprecated. Example mode is the only supported way to create new training phrases. If you have existing training phrases that you've created in template mode, those will continue to work." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart": { - "description": "Represents a part of a training phrase.", - "id": "GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart", - "properties": { - "alias": { - "description": "Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase.", - "type": "string" - }, - "entityType": { - "description": "Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase.", - "type": "string" - }, - "text": { - "description": "Required. The text for this part.", - "type": "string" - }, - "userDefined": { - "description": "Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1KnowledgeAnswers": { - "description": "Represents the result of querying a Knowledge base.", - "id": "GoogleCloudDialogflowV2beta1KnowledgeAnswers", - "properties": { - "answers": { - "description": "A list of answers from Knowledge Connector.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer": { - "description": "An answer from Knowledge Connector.", - "id": "GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer", - "properties": { - "answer": { - "description": "The piece of text from the `source` knowledge base document that answers this conversational query.", - "type": "string" - }, - "faqQuestion": { - "description": "The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise.", - "type": "string" - }, - "matchConfidence": { - "description": "The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using `match_confidence_level` which should be generally more stable.", - "format": "float", - "type": "number" - }, - "matchConfidenceLevel": { - "description": "The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer.", - "enum": [ - "MATCH_CONFIDENCE_LEVEL_UNSPECIFIED", - "LOW", - "MEDIUM", - "HIGH" - ], - "enumDescriptions": [ - "Not specified.", - "Indicates that the confidence is low.", - "Indicates our confidence is medium.", - "Indicates our confidence is high." - ], - "type": "string" - }, - "source": { - "description": "Indicates which Knowledge Document this answer was extracted from. Format: `projects//knowledgeBases//documents/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1KnowledgeBase": { - "description": "A knowledge base represents a collection of knowledge documents that you provide to Dialogflow. Your knowledge documents contain information that may be useful during conversations with end-users. Some Dialogflow features use knowledge bases when looking for a response to an end-user input. For more information, see the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`.", - "id": "GoogleCloudDialogflowV2beta1KnowledgeBase", - "properties": { - "displayName": { - "description": "Required. The display name of the knowledge base. The name must be 1024 bytes or less; otherwise, the creation request fails.", - "type": "string" - }, - "languageCode": { - "description": "Language which represents the KnowledgeBase. When the KnowledgeBase is created/updated, this is populated for all non en-us languages. If not populated, the default language en-us applies.", - "type": "string" - }, - "name": { - "description": "The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//knowledgeBases/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": { - "description": "Metadata in google::longrunning::Operation for Knowledge operations.", - "id": "GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata", - "properties": { - "state": { - "description": "Required. Output only. The current state of this operation.", - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "DONE" - ], - "enumDescriptions": [ - "State unspecified.", - "The operation has been created.", - "The operation is currently running.", - "The operation is done, either cancelled or completed." - ], - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1LabelConversationResponse": { - "description": "The response for ConversationDatasets.LabelConversation.", - "id": "GoogleCloudDialogflowV2beta1LabelConversationResponse", - "properties": { - "annotatedConversationDataset": { - "$ref": "GoogleCloudDialogflowV2beta1AnnotatedConversationDataset", - "description": "New annotated conversation dataset created by the labeling task." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ListContextsResponse": { - "description": "The response message for Contexts.ListContexts.", - "id": "GoogleCloudDialogflowV2beta1ListContextsResponse", - "properties": { - "contexts": { - "description": "The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ListDocumentsResponse": { - "description": "Response message for Documents.ListDocuments.", - "id": "GoogleCloudDialogflowV2beta1ListDocumentsResponse", - "properties": { - "documents": { - "description": "The list of documents.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Document" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ListEntityTypesResponse": { - "description": "The response message for EntityTypes.ListEntityTypes.", - "id": "GoogleCloudDialogflowV2beta1ListEntityTypesResponse", - "properties": { - "entityTypes": { - "description": "The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1EntityType" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse": { - "description": "The response message for Environments.ListEnvironments.", - "id": "GoogleCloudDialogflowV2beta1ListEnvironmentsResponse", - "properties": { - "environments": { - "description": "The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Environment" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ListIntentsResponse": { - "description": "The response message for Intents.ListIntents.", - "id": "GoogleCloudDialogflowV2beta1ListIntentsResponse", - "properties": { - "intents": { - "description": "The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Intent" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse": { - "description": "Response message for KnowledgeBases.ListKnowledgeBases.", - "id": "GoogleCloudDialogflowV2beta1ListKnowledgeBasesResponse", - "properties": { - "knowledgeBases": { - "description": "The list of knowledge bases.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeBase" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse": { - "description": "The response message for SessionEntityTypes.ListSessionEntityTypes.", - "id": "GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse", - "properties": { - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - }, - "sessionEntityTypes": { - "description": "The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": { - "description": "Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call.", - "id": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest", - "properties": { - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { \"telephony\": { \"caller_id\": \"+18558363987\" } } Note: The caller ID field (`caller_id`) will be redacted for Trial Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Essentials Edition agents.", - "type": "object" - }, - "source": { - "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers.", - "type": "string" - }, - "version": { - "description": "Optional. The version of the protocol used for this request. This field is AoG-specific.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1OutputAudioConfig": { - "description": "Instructs the speech synthesizer how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.", - "id": "GoogleCloudDialogflowV2beta1OutputAudioConfig", - "properties": { - "audioEncoding": { - "description": "Required. Audio encoding of the synthesized audio content.", - "enum": [ - "OUTPUT_AUDIO_ENCODING_UNSPECIFIED", - "OUTPUT_AUDIO_ENCODING_LINEAR_16", - "OUTPUT_AUDIO_ENCODING_MP3", - "OUTPUT_AUDIO_ENCODING_OGG_OPUS" - ], - "enumDescriptions": [ - "Not specified.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", - "MP3 audio at 32kbps.", - "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate." - ], - "type": "string" - }, - "sampleRateHertz": { - "description": "The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality).", - "format": "int32", - "type": "integer" - }, - "synthesizeSpeechConfig": { - "$ref": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig", - "description": "Configuration of how speech should be synthesized." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1QueryInput": { - "description": "Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio. 2. A conversational query in the form of text. 3. An event that specifies which intent to trigger.", - "id": "GoogleCloudDialogflowV2beta1QueryInput", - "properties": { - "audioConfig": { - "$ref": "GoogleCloudDialogflowV2beta1InputAudioConfig", - "description": "Instructs the speech recognizer how to process the speech audio." - }, - "event": { - "$ref": "GoogleCloudDialogflowV2beta1EventInput", - "description": "The event to be processed." - }, - "text": { - "$ref": "GoogleCloudDialogflowV2beta1TextInput", - "description": "The natural language text to be processed." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1QueryParameters": { - "description": "Represents the parameters of the conversational query.", - "id": "GoogleCloudDialogflowV2beta1QueryParameters", - "properties": { - "contexts": { - "description": "The collection of contexts to be activated before this query is executed.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "type": "array" - }, - "geoLocation": { - "$ref": "GoogleTypeLatLng", - "description": "The geo location of this conversational query." - }, - "knowledgeBaseNames": { - "description": "KnowledgeBases to get alternative results from. If not set, the KnowledgeBases enabled in the agent (through UI) will be used. Format: `projects//knowledgeBases/`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "This field can be used to pass custom data to your webhook. Arbitrary JSON objects are supported. If supplied, the value is used to populate the `WebhookRequest.original_detect_intent_request.payload` field sent to your webhook.", - "type": "object" - }, - "resetContexts": { - "description": "Specifies whether to delete all contexts in the current session before the new ones are activated.", - "type": "boolean" - }, - "sentimentAnalysisRequestConfig": { - "$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig", - "description": "Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. Note: Sentiment Analysis is only currently available for Essentials Edition agents." - }, - "sessionEntityTypes": { - "description": "Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "type": "array" - }, - "subAgents": { - "description": "For mega agent query, directly specify which sub agents to query. If any specified sub agent is not linked to the mega agent, an error will be returned. If empty, Dialogflow will decide which sub agents to query. If specified for a non-mega-agent query, will be silently ignored.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1SubAgent" - }, - "type": "array" - }, - "timeZone": { - "description": "The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.", - "type": "string" - }, - "webhookHeaders": { - "additionalProperties": { - "type": "string" - }, - "description": "This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook alone with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: \"Host\", \"Content-Length\", \"Connection\", \"From\", \"User-Agent\", \"Accept-Encoding\", \"If-Modified-Since\", \"If-None-Match\", \"X-Forwarded-For\", etc.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1QueryResult": { - "description": "Represents the result of conversational query or event processing.", - "id": "GoogleCloudDialogflowV2beta1QueryResult", - "properties": { - "action": { - "description": "The action name from the matched intent.", - "type": "string" - }, - "allRequiredParamsPresent": { - "description": "This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters.", - "type": "boolean" - }, - "diagnosticInfo": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors", - "type": "object" - }, - "fulfillmentMessages": { - "description": "The collection of rich messages to present to the user.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" - }, - "type": "array" - }, - "fulfillmentText": { - "description": "The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred.", - "type": "string" - }, - "intent": { - "$ref": "GoogleCloudDialogflowV2beta1Intent", - "description": "The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`." - }, - "intentDetectionConfidence": { - "description": "The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list.", - "format": "float", - "type": "number" - }, - "knowledgeAnswers": { - "$ref": "GoogleCloudDialogflowV2beta1KnowledgeAnswers", - "description": "The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`." - }, - "languageCode": { - "description": "The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", - "type": "string" - }, - "outputContexts": { - "description": "The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `.original` containing the original parameter values before the query.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "type": "array" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value", - "type": "object" - }, - "queryText": { - "description": "The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input.", - "type": "string" - }, - "sentimentAnalysisResult": { - "$ref": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult", - "description": "The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request." - }, - "speechRecognitionConfidence": { - "description": "The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.", - "format": "float", - "type": "number" - }, - "webhookPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response.", - "type": "object" - }, - "webhookSource": { - "description": "If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ReloadDocumentRequest": { - "description": "Request message for Documents.ReloadDocument.", - "id": "GoogleCloudDialogflowV2beta1ReloadDocumentRequest", - "properties": { - "gcsSource": { - "$ref": "GoogleCloudDialogflowV2beta1GcsSource", - "description": "The path for a Cloud Storage source file for reloading document content. If not provided, the Document's existing source will be reloaded." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1RestoreAgentRequest": { - "description": "The request message for Agents.RestoreAgent.", - "id": "GoogleCloudDialogflowV2beta1RestoreAgentRequest", - "properties": { - "agentContent": { - "description": "Zip compressed raw byte content for agent.", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with \"gs://\".", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SearchAgentsResponse": { - "description": "The response message for Agents.SearchAgents.", - "id": "GoogleCloudDialogflowV2beta1SearchAgentsResponse", - "properties": { - "agents": { - "description": "The list of agents. There will be a maximum number of items returned based on the page_size field in the request.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Agent" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1Sentiment": { - "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.", - "id": "GoogleCloudDialogflowV2beta1Sentiment", - "properties": { - "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative).", - "format": "float", - "type": "number" - }, - "score": { - "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig": { - "description": "Configures the types of sentiment analysis to perform.", - "id": "GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig", - "properties": { - "analyzeQueryTextSentiment": { - "description": "Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SentimentAnalysisResult": { - "description": "The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config", - "id": "GoogleCloudDialogflowV2beta1SentimentAnalysisResult", - "properties": { - "queryTextSentiment": { - "$ref": "GoogleCloudDialogflowV2beta1Sentiment", - "description": "The sentiment analysis result for `query_text`." - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SessionEntityType": { - "description": "A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the [session entity guide](https://cloud.google.com/dialogflow/docs/entities-session).", - "id": "GoogleCloudDialogflowV2beta1SessionEntityType", - "properties": { - "entities": { - "description": "Required. The collection of entities associated with this session entity type.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1EntityTypeEntity" - }, - "type": "array" - }, - "entityOverrideMode": { - "description": "Required. Indicates whether the additional data should override or supplement the custom entity type definition.", - "enum": [ - "ENTITY_OVERRIDE_MODE_UNSPECIFIED", - "ENTITY_OVERRIDE_MODE_OVERRIDE", - "ENTITY_OVERRIDE_MODE_SUPPLEMENT" - ], - "enumDescriptions": [ - "Not specified. This value should be never used.", - "The collection of session entities overrides the collection of entities in the corresponding custom entity type.", - "The collection of session entities extends the collection of entities in the corresponding custom entity type. Note: Even in this override mode calls to `ListSessionEntityTypes`, `GetSessionEntityType`, `CreateSessionEntityType` and `UpdateSessionEntityType` only return the additional entities added in this session entity type. If you want to get the supplemented list, please call EntityTypes.GetEntityType on the custom entity type and merge." - ], - "type": "string" - }, - "name": { - "description": "Required. The unique identifier of this session entity type. Supported formats: - `projects//agent/sessions//entityTypes/` - `projects//locations//agent/sessions//entityTypes/` - `projects//agent/environments//users//sessions//entityTypes/` - `projects//locations//agent/environments/ /users//sessions//entityTypes/` If `Location ID` is not specified we assume default 'us' location. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SmartMessagingEntry": { - "description": "Smart Messaging Entry resource.", - "id": "GoogleCloudDialogflowV2beta1SmartMessagingEntry", - "properties": { - "messageInfo": { - "$ref": "GoogleCloudDialogflowV2beta1SmartMessagingEntryInfo", - "description": "Output only. Metadata of the message entry" - }, - "name": { - "description": "The unique identifier of this message entry. Required for [Documents.GetSmartMessagingEntry], [Documents.CreateSmartMessagingEntry], [Documents.UpdateSmartMessagingEntry], and [Documents.DeleteSmartMessagingEntry]. Format: `projects//knowledgeBases//documents//smartMessagingEntries/`", - "type": "string" - }, - "rawText": { - "description": "Required. The raw text of the message.", - "type": "string" - }, - "state": { - "description": "Required. Smart Messaging Entry's enabled/disabled state.", - "enum": [ - "SMART_MESSAGING_ENTRY_STATE_UNSPECIFIED", - "ENABLED", - "DISABLED" - ], - "enumDescriptions": [ - "State unspecified.", - "This smart reply message is enabled and used when generating suggestions.", - "This smart reply message is disabled and is not used when generating suggestions." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SmartMessagingEntryInfo": { - "description": "Smart messaging entry info.", - "id": "GoogleCloudDialogflowV2beta1SmartMessagingEntryInfo", - "properties": { - "creationMethod": { - "description": "Output only. Method of how the smart messaging entry was created. When the smart messaging entry was generated from GenerateDocument, the value is AUTOMATIC; when the entry was manually added through CreateSmartMessagingEntry, the value is MANUAL.", - "enum": [ - "CREATION_METHOD_UNSPECIFIED", - "AUTOMATIC", - "MANUAL" - ], - "enumDescriptions": [ - "The creation method of the smart messaging entry is unspecified. The value is unused.", - "The smart messaging entry was generated automatically from backend pipeline.", - "The smart messaging entry was added manually." - ], - "readOnly": true, - "type": "string" - }, - "occurrenceCount": { - "description": "The number of times an entry's message text has been uttered", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SpeechContext": { - "description": "Hints for the speech recognizer to help with recognition in a specific conversation state.", - "id": "GoogleCloudDialogflowV2beta1SpeechContext", - "properties": { - "boost": { - "description": "Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search.", - "format": "float", - "type": "number" - }, - "phrases": { - "description": "Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. This list can be used to: * improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent * add additional words to the speech recognizer vocabulary * ... See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/quotas) for usage limits.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SubAgent": { - "description": "Contains basic configuration for a sub-agent.", - "id": "GoogleCloudDialogflowV2beta1SubAgent", - "properties": { - "environment": { - "description": "Optional. The unique identifier (`environment name` in dialogflow console) of this sub-agent environment. Assumes draft environment if `environment` is not set.", - "type": "string" - }, - "project": { - "description": "Required. The project of this agent. Format: `projects/` or `projects//locations/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig": { - "description": "Configuration of how speech should be synthesized.", - "id": "GoogleCloudDialogflowV2beta1SynthesizeSpeechConfig", - "properties": { - "effectsProfileId": { - "description": "Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given.", - "items": { - "type": "string" - }, - "type": "array" - }, - "pitch": { - "description": "Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.", - "format": "double", - "type": "number" - }, - "speakingRate": { - "description": "Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.", - "format": "double", - "type": "number" - }, - "voice": { - "$ref": "GoogleCloudDialogflowV2beta1VoiceSelectionParams", - "description": "Optional. The desired voice of the synthesized audio." - }, - "volumeGainDb": { - "description": "Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1TextInput": { - "description": "Represents the natural language text to be processed.", - "id": "GoogleCloudDialogflowV2beta1TextInput", - "properties": { - "languageCode": { - "description": "Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", - "type": "string" - }, - "text": { - "description": "Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1TrainAgentRequest": { - "description": "The request message for Agents.TrainAgent.", - "id": "GoogleCloudDialogflowV2beta1TrainAgentRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ValidationError": { - "description": "Represents a single validation error.", - "id": "GoogleCloudDialogflowV2beta1ValidationError", - "properties": { - "entries": { - "description": "The names of the entries that the error is associated with. Format: - \"projects//agent\", if the error is associated with the entire agent. - \"projects//agent/intents/\", if the error is associated with certain intents. - \"projects//agent/intents//trainingPhrases/\", if the error is associated with certain intent training phrases. - \"projects//agent/intents//parameters/\", if the error is associated with certain intent parameters. - \"projects//agent/entities/\", if the error is associated with certain entities.", - "items": { - "type": "string" - }, - "type": "array" - }, - "errorMessage": { - "description": "The detailed error messsage.", - "type": "string" - }, - "severity": { - "description": "The severity of the error.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "INFO", - "WARNING", - "ERROR", - "CRITICAL" - ], - "enumDescriptions": [ - "Not specified. This value should never be used.", - "The agent doesn't follow Dialogflow best practicies.", - "The agent may not behave as expected.", - "The agent may experience partial failures.", - "The agent may completely fail." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1ValidationResult": { - "description": "Represents the output of agent validation.", - "id": "GoogleCloudDialogflowV2beta1ValidationResult", - "properties": { - "validationErrors": { - "description": "Contains all validation errors.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1ValidationError" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1VoiceSelectionParams": { - "description": "Description of which voice to use for speech synthesis.", - "id": "GoogleCloudDialogflowV2beta1VoiceSelectionParams", - "properties": { - "name": { - "description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender.", - "type": "string" - }, - "ssmlGender": { - "description": "Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.", - "enum": [ - "SSML_VOICE_GENDER_UNSPECIFIED", - "SSML_VOICE_GENDER_MALE", - "SSML_VOICE_GENDER_FEMALE", - "SSML_VOICE_GENDER_NEUTRAL" - ], - "enumDescriptions": [ - "An unspecified gender, which means that the client doesn't care which gender the selected voice will have.", - "A male voice.", - "A female voice.", - "A gender-neutral voice." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1WebhookRequest": { - "description": "The request message for a webhook call.", - "id": "GoogleCloudDialogflowV2beta1WebhookRequest", - "properties": { - "alternativeQueryResults": { - "description": "Alternative query results from KnowledgeService.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1QueryResult" - }, - "type": "array" - }, - "originalDetectIntentRequest": { - "$ref": "GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest", - "description": "Optional. The contents of the original request that was passed to `[Streaming]DetectIntent` call." - }, - "queryResult": { - "$ref": "GoogleCloudDialogflowV2beta1QueryResult", - "description": "The result of the conversational query or event processing. Contains the same value as `[Streaming]DetectIntentResponse.query_result`." - }, - "responseId": { - "description": "The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`.", - "type": "string" - }, - "session": { - "description": "The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Supported formats: - `projects//agent/sessions/, - `projects//locations//agent/sessions/`, - `projects//agent/environments//users//sessions/`, - `projects//locations//agent/environments//users//sessions/`,", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV2beta1WebhookResponse": { - "description": "The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `\"\"` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).", - "id": "GoogleCloudDialogflowV2beta1WebhookResponse", - "properties": { - "endInteraction": { - "description": "Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.", - "type": "boolean" - }, - "followupEventInput": { - "$ref": "GoogleCloudDialogflowV2beta1EventInput", - "description": "Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields." - }, - "fulfillmentMessages": { - "description": "Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1IntentMessage" - }, - "type": "array" - }, - "fulfillmentText": { - "description": "Optional. The text response message intended for the end-user. It is recommended to use `fulfillment_messages.text.text[0]` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.", - "type": "string" - }, - "outputContexts": { - "description": "Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1Context" - }, - "type": "array" - }, - "payload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)", - "type": "object" - }, - "sessionEntityTypes": { - "description": "Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using `detectIntent`, `streamingDetectIntent` or SessionEntityType management methods.", - "items": { - "$ref": "GoogleCloudDialogflowV2beta1SessionEntityType" - }, - "type": "array" - }, - "source": { - "description": "Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ExportAgentResponse": { - "description": "The response message for Agents.ExportAgent.", - "id": "GoogleCloudDialogflowV3alpha1ExportAgentResponse", - "properties": { - "agentContent": { - "description": "Uncompressed raw byte content for agent.", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in ExportAgentRequest.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ExportTestCasesMetadata": { - "description": "Metadata returned for the TestCases.ExportTestCases long running operation.", - "id": "GoogleCloudDialogflowV3alpha1ExportTestCasesMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ExportTestCasesResponse": { - "description": "The response message for TestCases.ExportTestCases.", - "id": "GoogleCloudDialogflowV3alpha1ExportTestCasesResponse", - "properties": { - "content": { - "description": "Uncompressed raw byte content for test cases.", - "format": "byte", - "type": "string" - }, - "gcsUri": { - "description": "The URI to a file containing the exported test cases. This field is populated only if `gcs_uri` is specified in ExportTestCasesRequest.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ImportAgentResponse": { - "description": "The response message for Agents.ImportAgent.", - "id": "GoogleCloudDialogflowV3alpha1ImportAgentResponse", - "properties": { - "agent": { - "description": "The unique identifier of the new agent. Format: `projects//locations//agents/`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ImportTestCasesMetadata": { - "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", - "id": "GoogleCloudDialogflowV3alpha1ImportTestCasesMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDialogflowV3alpha1ImportTestCasesResponse": { - "description": "The response message for TestCases.ImportTestCases.", - "id": "GoogleCloudDialogflowV3alpha1ImportTestCasesResponse", - "properties": { - "names": { - "description": "The unique identifiers of the new test cases. Format: `projects//locations//agents//testCases/`.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleLongrunningListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "GoogleLongrunningListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "GoogleLongrunningOperation" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleLongrunningOperation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "GoogleLongrunningOperation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleProtobufEmpty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "GoogleProtobufEmpty", - "properties": {}, - "type": "object" - }, - "GoogleRpcStatus": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "GoogleRpcStatus", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleTypeLatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.", - "id": "GoogleTypeLatLng", - "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", - "format": "double", - "type": "number" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Dialogflow API", - "version": "v2beta1", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/documentai__v1beta2.json b/discovery/googleapis_beta/documentai__v1beta3.json similarity index 62% rename from discovery/googleapis_beta/documentai__v1beta2.json rename to discovery/googleapis_beta/documentai__v1beta3.json index d1754c3..0434017 100644 --- a/discovery/googleapis_beta/documentai__v1beta2.json +++ b/discovery/googleapis_beta/documentai__v1beta3.json
@@ -19,7 +19,7 @@ "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "id": "documentai:v1beta2", + "id": "documentai:v1beta3", "kind": "discovery#restDescription", "name": "documentai", "ownerDomain": "google.com", @@ -105,124 +105,74 @@ "resources": { "projects": { "resources": { - "documents": { + "locations": { "methods": { - "batchProcess": { - "description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.", - "httpMethod": "POST", - "id": "documentai.projects.documents.batchProcess", + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "documentai.projects.locations.get", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically.", + "name": { + "description": "Resource name for the location.", "location": "path", - "pattern": "^projects/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta2/{+parent}/documents:batchProcess", - "request": { - "$ref": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest" - }, + "path": "v1beta3/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudLocationLocation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "process": { - "description": "Processes a single document.", - "httpMethod": "POST", - "id": "documentai.projects.documents.process", + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "documentai.projects.locations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" } }, - "path": "v1beta2/{+parent}/documents:process", - "request": { - "$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest" - }, + "path": "v1beta3/{+name}/locations", "response": { - "$ref": "GoogleCloudDocumentaiV1beta2Document" + "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - } - }, - "locations": { + }, "resources": { - "documents": { - "methods": { - "batchProcess": { - "description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.", - "httpMethod": "POST", - "id": "documentai.projects.locations.documents.batchProcess", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+parent}/documents:batchProcess", - "request": { - "$ref": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "process": { - "description": "Processes a single document.", - "httpMethod": "POST", - "id": "documentai.projects.locations.documents.process", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+parent}/documents:process", - "request": { - "$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest" - }, - "response": { - "$ref": "GoogleCloudDocumentaiV1beta2Document" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "operations": { "methods": { "get": { @@ -241,7 +191,7 @@ "type": "string" } }, - "path": "v1beta2/{+name}", + "path": "v1beta3/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -250,46 +200,167 @@ ] } } - } - } - }, - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "documentai.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" + }, + "processors": { + "methods": { + "batchProcess": { + "description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.batchProcess", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVerions/{processorVersion}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}:batchProcess", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "process": { + "description": "Processes a single document.", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.process", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVerions/{processorVersion}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}:process", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessRequest" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, - "path": "v1beta2/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "resources": { + "humanReviewConfig": { + "methods": { + "reviewDocument": { + "description": "Send a document for Human Review. The input document should be processed by the specified processor.", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.humanReviewConfig.reviewDocument", + "parameterOrder": [ + "humanReviewConfig" + ], + "parameters": { + "humanReviewConfig": { + "description": "Required. The resource name of the HumanReviewConfig that the document will be reviewed with.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/humanReviewConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+humanReviewConfig}:reviewDocument", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3ReviewDocumentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "processorVersions": { + "methods": { + "batchProcess": { + "description": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.processorVersions.batchProcess", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVerions/{processorVersion}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}:batchProcess", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "process": { + "description": "Processes a single document.", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.processorVersions.process", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVerions/{processorVersion}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/processorVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}:process", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessRequest" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } } } } }, - "revision": "20200828", + "revision": "20210201", "rootUrl": "https://documentai.googleapis.com/", "schemas": { - "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for CreateLabelerPool.", - "id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata", + "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata": { + "description": "The common metadata for long running operations.", + "id": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "properties": { "createTime": { "description": "The creation time of the operation.", @@ -297,7 +368,7 @@ "type": "string" }, "state": { - "description": "Used only when Operation.done is false.", + "description": "The state of the operation.", "enum": [ "STATE_UNSPECIFIED", "RUNNING", @@ -317,7 +388,7 @@ "type": "string" }, "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", + "description": "A message providing more details about the current state of processing.", "type": "string" }, "updateTime": { @@ -328,43 +399,13 @@ }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata": { - "description": "The metadata that represents a processor version being created.", - "id": "GoogleCloudDocumentaiUiv1beta3CreateProcessorVersionMetadata", + "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata": { + "description": "The long running operation metadata for CreateLabelerPool.", + "id": "GoogleCloudDocumentaiUiv1beta3CreateLabelerPoolOperationMetadata", "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The state of the current disable processor operation.", - "enum": [ - "STATE_UNSPECIFIED", - "QUEUED", - "PREPARING", - "RUNNING", - "SUCCEEDED", - "FAILED", - "CANCELLING", - "CANCELLED" - ], - "enumDescriptions": [ - "The training state is unspecified.", - "The training request has been issued but processing has not yet begun.", - "The service is preparing to execute the training.", - "The training is in progress.", - "The training completed successfully.", - "The training failed. `error` should contain the details of the failure.", - "The training is being cancelled. `error` should describe the reason for the cancellation.", - "The training has been cancelled. `error` should describe the reason for the cancellation." - ], - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." } }, "type": "object" @@ -373,39 +414,9 @@ "description": "The long running operation metadata for DeleteLabelerPool.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteLabelerPoolOperationMetadata", "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "Used only when Operation.done is false.", - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "CANCELLING", - "SUCCEEDED", - "FAILED", - "CANCELLED" - ], - "enumDescriptions": [ - "Unspecified state.", - "Operation is still running.", - "Operation is being cancelled.", - "Operation succeeded.", - "Operation failed.", - "Operation is cancelled." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." } }, "type": "object" @@ -414,80 +425,48 @@ "description": "The long running operation metadata for delete processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorMetadata", "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The state of the current delete processor operation.", - "enum": [ - "STATE_UNSPECIFIED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The operation is completed successfully.", - "The operation has failed." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." } }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata": { + "description": "The long running operation metadata for delete processor version method.", + "id": "GoogleCloudDocumentaiUiv1beta3DeleteProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata": { + "description": "The long running operation metadata for deploy processor version method.", + "id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse": { + "description": "Response message for the deploy processor version method.", + "id": "GoogleCloudDocumentaiUiv1beta3DeployProcessorVersionResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata": { "description": "The long running operation metadata for disable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3DisableProcessorMetadata", "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The state of the current disable processor operation.", - "enum": [ - "STATE_UNSPECIFIED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "CANCELLING", - "CANCELLED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The operation is completed successfully.", - "The operation was being cancelled.", - "The operation was cancelled.", - "The operation has failed." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." } }, "type": "object" @@ -502,13 +481,350 @@ "description": "The long running operation metadata for enable processor method.", "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": { + "description": "Response message for the enable processor method. Intentionally empty proto for adding fields in future.", + "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": { + "description": "Metadata of the EvaluateProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse": { + "description": "Metadata of the EvaluateProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionResponse", + "properties": { + "evaluation": { + "$ref": "GoogleCloudDocumentaiUiv1beta3Evaluation", + "description": "The evaluation result." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3Evaluation": { + "description": "An evaluation of a ProcessorVersion's performance.", + "id": "GoogleCloudDocumentaiUiv1beta3Evaluation", + "properties": { + "allEntitiesMetrics": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics", + "description": "Metrics for all the entities in aggregate." + }, + "createTime": { + "description": "The time that the evaluation was created.", + "format": "google-datetime", + "type": "string" + }, + "entityMetrics": { + "additionalProperties": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics" + }, + "description": "Metrics across confidence levels, for different entities.", + "type": "object" + }, + "name": { + "description": "The resource name of the evaluation. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics": { + "description": "Evaluations metrics, at a specific confidence level.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics", + "properties": { + "confidenceLevel": { + "description": "The confidence level.", + "format": "float", + "type": "number" + }, + "metrics": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "description": "The metrics at the specific confidence level." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": { + "description": "Evaluation metrics, either in aggregate or about a specific entity.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "properties": { + "f1Score": { + "description": "The calculated f1 score.", + "format": "float", + "type": "number" + }, + "precision": { + "description": "The calculated precision.", + "format": "float", + "type": "number" + }, + "recall": { + "description": "The calculated recall.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics": { + "description": "Metrics across multiple confidence levels.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationMultiConfidenceMetrics", + "properties": { + "confidenceLevelMetrics": { + "description": "Metrics across confidence levels.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationConfidenceLevelMetrics" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluationReference": { + "description": "Gives a short summary of an evaluation, and links to the evaluation itself.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", + "properties": { + "aggregateMetrics": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation." + }, + "evaluation": { + "description": "The resource name of the evaluation.", + "type": "string" + }, + "operation": { + "description": "The resource name of the Long Running Operation for the evaluation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ProcessorVersion": { + "description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion", + "properties": { + "createTime": { + "description": "The time the processor version was created.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "The display name of the processor version.", + "type": "string" + }, + "latestEvaluation": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", + "description": "The most recently invoked evaluation for the processor version." + }, + "name": { + "description": "The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}", + "type": "string" + }, + "schema": { + "$ref": "GoogleCloudDocumentaiUiv1beta3Schema", + "description": "The schema of the processor version. Describes the output." + }, + "state": { + "description": "The state of the processor version.", + "enum": [ + "STATE_UNSPECIFIED", + "DEPLOYED", + "DEPLOYING", + "UNDEPLOYED", + "UNDEPLOYING", + "CREATING", + "DELETING", + "FAILED" + ], + "enumDescriptions": [ + "The processor version is in an unspecified state.", + "The processor version is deployed and can be used for processing.", + "The processor version is being deployed.", + "The processor version is not deployed and cannot be used for processing.", + "The processor version is being undeployed.", + "The processor version is being created.", + "The processor version is being deleted.", + "The processor version failed and is in an indeterminate state." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3Schema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiUiv1beta3Schema", + "properties": { + "description": { + "description": "Description of the schema.", + "type": "string" + }, + "displayName": { + "description": "Display name to show to users.", + "type": "string" + }, + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType", + "properties": { + "baseType": { + "description": "Type of the entity. It can be either a value type (such as \"text\", \"numeric\", \"date\" and \"address\"), or an object type which may contain nested entities (such as \"document\" and \"table\").", + "type": "string" + }, + "description": { + "description": "Description of the entity type.", + "type": "string" + }, + "occurrenceType": { + "description": "Occurrence type limits the number of times an entity type appears in the document.", + "enum": [ + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" + ], + "enumDescriptions": [ + "Unspecified occurrence type.", + "The entity type will appear zero times or once.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once.", + "The entity type will appear once or more times." + ], + "type": "string" + }, + "properties": { + "description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType 'ID', which consists of EntityType 'name' and 'address', with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" + }, + "type": "array" + }, + "source": { + "description": "Source of this entity type.", + "enum": [ + "SOURCE_UNSPECIFIED", + "PREDEFINED", + "USER_INPUT" + ], + "enumDescriptions": [ + "Unspecified source.", + "The entity type is in the predefined schema of a pretrained version of a processor.", + "The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor." + ], + "type": "string" + }, + "type": { + "description": "Name of the type. It must be unique within the set of same level types.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": { + "description": "The metadata that represents a processor version being created.", + "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { + "description": "The response for the TrainProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", + "properties": { + "processorVersion": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion", + "description": "The processor version produced by training." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { + "description": "The long running operation metadata for the undeploy processor version method.", + "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": { + "description": "Response message for the undeploy processor version method.", + "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { + "description": "The long running operation metadata for updating the human review configuration.", + "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { + "description": "The long running operation metadata for UpdateLabelerPool.", + "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1BatchProcessMetadata": { + "description": "The long running operation metadata for batch process method.", + "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", + "properties": { "createTime": { "description": "The creation time of the operation.", "format": "google-datetime", "type": "string" }, + "individualProcessStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus" + }, + "type": "array" + }, "state": { - "description": "The state of the current enable processor operation.", + "description": "The state of the current batch processing.", "enum": [ "STATE_UNSPECIFIED", "WAITING", @@ -522,10 +838,10 @@ "The default value. This value is used if the state is omitted.", "Request operation is waiting for scheduling.", "Request is being processed.", - "The operation is completed successfully.", - "The operation was being cancelled.", - "The operation was cancelled.", - "The operation has failed." + "The batch processing completed successfully.", + "The batch processing was being cancelled.", + "The batch processing was cancelled.", + "The batch processing has failed." ], "type": "string" }, @@ -541,15 +857,38 @@ }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": { - "description": "Response message for the enable processor method. Intentionally empty proto for adding fields in future.", - "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse", + "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": { + "description": "The status of a each individual document in the batch process.", + "id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus", + "properties": { + "humanReviewStatus": { + "$ref": "GoogleCloudDocumentaiV1HumanReviewStatus", + "description": "The status of human review on the processed document." + }, + "inputGcsSource": { + "description": "The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.", + "type": "string" + }, + "outputGcsDestination": { + "description": "The output_gcs_destination (in the request as 'output_gcs_destination') of the processed document if it was successful, otherwise empty.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the processing of the document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1BatchProcessResponse": { + "description": "Response message for batch process document method.", + "id": "GoogleCloudDocumentaiV1BatchProcessResponse", "properties": {}, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { - "description": "The long running operation metadata for UpdateLabelerPool.", - "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", + "GoogleCloudDocumentaiV1CommonOperationMetadata": { + "description": "The common metadata for long running operations.", + "id": "GoogleCloudDocumentaiV1CommonOperationMetadata", "properties": { "createTime": { "description": "The creation time of the operation.", @@ -557,7 +896,7 @@ "type": "string" }, "state": { - "description": "Used only when Operation.done is false.", + "description": "The state of the operation.", "enum": [ "STATE_UNSPECIFIED", "RUNNING", @@ -577,7 +916,7 @@ "type": "string" }, "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", + "description": "A message providing more details about the current state of processing.", "type": "string" }, "updateTime": { @@ -588,6 +927,61 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1HumanReviewStatus": { + "description": "The status of human review on a processed document.", + "id": "GoogleCloudDocumentaiV1HumanReviewStatus", + "properties": { + "humanReviewOperation": { + "description": "The name of the operation triggered by the processed document. Non-empty only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "type": "string" + }, + "state": { + "description": "The state of human review on the processing request.", + "enum": [ + "STATE_UNSPECIFIED", + "HUMAN_REVIEW_SKIPPED", + "HUMAN_REVIEW_VALIDATION_PASSED", + "HUMAN_REVIEW_IN_PROGRESS", + "HUMAN_REVIEW_ERROR" + ], + "enumDescriptions": [ + "State unspecified.", + "Human review is skipped for the document, it's either due to the human review is not enabled on the processor or the processing request sets to skip it.", + "Human review validation is triggered and passed, so no review is needed.", + "Human review validation is triggered and the document is under review.", + "Some error happened during triggering human review, see the [state_message] for details." + ], + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the human review state.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": { + "description": "The long running operation metadata for review document method.", + "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ReviewDocumentResponse": { + "description": "Response message for review document method.", + "id": "GoogleCloudDocumentaiV1ReviewDocumentResponse", + "properties": { + "gcsDestination": { + "description": "The Cloud Storage uri for the human reviewed document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": { "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", "id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse", @@ -765,19 +1159,19 @@ "properties": { "addressValue": { "$ref": "GoogleTypePostalAddress", - "description": "Postal address. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/postal_address.proto" + "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" }, "dateValue": { "$ref": "GoogleTypeDate", - "description": "Date value. Includes year, month, day. See also: https: //github.com/googleapis/googleapis/blob/master/google/type/date.proto" + "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" }, "datetimeValue": { "$ref": "GoogleTypeDateTime", - "description": "DateTime value. Includes date, time, and timezone. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/datetime.proto" + "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" }, "moneyValue": { "$ref": "GoogleTypeMoney", - "description": "Money value. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/money.proto" + "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { "description": "Required. Normalized entity value stored as a string. This field is populated for supported document type (e.g. Invoice). For some entity types, one of respective 'structured_value' fields may also be populated. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", @@ -943,7 +1337,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element", + "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element.", "format": "int64", "type": "string" } @@ -1733,31 +2127,6 @@ }, "type": "object" }, - "GoogleCloudDocumentaiV1beta2AutoMlParams": { - "description": "Parameters to control AutoML model prediction behavior.", - "id": "GoogleCloudDocumentaiV1beta2AutoMlParams", - "properties": { - "model": { - "description": "Resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest": { - "description": "Request to batch process documents as an asynchronous operation. The output is written to Cloud Storage as JSON in the [Document] format.", - "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsRequest", - "properties": { - "requests": { - "description": "Required. Individual requests for each document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": { "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse", @@ -1942,19 +2311,19 @@ "properties": { "addressValue": { "$ref": "GoogleTypePostalAddress", - "description": "Postal address. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/postal_address.proto" + "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" }, "dateValue": { "$ref": "GoogleTypeDate", - "description": "Date value. Includes year, month, day. See also: https: //github.com/googleapis/googleapis/blob/master/google/type/date.proto" + "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" }, "datetimeValue": { "$ref": "GoogleTypeDateTime", - "description": "DateTime value. Includes date, time, and timezone. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/datetime.proto" + "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" }, "moneyValue": { "$ref": "GoogleTypeMoney", - "description": "Money value. See also: https: //github.com/googleapis/googleapis/blob/ // master/google/type/money.proto" + "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" }, "text": { "description": "Required. Normalized entity value stored as a string. This field is populated for supported document type (e.g. Invoice). For some entity types, one of respective 'structured_value' fields may also be populated. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", @@ -2140,7 +2509,7 @@ "type": "string" }, "page": { - "description": "Required. Index into the Document.pages element", + "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element.", "format": "int64", "type": "string" } @@ -2787,43 +3156,6 @@ }, "type": "object" }, - "GoogleCloudDocumentaiV1beta2EntityExtractionParams": { - "description": "Parameters to control entity extraction behavior.", - "id": "GoogleCloudDocumentaiV1beta2EntityExtractionParams", - "properties": { - "enabled": { - "description": "Whether to enable entity extraction.", - "type": "boolean" - }, - "modelVersion": { - "description": "Model version of the entity extraction. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2FormExtractionParams": { - "description": "Parameters to control form extraction behavior.", - "id": "GoogleCloudDocumentaiV1beta2FormExtractionParams", - "properties": { - "enabled": { - "description": "Whether to enable form extraction.", - "type": "boolean" - }, - "keyValuePairHints": { - "description": "Reserved for future use.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2KeyValuePairHint" - }, - "type": "array" - }, - "modelVersion": { - "description": "Model version of the form extraction system. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model. For custom form models, specify: “custom/{model_name}\". Model name format is \"bucket_name/path/to/modeldir\" corresponding to \"gs://bucket_name/path/to/modeldir\" where annotated examples are stored.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta2GcsDestination": { "description": "The Google Cloud Storage location where the output file will be written to.", "id": "GoogleCloudDocumentaiV1beta2GcsDestination", @@ -2864,24 +3196,6 @@ }, "type": "object" }, - "GoogleCloudDocumentaiV1beta2KeyValuePairHint": { - "description": "Reserved for future use.", - "id": "GoogleCloudDocumentaiV1beta2KeyValuePairHint", - "properties": { - "key": { - "description": "The key text for the hint.", - "type": "string" - }, - "valueTypes": { - "description": "Type of the value. This is case-insensitive, and could be one of: ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER, ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will be ignored.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta2NormalizedVertex": { "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudDocumentaiV1beta2NormalizedVertex", @@ -2899,20 +3213,6 @@ }, "type": "object" }, - "GoogleCloudDocumentaiV1beta2OcrParams": { - "description": "Parameters to control Optical Character Recognition (OCR) behavior.", - "id": "GoogleCloudDocumentaiV1beta2OcrParams", - "properties": { - "languageHints": { - "description": "List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Document processing returns an error if one or more of the specified languages is not one of the supported languages.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta2OperationMetadata": { "description": "Contains metadata for the BatchProcessDocuments operation.", "id": "GoogleCloudDocumentaiV1beta2OperationMetadata", @@ -2972,49 +3272,6 @@ }, "type": "object" }, - "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest": { - "description": "Request to process one document.", - "id": "GoogleCloudDocumentaiV1beta2ProcessDocumentRequest", - "properties": { - "automlParams": { - "$ref": "GoogleCloudDocumentaiV1beta2AutoMlParams", - "description": "Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params." - }, - "documentType": { - "description": "Specifies a known document type for deeper structure detection. Valid values are currently \"general\" and \"invoice\". If not provided, \"general\"\\ is used as default. If any other value is given, the request is rejected.", - "type": "string" - }, - "entityExtractionParams": { - "$ref": "GoogleCloudDocumentaiV1beta2EntityExtractionParams", - "description": "Controls entity extraction behavior. If not specified, the system will decide reasonable defaults." - }, - "formExtractionParams": { - "$ref": "GoogleCloudDocumentaiV1beta2FormExtractionParams", - "description": "Controls form extraction behavior. If not specified, the system will decide reasonable defaults." - }, - "inputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta2InputConfig", - "description": "Required. Information about the input file." - }, - "ocrParams": { - "$ref": "GoogleCloudDocumentaiV1beta2OcrParams", - "description": "Controls OCR behavior. If not specified, the system will decide reasonable defaults." - }, - "outputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta2OutputConfig", - "description": "The desired output location. This field is only needed in BatchProcessDocumentsRequest." - }, - "parent": { - "description": "Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. This field is only populated when used in ProcessDocument method.", - "type": "string" - }, - "tableExtractionParams": { - "$ref": "GoogleCloudDocumentaiV1beta2TableExtractionParams", - "description": "Controls table extraction behavior. If not specified, the system will decide reasonable defaults." - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse": { "description": "Response to a single document processing request.", "id": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse", @@ -3030,51 +3287,6 @@ }, "type": "object" }, - "GoogleCloudDocumentaiV1beta2TableBoundHint": { - "description": "A hint for a table bounding box on the page for table parsing.", - "id": "GoogleCloudDocumentaiV1beta2TableBoundHint", - "properties": { - "boundingBox": { - "$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly", - "description": "Bounding box hint for a table on this page. The coordinates must be normalized to [0,1] and the bounding box must be an axis-aligned rectangle." - }, - "pageNumber": { - "description": "Optional. Page number for multi-paged inputs this hint applies to. If not provided, this hint will apply to all pages by default. This value is 1-based.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2TableExtractionParams": { - "description": "Parameters to control table extraction behavior.", - "id": "GoogleCloudDocumentaiV1beta2TableExtractionParams", - "properties": { - "enabled": { - "description": "Whether to enable table extraction.", - "type": "boolean" - }, - "headerHints": { - "description": "Optional. Reserved for future use.", - "items": { - "type": "string" - }, - "type": "array" - }, - "modelVersion": { - "description": "Model version of the table extraction system. Default is \"builtin/stable\". Specify \"builtin/latest\" for the latest model.", - "type": "string" - }, - "tableBoundHints": { - "description": "Optional. Table bounding box hints that can be provided to complex cases which our algorithm cannot locate the table(s) in.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2TableBoundHint" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta2Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudDocumentaiV1beta2Vertex", @@ -3147,9 +3359,13 @@ "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", "properties": { "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.", + "description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method. .", "type": "string" }, + "humanReviewStatus": { + "$ref": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", + "description": "The status of human review on the processed document." + }, "inputGcsSource": { "description": "The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.", "type": "string" @@ -3165,16 +3381,1235 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3BatchProcessRequest": { + "description": "Request message for batch process document method.", + "id": "GoogleCloudDocumentaiV1beta3BatchProcessRequest", + "properties": { + "documentOutputConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentOutputConfig", + "description": "The overall output config for batch process." + }, + "inputConfigs": { + "description": "The input config for each single document in the batch process.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig" + }, + "type": "array" + }, + "inputDocuments": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig", + "description": "The input documents for batch process." + }, + "outputConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig", + "description": "The overall output config for batch process." + }, + "skipHumanReview": { + "description": "Whether Human Review feature should be skipped for this request. Default to false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig": { + "description": "The message for input config in batch process.", + "id": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig", + "properties": { + "gcsSource": { + "description": "The Cloud Storage location as the source of the document.", + "type": "string" + }, + "mimeType": { + "description": "Mimetype of the input. If the input is a raw document, the supported mimetypes are application/pdf, image/tiff, and image/gif. If the input is a [Document] proto, the type should be application/json.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig": { + "description": "The message for output config in batch process.", + "id": "GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig", + "properties": { + "gcsDestination": { + "description": "The output Cloud Storage directory to put the processed documents.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3BatchProcessResponse": { "description": "Response message for batch process document method.", "id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse", "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiV1beta3BoundingPoly": { + "description": "A bounding polygon for the detected image annotation.", + "id": "GoogleCloudDocumentaiV1beta3BoundingPoly", + "properties": { + "normalizedVertices": { + "description": "The bounding polygon normalized vertices.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3NormalizedVertex" + }, + "type": "array" + }, + "vertices": { + "description": "The bounding polygon vertices.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3Vertex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3CommonOperationMetadata": { + "description": "The common metadata for long running operations.", + "id": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "properties": { + "createTime": { + "description": "The creation time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The state of the operation.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "CANCELLING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified state.", + "Operation is still running.", + "Operation is being cancelled.", + "Operation succeeded.", + "Operation failed.", + "Operation is cancelled." + ], + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the current state of processing.", + "type": "string" + }, + "updateTime": { + "description": "The last update time of the operation.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3Document": { + "description": "Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.", + "id": "GoogleCloudDocumentaiV1beta3Document", + "properties": { + "content": { + "description": "Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", + "format": "byte", + "type": "string" + }, + "entities": { + "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentEntity" + }, + "type": "array" + }, + "entityRelations": { + "description": "Relationship among Document.entities.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentEntityRelation" + }, + "type": "array" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Any error that occurred while processing this document." + }, + "mimeType": { + "description": "An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.", + "type": "string" + }, + "pages": { + "description": "Visual page layout for the Document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPage" + }, + "type": "array" + }, + "revisions": { + "description": "Revision history of this document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentRevision" + }, + "type": "array" + }, + "shardInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentShardInfo", + "description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified." + }, + "text": { + "description": "UTF-8 encoded text in reading order from the document.", + "type": "string" + }, + "textChanges": { + "description": "A list of text corrections made to [Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTextChange" + }, + "type": "array" + }, + "textStyles": { + "description": "Styles for the Document.text.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentStyle" + }, + "type": "array" + }, + "translations": { + "description": "A list of translations on Document.text. For document shards, translations in this list may cross shard boundaries.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTranslation" + }, + "type": "array" + }, + "uri": { + "description": "Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentEntity": { + "description": "A phrase in the text that is a known entity type, such as a person, an organization, or location.", + "id": "GoogleCloudDocumentaiV1beta3DocumentEntity", + "properties": { + "confidence": { + "description": "Optional. Confidence of detected Schema entity. Range [0, 1].", + "format": "float", + "type": "number" + }, + "id": { + "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.", + "type": "string" + }, + "mentionId": { + "description": "Deprecated. Use `id` field instead.", + "type": "string" + }, + "mentionText": { + "description": "Text value in the document e.g. `1600 Amphitheatre Pkwy`.", + "type": "string" + }, + "normalizedValue": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue", + "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." + }, + "pageAnchor": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageAnchor", + "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found." + }, + "properties": { + "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentEntity" + }, + "type": "array" + }, + "provenance": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "description": "Optional. The history of this annotation." + }, + "redacted": { + "description": "Optional. Whether the entity will be redacted for de-identification purposes.", + "type": "boolean" + }, + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTextAnchor", + "description": "Provenance of the entity. Text anchor indexing into the Document.text." + }, + "type": { + "description": "Entity type from a schema e.g. `Address`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue": { + "description": "Parsed and normalized entity value.", + "id": "GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue", + "properties": { + "addressValue": { + "$ref": "GoogleTypePostalAddress", + "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" + }, + "dateValue": { + "$ref": "GoogleTypeDate", + "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" + }, + "datetimeValue": { + "$ref": "GoogleTypeDateTime", + "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" + }, + "moneyValue": { + "$ref": "GoogleTypeMoney", + "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" + }, + "text": { + "description": "Required. Normalized entity value stored as a string. This field is populated for supported document type (e.g. Invoice). For some entity types, one of respective 'structured_value' fields may also be populated. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentEntityRelation": { + "description": "Relationship between Entities.", + "id": "GoogleCloudDocumentaiV1beta3DocumentEntityRelation", + "properties": { + "objectId": { + "description": "Object entity id.", + "type": "string" + }, + "relation": { + "description": "Relationship description.", + "type": "string" + }, + "subjectId": { + "description": "Subject entity id.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentOutputConfig": { + "description": "Config that controls the output of documents. All documents will be written as a JSON file.", + "id": "GoogleCloudDocumentaiV1beta3DocumentOutputConfig", + "properties": { + "gcsOutputConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig", + "description": "Output config to write the results to Cloud Storage." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig": { + "description": "The configuration used when outputting documents.", + "id": "GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig", + "properties": { + "gcsUri": { + "description": "The Cloud Storage uri (a directory) of the output.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPage": { + "description": "A page in a Document.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPage", + "properties": { + "blocks": { + "description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageBlock" + }, + "type": "array" + }, + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "dimension": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDimension", + "description": "Physical dimension of the page." + }, + "formFields": { + "description": "A list of visually detected form fields on the page.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageFormField" + }, + "type": "array" + }, + "image": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageImage", + "description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned." + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for the page." + }, + "lines": { + "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLine" + }, + "type": "array" + }, + "pageNumber": { + "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.", + "format": "int32", + "type": "integer" + }, + "paragraphs": { + "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageParagraph" + }, + "type": "array" + }, + "tables": { + "description": "A list of visually detected tables on the page.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageTable" + }, + "type": "array" + }, + "tokens": { + "description": "A list of visually detected tokens on the page.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageToken" + }, + "type": "array" + }, + "transforms": { + "description": "Transformation matrices that were applied to the original document image to produce Page.image.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageMatrix" + }, + "type": "array" + }, + "visualElements": { + "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageVisualElement" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageAnchor": { + "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageAnchor", + "properties": { + "pageRefs": { + "description": "One or more references to visual page elements", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef": { + "description": "Represents a weak reference to a page element within a document.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef", + "properties": { + "boundingPoly": { + "$ref": "GoogleCloudDocumentaiV1beta3BoundingPoly", + "description": "Optional. Identifies the bounding polygon of a layout element on the page." + }, + "layoutId": { + "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", + "type": "string" + }, + "layoutType": { + "description": "Optional. The type of the layout element that is being referenced if any.", + "enum": [ + "LAYOUT_TYPE_UNSPECIFIED", + "BLOCK", + "PARAGRAPH", + "LINE", + "TOKEN", + "VISUAL_ELEMENT", + "TABLE", + "FORM_FIELD" + ], + "enumDescriptions": [ + "Layout Unspecified.", + "References a Page.blocks element.", + "References a Page.paragraphs element.", + "References a Page.lines element.", + "References a Page.tokens element.", + "References a Page.visual_elements element.", + "Refrrences a Page.tables element.", + "References a Page.form_fields element." + ], + "type": "string" + }, + "page": { + "description": "Required. Index into the Document.pages element, for example using Document.pages to locate the related page element.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageBlock": { + "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageBlock", + "properties": { + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for Block." + }, + "provenance": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "description": "The history of this annotation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage": { + "description": "Detected language for a structural component.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage", + "properties": { + "confidence": { + "description": "Confidence of detected language. Range [0, 1].", + "format": "float", + "type": "number" + }, + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageDimension": { + "description": "Dimension for the page.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageDimension", + "properties": { + "height": { + "description": "Page height.", + "format": "float", + "type": "number" + }, + "unit": { + "description": "Dimension unit.", + "type": "string" + }, + "width": { + "description": "Page width.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageFormField": { + "description": "A form field detected on the page.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageFormField", + "properties": { + "fieldName": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc." + }, + "fieldValue": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for the FormField value." + }, + "nameDetectedLanguages": { + "description": "A list of detected languages for name together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "valueDetectedLanguages": { + "description": "A list of detected languages for value together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "valueType": { + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the field_value is normal text) - \"unfilled_checkbox\" - \"filled_checkbox\"", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageImage": { + "description": "Rendered image contents for this page.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageImage", + "properties": { + "content": { + "description": "Raw byte content of the image.", + "format": "byte", + "type": "string" + }, + "height": { + "description": "Height of the image in pixels.", + "format": "int32", + "type": "integer" + }, + "mimeType": { + "description": "Encoding mime type for the image.", + "type": "string" + }, + "width": { + "description": "Width of the image in pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageLayout": { + "description": "Visual element describing a layout unit on a page.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "properties": { + "boundingPoly": { + "$ref": "GoogleCloudDocumentaiV1beta3BoundingPoly", + "description": "The bounding polygon for the Layout." + }, + "confidence": { + "description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range [0, 1].", + "format": "float", + "type": "number" + }, + "orientation": { + "description": "Detected orientation for the Layout.", + "enum": [ + "ORIENTATION_UNSPECIFIED", + "PAGE_UP", + "PAGE_RIGHT", + "PAGE_DOWN", + "PAGE_LEFT" + ], + "enumDescriptions": [ + "Unspecified orientation.", + "Orientation is aligned with page up.", + "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.", + "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.", + "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read." + ], + "type": "string" + }, + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTextAnchor", + "description": "Text anchor indexing into the Document.text." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageLine": { + "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageLine", + "properties": { + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for Line." + }, + "provenance": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "description": "The history of this annotation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageMatrix": { + "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageMatrix", + "properties": { + "cols": { + "description": "Number of columns in the matrix.", + "format": "int32", + "type": "integer" + }, + "data": { + "description": "The matrix data.", + "format": "byte", + "type": "string" + }, + "rows": { + "description": "Number of rows in the matrix.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageParagraph": { + "description": "A collection of lines that a human would perceive as a paragraph.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageParagraph", + "properties": { + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for Paragraph." + }, + "provenance": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "description": "The history of this annotation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageTable": { + "description": "A table representation similar to HTML table structure.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageTable", + "properties": { + "bodyRows": { + "description": "Body rows of the table.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow" + }, + "type": "array" + }, + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "headerRows": { + "description": "Header rows of the table.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow" + }, + "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for Table." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell": { + "description": "A cell representation inside the table.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell", + "properties": { + "colSpan": { + "description": "How many columns this cell spans.", + "format": "int32", + "type": "integer" + }, + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for TableCell." + }, + "rowSpan": { + "description": "How many rows this cell spans.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow": { + "description": "A row of table cells.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow", + "properties": { + "cells": { + "description": "Cells that make up this row.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageToken": { + "description": "A detected token.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageToken", + "properties": { + "detectedBreak": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak", + "description": "Detected break at the end of a Token." + }, + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for Token." + }, + "provenance": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "description": "The history of this annotation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak": { + "description": "Detected break at the end of a Token.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak", + "properties": { + "type": { + "description": "Detected break type.", + "enum": [ + "TYPE_UNSPECIFIED", + "SPACE", + "WIDE_SPACE", + "HYPHEN" + ], + "enumDescriptions": [ + "Unspecified break type.", + "A single whitespace.", + "A wider whitespace.", + "A hyphen that indicates that a token has been split across lines." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentPageVisualElement": { + "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", + "id": "GoogleCloudDocumentaiV1beta3DocumentPageVisualElement", + "properties": { + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage" + }, + "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentPageLayout", + "description": "Layout for VisualElement." + }, + "type": { + "description": "Type of the VisualElement.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentProvenance": { + "description": "Structure to identify provenance relationships between annotations in different revisions.", + "id": "GoogleCloudDocumentaiV1beta3DocumentProvenance", + "properties": { + "id": { + "description": "The Id of this operation. Needs to be unique within the scope of the revision.", + "format": "int32", + "type": "integer" + }, + "parents": { + "description": "References to the original elements that are replaced.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenanceParent" + }, + "type": "array" + }, + "revision": { + "description": "The index of the revision that produced this element.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of provenance operation.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "ADD", + "REMOVE", + "REPLACE", + "EVAL_REQUESTED", + "EVAL_APPROVED" + ], + "enumDescriptions": [ + "Operation type unspecified.", + "Add an element. Implicit if no `parents` are set for the provenance.", + "The element is removed. No `parents` should be set.", + "Explicitly replaces the element(s) identified by `parents`.", + "Element is requested for human review.", + "Element is review and approved at human review, confidence will be set to 1.0" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentProvenanceParent": { + "description": "Structure for referencing parent provenances. When an element replaces one of more other elements parent references identify the elements that are replaced.", + "id": "GoogleCloudDocumentaiV1beta3DocumentProvenanceParent", + "properties": { + "id": { + "description": "The id of the parent provenance.", + "format": "int32", + "type": "integer" + }, + "revision": { + "description": "The index of the [Document.revisions] identifying the parent revision.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentRevision": { + "description": "Contains past or forward revisions of this document.", + "id": "GoogleCloudDocumentaiV1beta3DocumentRevision", + "properties": { + "agent": { + "description": "If the change was made by a person specify the name or id of that person.", + "type": "string" + }, + "createTime": { + "description": "The time that the revision was created.", + "format": "google-datetime", + "type": "string" + }, + "humanReview": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview", + "description": "Human Review information of this revision." + }, + "id": { + "description": "Id of the revision. Unique within the context of the document.", + "type": "string" + }, + "parent": { + "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "processor": { + "description": "If the annotation was made by processor identify the processor by its resource name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview": { + "description": "Human Review information of the document.", + "id": "GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview", + "properties": { + "state": { + "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.", + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentShardInfo": { + "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.", + "id": "GoogleCloudDocumentaiV1beta3DocumentShardInfo", + "properties": { + "shardCount": { + "description": "Total number of shards.", + "format": "int64", + "type": "string" + }, + "shardIndex": { + "description": "The 0-based index of this shard.", + "format": "int64", + "type": "string" + }, + "textOffset": { + "description": "The index of the first character in Document.text in the overall document global text.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentStyle": { + "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.", + "id": "GoogleCloudDocumentaiV1beta3DocumentStyle", + "properties": { + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Text background color." + }, + "color": { + "$ref": "GoogleTypeColor", + "description": "Text color." + }, + "fontSize": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentStyleFontSize", + "description": "Font size." + }, + "fontWeight": { + "description": "Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp", + "type": "string" + }, + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTextAnchor", + "description": "Text anchor indexing into the Document.text." + }, + "textDecoration": { + "description": "Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp", + "type": "string" + }, + "textStyle": { + "description": "Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentStyleFontSize": { + "description": "Font size with unit.", + "id": "GoogleCloudDocumentaiV1beta3DocumentStyleFontSize", + "properties": { + "size": { + "description": "Font size for the text.", + "format": "float", + "type": "number" + }, + "unit": { + "description": "Unit for the font size. Follows CSS naming (in, px, pt, etc.).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentTextAnchor": { + "description": "Text reference indexing into the Document.text.", + "id": "GoogleCloudDocumentaiV1beta3DocumentTextAnchor", + "properties": { + "content": { + "description": "Contains the content of the text span so that users do not have to look it up in the text_segments.", + "type": "string" + }, + "textSegments": { + "description": "The text segments from the Document.text.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment": { + "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset", + "id": "GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment", + "properties": { + "endIndex": { + "description": "TextSegment half open end UTF-8 char index in the Document.text.", + "format": "int64", + "type": "string" + }, + "startIndex": { + "description": "TextSegment start UTF-8 char index in the Document.text.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentTextChange": { + "description": "This message is used for text changes aka. OCR corrections.", + "id": "GoogleCloudDocumentaiV1beta3DocumentTextChange", + "properties": { + "changedText": { + "description": "The text that replaces the text identified in the `text_anchor`.", + "type": "string" + }, + "provenance": { + "description": "The history of this annotation.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance" + }, + "type": "array" + }, + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTextAnchor", + "description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentTranslation": { + "description": "A translation of the text segment.", + "id": "GoogleCloudDocumentaiV1beta3DocumentTranslation", + "properties": { + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "type": "string" + }, + "provenance": { + "description": "The history of this annotation.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentProvenance" + }, + "type": "array" + }, + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentTextAnchor", + "description": "Provenance of the translation. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." + }, + "translatedText": { + "description": "Text translated into the target language.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3HumanReviewStatus": { + "description": "The status of human review on a processed document.", + "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", + "properties": { + "humanReviewOperation": { + "description": "The name of the operation triggered by the processed document. Non-empty only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has the same response type and metadata as the long running operation returned by [ReviewDocument] method.", + "type": "string" + }, + "state": { + "description": "The state of human review on the processing request.", + "enum": [ + "STATE_UNSPECIFIED", + "HUMAN_REVIEW_SKIPPED", + "HUMAN_REVIEW_VALIDATION_PASSED", + "HUMAN_REVIEW_IN_PROGRESS", + "HUMAN_REVIEW_ERROR" + ], + "enumDescriptions": [ + "State unspecified.", + "Human review is skipped for the document, it's either due to the human review is not enabled on the processor or the processing request sets to skip it.", + "Human review validation is triggered and passed, so no review is needed.", + "Human review validation is triggered and the document is under review.", + "Some error happened during triggering human review, see the [state_message] for details." + ], + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the human review state.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3NormalizedVertex": { + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", + "id": "GoogleCloudDocumentaiV1beta3NormalizedVertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "float", + "type": "number" + }, + "y": { + "description": "Y coordinate.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessRequest": { + "description": "Request message for the process document method.", + "id": "GoogleCloudDocumentaiV1beta3ProcessRequest", + "properties": { + "document": { + "$ref": "GoogleCloudDocumentaiV1beta3Document", + "description": "The document payload, the [content] and [mime_type] fields must be set." + }, + "inlineDocument": { + "$ref": "GoogleCloudDocumentaiV1beta3Document", + "description": "An inline document proto." + }, + "rawDocument": { + "$ref": "GoogleCloudDocumentaiV1beta3RawDocument", + "description": "A raw document content (bytes)." + }, + "skipHumanReview": { + "description": "Whether Human Review feature should be skipped for this request. Default to false.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessResponse": { + "description": "Response message for the process document method.", + "id": "GoogleCloudDocumentaiV1beta3ProcessResponse", + "properties": { + "document": { + "$ref": "GoogleCloudDocumentaiV1beta3Document", + "description": "The document payload, will populate fields based on the processor's behavior." + }, + "humanReviewOperation": { + "description": "The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method. .", + "type": "string" + }, + "humanReviewStatus": { + "$ref": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", + "description": "The status of human review on the processed document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3RawDocument": { + "description": "Payload message of raw document content (bytes).", + "id": "GoogleCloudDocumentaiV1beta3RawDocument", + "properties": { + "content": { + "description": "Inline document content.", + "format": "byte", + "type": "string" + }, + "mimeType": { + "description": "An IANA MIME type (RFC6838) indicating the nature and format of the [content].", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": { "description": "The long running operation metadata for review document method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata", "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long running operation." + }, "createTime": { "description": "The creation time of the operation.", "format": "google-datetime", @@ -3212,6 +4647,21 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ReviewDocumentRequest": { + "description": "Request message for review document method.", + "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentRequest", + "properties": { + "document": { + "$ref": "GoogleCloudDocumentaiV1beta3Document", + "description": "The document that needs human review." + }, + "inlineDocument": { + "$ref": "GoogleCloudDocumentaiV1beta3Document", + "description": "An inline document proto." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ReviewDocumentResponse": { "description": "Response message for review document method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentResponse", @@ -3223,6 +4673,75 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3Vertex": { + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", + "id": "GoogleCloudDocumentaiV1beta3Vertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "int32", + "type": "integer" + }, + "y": { + "description": "Y coordinate.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudLocationListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "GoogleCloudLocationListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudLocationLocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudLocationLocation": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "GoogleCloudLocationLocation", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation", @@ -3319,21 +4838,21 @@ "type": "object" }, "GoogleTypeDate": { - "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", "id": "GoogleTypeDate", "properties": { "day": { - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.", + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32", "type": "integer" }, "month": { - "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.", + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.", + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } @@ -3341,7 +4860,7 @@ "type": "object" }, "GoogleTypeDateTime": { - "description": "Represents civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.", + "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.", "id": "GoogleTypeDateTime", "properties": { "day": { @@ -3396,7 +4915,7 @@ "id": "GoogleTypeMoney", "properties": { "currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", + "description": "The three-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { @@ -3488,6 +5007,6 @@ }, "servicePath": "", "title": "Cloud Document AI API", - "version": "v1beta2", + "version": "v1beta3", "version_module": true } \ No newline at end of file
diff --git a/discovery/googleapis_beta/domains__v1beta1.json b/discovery/googleapis_beta/domains__v1beta1.json new file mode 100644 index 0000000..85adcdc --- /dev/null +++ b/discovery/googleapis_beta/domains__v1beta1.json
@@ -0,0 +1,1753 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://domains.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Domains", + "description": "Enables management and configuration of domain names.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/domains/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "domains:v1beta1", + "kind": "discovery#restDescription", + "name": "domains", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "domains.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "domains.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "domains.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "domains.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "registrations": { + "methods": { + "configureContactSettings": { + "description": "Updates a `Registration`'s contact settings. Some changes require confirmation by the domain's registrant contact .", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.configureContactSettings", + "parameterOrder": [ + "registration" + ], + "parameters": { + "registration": { + "description": "Required. The name of the `Registration` whose contact settings are being updated, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+registration}:configureContactSettings", + "request": { + "$ref": "ConfigureContactSettingsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "configureDnsSettings": { + "description": "Updates a `Registration`'s DNS settings.", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.configureDnsSettings", + "parameterOrder": [ + "registration" + ], + "parameters": { + "registration": { + "description": "Required. The name of the `Registration` whose DNS settings are being updated, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+registration}:configureDnsSettings", + "request": { + "$ref": "ConfigureDnsSettingsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "configureManagementSettings": { + "description": "Updates a `Registration`'s management settings.", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.configureManagementSettings", + "parameterOrder": [ + "registration" + ], + "parameters": { + "registration": { + "description": "Required. The name of the `Registration` whose management settings are being updated, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+registration}:configureManagementSettings", + "request": { + "$ref": "ConfigureManagementSettingsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a `Registration` resource. This method only works on resources in one of the following states: * `state` is `EXPORTED` with `expire_time` in the past * `state` is `REGISTRATION_FAILED`", + "httpMethod": "DELETE", + "id": "domains.projects.locations.registrations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `Registration` to delete, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "export": { + "description": "Exports a `Registration` that you no longer want to use with Cloud Domains. You can continue to use the domain in [Google Domains](https://domains.google/) until it expires. If the export is successful: * The resource's `state` becomes `EXPORTED`, meaning that it is no longer managed by Cloud Domains * Because individual users can own domains in Google Domains, the calling user becomes the domain's sole owner. Permissions for the domain are subsequently managed in Google Domains. * Without further action, the domain does not renew automatically. The new owner can set up billing in Google Domains to renew the domain if needed.", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `Registration` to export, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:export", + "request": { + "$ref": "ExportRegistrationRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a `Registration` resource.", + "httpMethod": "GET", + "id": "domains.projects.locations.registrations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `Registration` to get, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Registration" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "domains.projects.locations.registrations.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the `Registration` resources in a project.", + "httpMethod": "GET", + "id": "domains.projects.locations.registrations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter expression to restrict the `Registration`s returned. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, a boolean, or an enum value. The comparison operator should be one of =, !=, >, <, >=, <=, or : for prefix or wildcard matches. For example, to filter to a specific domain name, use an expression like `domainName=\"example.com\"`. You can also check for the existence of a field; for example, to find domains using custom DNS settings, use an expression like `dnsSettings.customDns:*`. You can also create compound filters by combining expressions with the `AND` and `OR` operators. For example, to find domains that are suspended or have specific issues flagged, use an expression like `(state=SUSPENDED) OR (issue:*)`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "When set to the `next_page_token` from a prior response, provides the next page of results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which to list `Registration`s, specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/registrations", + "response": { + "$ref": "ListRegistrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates select fields of a `Registration` resource, notably `labels`. To update other fields, use the appropriate custom update method: * To update management settings, see `ConfigureManagementSettings` * To update DNS configuration, see `ConfigureDnsSettings` * To update contact information, see `ConfigureContactSettings`", + "httpMethod": "PATCH", + "id": "domains.projects.locations.registrations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The field mask describing which fields to update as a comma-separated list. For example, if only the labels are being updated, the `update_mask` would be `\"labels\"`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "Registration" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "register": { + "description": "Registers a new domain name and creates a corresponding `Registration` resource. Call `RetrieveRegisterParameters` first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a `Registration` resource in state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state `REGISTRATION_FAILED`, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.register", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the `Registration`. Must be in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/registrations:register", + "request": { + "$ref": "RegisterDomainRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resetAuthorizationCode": { + "description": "Resets the authorization code of the `Registration` to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.resetAuthorizationCode", + "parameterOrder": [ + "registration" + ], + "parameters": { + "registration": { + "description": "Required. The name of the `Registration` whose authorization code is being reset, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+registration}:resetAuthorizationCode", + "request": { + "$ref": "ResetAuthorizationCodeRequest" + }, + "response": { + "$ref": "AuthorizationCode" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveAuthorizationCode": { + "description": "Gets the authorization code of the `Registration` for the purpose of transferring the domain to another registrar. You can call this method only after 60 days have elapsed since the initial domain registration.", + "httpMethod": "GET", + "id": "domains.projects.locations.registrations.retrieveAuthorizationCode", + "parameterOrder": [ + "registration" + ], + "parameters": { + "registration": { + "description": "Required. The name of the `Registration` whose authorization code is being retrieved, in the format `projects/*/locations/*/registrations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+registration}:retrieveAuthorizationCode", + "response": { + "$ref": "AuthorizationCode" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveRegisterParameters": { + "description": "Gets parameters needed to register a new domain name, including price and up-to-date availability. Use the returned values to call `RegisterDomain`.", + "httpMethod": "GET", + "id": "domains.projects.locations.registrations.retrieveRegisterParameters", + "parameterOrder": [ + "location" + ], + "parameters": { + "domainName": { + "description": "Required. The domain name. Unicode domain names must be expressed in Punycode format.", + "location": "query", + "type": "string" + }, + "location": { + "description": "Required. The location. Must be in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}/registrations:retrieveRegisterParameters", + "response": { + "$ref": "RetrieveRegisterParametersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchDomains": { + "description": "Searches for available domain names similar to the provided query. Availability results from this method are approximate; call `RetrieveRegisterParameters` on a domain before registering to confirm availability.", + "httpMethod": "GET", + "id": "domains.projects.locations.registrations.searchDomains", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The location. Must be in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "Required. String used to search for available domain names.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+location}/registrations:searchDomains", + "response": { + "$ref": "SearchDomainsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "domains.projects.locations.registrations.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/registrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210107", + "rootUrl": "https://domains.googleapis.com/", + "schemas": { + "AuditConfig": { + "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.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "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" + }, + "AuditLogConfig": { + "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.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "AuthorizationCode": { + "description": "Defines an authorization code.", + "id": "AuthorizationCode", + "properties": { + "code": { + "description": "The Authorization Code in ASCII. It can be used to transfer the domain to or from another registrar.", + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "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 members 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)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "ConfigureContactSettingsRequest": { + "description": "Request for the `ConfigureContactSettings` method.", + "id": "ConfigureContactSettingsRequest", + "properties": { + "contactNotices": { + "description": "The list of contact notices that the caller acknowledges. The notices required here depend on the values specified in `contact_settings`.", + "items": { + "enum": [ + "CONTACT_NOTICE_UNSPECIFIED", + "PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT" + ], + "enumDescriptions": [ + "The notice is undefined.", + "Required when setting the `privacy` field of `ContactSettings` to `PUBLIC_CONTACT_DATA`, which exposes contact data publicly." + ], + "type": "string" + }, + "type": "array" + }, + "contactSettings": { + "$ref": "ContactSettings", + "description": "Fields of the `ContactSettings` to update." + }, + "updateMask": { + "description": "Required. The field mask describing which fields to update as a comma-separated list. For example, if only the registrant contact is being updated, the `update_mask` would be `\"registrant_contact\"`.", + "format": "google-fieldmask", + "type": "string" + }, + "validateOnly": { + "description": "Validate the request without actually updating the contact settings.", + "type": "boolean" + } + }, + "type": "object" + }, + "ConfigureDnsSettingsRequest": { + "description": "Request for the `ConfigureDnsSettings` method.", + "id": "ConfigureDnsSettingsRequest", + "properties": { + "dnsSettings": { + "$ref": "DnsSettings", + "description": "Fields of the `DnsSettings` to update." + }, + "updateMask": { + "description": "Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the `update_mask` would be `\"custom_dns.name_servers\"`. When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the `update_mask` would be `\"custom_dns\"`. //", + "format": "google-fieldmask", + "type": "string" + }, + "validateOnly": { + "description": "Validate the request without actually updating the DNS settings.", + "type": "boolean" + } + }, + "type": "object" + }, + "ConfigureManagementSettingsRequest": { + "description": "Request for the `ConfigureManagementSettings` method.", + "id": "ConfigureManagementSettingsRequest", + "properties": { + "managementSettings": { + "$ref": "ManagementSettings", + "description": "Fields of the `ManagementSettings` to update." + }, + "updateMask": { + "description": "Required. The field mask describing which fields to update as a comma-separated list. For example, if only the transfer lock is being updated, the `update_mask` would be `\"transfer_lock_state\"`.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "Contact": { + "description": "Details required for a contact associated with a `Registration`.", + "id": "Contact", + "properties": { + "email": { + "description": "Required. Email address of the contact.", + "type": "string" + }, + "faxNumber": { + "description": "Fax number of the contact in international format. For example, `\"+1-800-555-0123\"`.", + "type": "string" + }, + "phoneNumber": { + "description": "Required. Phone number of the contact in international format. For example, `\"+1-800-555-0123\"`.", + "type": "string" + }, + "postalAddress": { + "$ref": "PostalAddress", + "description": "Required. Postal address of the contact." + } + }, + "type": "object" + }, + "ContactSettings": { + "description": "Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical.", + "id": "ContactSettings", + "properties": { + "adminContact": { + "$ref": "Contact", + "description": "Required. The administrative contact for the `Registration`." + }, + "privacy": { + "description": "Required. Privacy setting for the contacts associated with the `Registration`.", + "enum": [ + "CONTACT_PRIVACY_UNSPECIFIED", + "PUBLIC_CONTACT_DATA", + "PRIVATE_CONTACT_DATA", + "REDACTED_CONTACT_DATA" + ], + "enumDescriptions": [ + "The contact privacy settings are undefined.", + "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", + "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + ], + "type": "string" + }, + "registrantContact": { + "$ref": "Contact", + "description": "Required. The registrant contact for the `Registration`. *Caution: Anyone with access to this email address, phone number, and/or postal address can take control of the domain.* *Warning: For new `Registration`s, the registrant will receive an email confirmation that they must complete within 15 days to avoid domain suspension.*" + }, + "technicalContact": { + "$ref": "Contact", + "description": "Required. The technical contact for the `Registration`." + } + }, + "type": "object" + }, + "CustomDns": { + "description": "Configuration for an arbitrary DNS provider.", + "id": "CustomDns", + "properties": { + "dsRecords": { + "description": "The list of DS records for this domain, which are used to enable DNSSEC. The domain's DNS provider can provide the values to set here. If this field is empty, DNSSEC is disabled.", + "items": { + "$ref": "DsRecord" + }, + "type": "array" + }, + "nameServers": { + "description": "Required. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DnsSettings": { + "description": "Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records.", + "id": "DnsSettings", + "properties": { + "customDns": { + "$ref": "CustomDns", + "description": "An arbitrary DNS provider identified by its name servers." + }, + "glueRecords": { + "description": "The list of glue records for this `Registration`. Commonly empty.", + "items": { + "$ref": "GlueRecord" + }, + "type": "array" + }, + "googleDomainsDns": { + "$ref": "GoogleDomainsDns", + "description": "The free DNS zone provided by [Google Domains](https://domains.google/)." + } + }, + "type": "object" + }, + "DsRecord": { + "description": "Defines a Delegation Signer (DS) record, which is needed to enable DNSSEC for a domain. It contains a digest (hash) of a DNSKEY record that must be present in the domain's DNS zone.", + "id": "DsRecord", + "properties": { + "algorithm": { + "description": "The algorithm used to generate the referenced DNSKEY.", + "enum": [ + "ALGORITHM_UNSPECIFIED", + "DSA", + "ECC", + "RSASHA1", + "DSANSEC3SHA1", + "RSASHA1NSEC3SHA1", + "RSASHA256", + "RSASHA512", + "ECCGOST", + "ECDSAP256SHA256", + "ECDSAP384SHA384", + "ED25519", + "ED448" + ], + "enumDescriptions": [ + "The algorithm is unspecified.", + "DSA/SHA1. Not recommended for new deployments.", + "ECC. Not recommended for new deployments.", + "RSA/SHA-1. Not recommended for new deployments.", + "DSA-NSEC3-SHA1. Not recommended for new deployments.", + "RSA/SHA1-NSEC3-SHA1. Not recommended for new deployments.", + "RSA/SHA-256.", + "RSA/SHA-512.", + "GOST R 34.10-2001.", + "ECDSA Curve P-256 with SHA-256.", + "ECDSA Curve P-384 with SHA-384.", + "Ed25519.", + "Ed448." + ], + "type": "string" + }, + "digest": { + "description": "The digest generated from the referenced DNSKEY.", + "type": "string" + }, + "digestType": { + "description": "The hash function used to generate the digest of the referenced DNSKEY.", + "enum": [ + "DIGEST_TYPE_UNSPECIFIED", + "SHA1", + "SHA256", + "GOST3411", + "SHA384" + ], + "enumDescriptions": [ + "The DigestType is unspecified.", + "SHA-1. Not recommended for new deployments.", + "SHA-256.", + "GOST R 34.11-94.", + "SHA-384." + ], + "type": "string" + }, + "keyTag": { + "description": "The key tag of the record. Must be set in range 0 -- 65535.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ExportRegistrationRequest": { + "description": "Request for the `ExportRegistration` method.", + "id": "ExportRegistrationRequest", + "properties": {}, + "type": "object" + }, + "Expr": { + "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() < 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", + "properties": { + "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" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "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" + }, + "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" + }, + "GlueRecord": { + "description": "Defines a host on your domain that is a DNS name server for your domain and/or other domains. Glue records are a way of making the IP address of a name server known, even when it serves DNS queries for its parent domain. For example, when `ns.example.com` is a name server for `example.com`, the host `ns.example.com` must have a glue record to break the circular DNS reference.", + "id": "GlueRecord", + "properties": { + "hostName": { + "description": "Required. Domain name of the host in Punycode format.", + "type": "string" + }, + "ipv4Addresses": { + "description": "List of IPv4 addresses corresponding to this host in the standard decimal format (e.g. `198.51.100.1`). At least one of `ipv4_address` and `ipv6_address` must be set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ipv6Addresses": { + "description": "List of IPv6 addresses corresponding to this host in the standard hexadecimal format (e.g. `2001:db8::`). At least one of `ipv4_address` and `ipv6_address` must be set.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleDomainsDns": { + "description": "Configuration for using the free DNS zone provided by Google Domains as a `Registration`'s `dns_provider`. You cannot configure the DNS zone itself using the API. To configure the DNS zone, go to [Google Domains](https://domains.google/).", + "id": "GoogleDomainsDns", + "properties": { + "dsRecords": { + "description": "Output only. The list of DS records published for this domain. The list is automatically populated when `ds_state` is `DS_RECORDS_PUBLISHED`, otherwise it remains empty.", + "items": { + "$ref": "DsRecord" + }, + "readOnly": true, + "type": "array" + }, + "dsState": { + "description": "Required. The state of DS records for this domain. Used to enable or disable automatic DNSSEC.", + "enum": [ + "DS_STATE_UNSPECIFIED", + "DS_RECORDS_UNPUBLISHED", + "DS_RECORDS_PUBLISHED" + ], + "enumDescriptions": [ + "DS state is unspecified.", + "DNSSEC is disabled for this domain. No DS records for this domain are published in the parent DNS zone.", + "DNSSEC is enabled for this domain. Appropriate DS records for this domain are published in the parent DNS zone. This option is valid only if the DNS zone referenced in the `Registration`'s `dns_provider` field is already DNSSEC-signed." + ], + "type": "string" + }, + "nameServers": { + "description": "Output only. A list of name servers that store the DNS zone for this domain. Each name server is a domain name, with Unicode domain names expressed in Punycode format. This field is automatically populated with the name servers assigned to the Google Domains DNS zone.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRegistrationsResponse": { + "description": "Response for the `ListRegistrations` method.", + "id": "ListRegistrationsResponse", + "properties": { + "nextPageToken": { + "description": "When present, there are more results to retrieve. Set `page_token` to this value on a subsequent call to get the next page of results.", + "type": "string" + }, + "registrations": { + "description": "A list of `Registration`s.", + "items": { + "$ref": "Registration" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "ManagementSettings": { + "description": "Defines renewal, billing, and transfer settings for a `Registration`.", + "id": "ManagementSettings", + "properties": { + "renewalMethod": { + "description": "Output only. The renewal method for this `Registration`.", + "enum": [ + "RENEWAL_METHOD_UNSPECIFIED", + "AUTOMATIC_RENEWAL", + "MANUAL_RENEWAL" + ], + "enumDescriptions": [ + "The renewal method is undefined.", + "The domain is automatically renewed each year . To disable automatic renewals, export the domain by calling `ExportRegistration` .", + "The domain must be explicitly renewed each year before its `expire_time`. This option is only available when the `Registration` is in state `EXPORTED`. To manage the domain's current billing and renewal settings, go to [Google Domains](https://domains.google/)." + ], + "readOnly": true, + "type": "string" + }, + "transferLockState": { + "description": "Controls whether the domain can be transferred to another registrar.", + "enum": [ + "TRANSFER_LOCK_STATE_UNSPECIFIED", + "UNLOCKED", + "LOCKED" + ], + "enumDescriptions": [ + "The state is unspecified.", + "The domain is unlocked and can be transferred to another registrar.", + "The domain is locked and cannot be transferred to another registrar." + ], + "type": "string" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "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", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation. Output only.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "API version used to start the operation.", + "type": "string" + }, + "createTime": { + "description": "The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "statusDetail": { + "description": "Human-readable status of the operation, if any.", + "type": "string" + }, + "target": { + "description": "Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "Policy": { + "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` to a single `role`. Members 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 < 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 < 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/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to 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 member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "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" + }, + "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PostalAddress": { + "description": "Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478", + "id": "PostalAddress", + "properties": { + "addressLines": { + "description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", + "items": { + "type": "string" + }, + "type": "array" + }, + "administrativeArea": { + "description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.", + "type": "string" + }, + "languageCode": { + "description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", + "type": "string" + }, + "locality": { + "description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.", + "type": "string" + }, + "organization": { + "description": "Optional. The name of the organization at the address.", + "type": "string" + }, + "postalCode": { + "description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).", + "type": "string" + }, + "recipients": { + "description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", + "items": { + "type": "string" + }, + "type": "array" + }, + "regionCode": { + "description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", + "type": "string" + }, + "revision": { + "description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", + "format": "int32", + "type": "integer" + }, + "sortingCode": { + "description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (e.g. \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (e.g. Côte d'Ivoire).", + "type": "string" + }, + "sublocality": { + "description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.", + "type": "string" + } + }, + "type": "object" + }, + "RegisterDomainRequest": { + "description": "Request for the `RegisterDomain` method.", + "id": "RegisterDomainRequest", + "properties": { + "contactNotices": { + "description": "The list of contact notices that the caller acknowledges. The notices required here depend on the values specified in `registration.contact_settings`.", + "items": { + "enum": [ + "CONTACT_NOTICE_UNSPECIFIED", + "PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT" + ], + "enumDescriptions": [ + "The notice is undefined.", + "Required when setting the `privacy` field of `ContactSettings` to `PUBLIC_CONTACT_DATA`, which exposes contact data publicly." + ], + "type": "string" + }, + "type": "array" + }, + "domainNotices": { + "description": "The list of domain notices that you acknowledge. Call `RetrieveRegisterParameters` to see the notices that need acknowledgement.", + "items": { + "enum": [ + "DOMAIN_NOTICE_UNSPECIFIED", + "HSTS_PRELOADED" + ], + "enumDescriptions": [ + "The notice is undefined.", + "Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see [how to get an SSL certificate](https://support.google.com/domains/answer/7638036)." + ], + "type": "string" + }, + "type": "array" + }, + "registration": { + "$ref": "Registration", + "description": "Required. The complete `Registration` resource to be created." + }, + "validateOnly": { + "description": "When true, only validation will be performed, without actually registering the domain. Follows: https://cloud.google.com/apis/design/design_patterns#request_validation", + "type": "boolean" + }, + "yearlyPrice": { + "$ref": "Money", + "description": "Required. Yearly price to register or renew the domain. The value that should be put here can be obtained from RetrieveRegisterParameters or SearchDomains calls." + } + }, + "type": "object" + }, + "RegisterParameters": { + "description": "Parameters required to register a new domain.", + "id": "RegisterParameters", + "properties": { + "availability": { + "description": "Indicates whether the domain is available for registration. This value is accurate when obtained by calling `RetrieveRegisterParameters`, but is approximate when obtained by calling `SearchDomains`.", + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "AVAILABLE", + "UNAVAILABLE", + "UNSUPPORTED", + "UNKNOWN" + ], + "enumDescriptions": [ + "The availability is unspecified.", + "The domain is available for registration.", + "The domain is not available for registration. Generally this means it is already registered to another party.", + "The domain is not currently supported by Cloud Domains, but may be available elsewhere.", + "Cloud Domains is unable to determine domain availability, generally due to system maintenance at the domain name registry." + ], + "type": "string" + }, + "domainName": { + "description": "The domain name. Unicode domain names are expressed in Punycode format.", + "type": "string" + }, + "domainNotices": { + "description": "Notices about special properties of the domain.", + "items": { + "enum": [ + "DOMAIN_NOTICE_UNSPECIFIED", + "HSTS_PRELOADED" + ], + "enumDescriptions": [ + "The notice is undefined.", + "Indicates that the domain is preloaded on the HTTP Strict Transport Security list in browsers. Serving a website on such domain requires an SSL certificate. For details, see [how to get an SSL certificate](https://support.google.com/domains/answer/7638036)." + ], + "type": "string" + }, + "type": "array" + }, + "supportedPrivacy": { + "description": "Contact privacy options that the domain supports.", + "items": { + "enum": [ + "CONTACT_PRIVACY_UNSPECIFIED", + "PUBLIC_CONTACT_DATA", + "PRIVATE_CONTACT_DATA", + "REDACTED_CONTACT_DATA" + ], + "enumDescriptions": [ + "The contact privacy settings are undefined.", + "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", + "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + ], + "type": "string" + }, + "type": "array" + }, + "yearlyPrice": { + "$ref": "Money", + "description": "Price to register or renew the domain for one year." + } + }, + "type": "object" + }, + "Registration": { + "description": "The `Registration` resource facilitates managing and configuring domain name registrations. To create a new `Registration` resource, find a suitable domain name by calling the `SearchDomains` method with a query to see available domain name options. After choosing a name, call `RetrieveRegisterParameters` to ensure availability and obtain information like pricing, which is needed to build a call to `RegisterDomain`. ", + "id": "Registration", + "properties": { + "contactSettings": { + "$ref": "ContactSettings", + "description": "Required. Settings for contact information linked to the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureContactSettings` method." + }, + "createTime": { + "description": "Output only. The creation timestamp of the `Registration` resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dnsSettings": { + "$ref": "DnsSettings", + "description": "Settings controlling the DNS configuration of the `Registration`. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureDnsSettings` method." + }, + "domainName": { + "description": "Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.", + "type": "string" + }, + "expireTime": { + "description": "Output only. The expiration timestamp of the `Registration`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "issues": { + "description": "Output only. The set of issues with the `Registration` that require attention.", + "items": { + "enum": [ + "ISSUE_UNSPECIFIED", + "CONTACT_SUPPORT", + "UNVERIFIED_EMAIL" + ], + "enumDescriptions": [ + "The issue is undefined.", + "Contact the Cloud Support team to resolve a problem with this domain.", + "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Set of labels associated with the `Registration`.", + "type": "object" + }, + "managementSettings": { + "$ref": "ManagementSettings", + "description": "Settings for management of the `Registration`, including renewal, billing, and transfer. You cannot update these with the `UpdateRegistration` method. To update these settings, use the `ConfigureManagementSettings` method." + }, + "name": { + "description": "Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`.", + "readOnly": true, + "type": "string" + }, + "pendingContactSettings": { + "$ref": "ContactSettings", + "description": "Output only. Pending contact settings for the `Registration`. Updates to the `contact_settings` field that change its `registrant_contact` or `privacy` fields require email confirmation by the `registrant_contact` before taking effect. This field is set only if there are pending updates to the `contact_settings` that have not yet been confirmed. To confirm the changes, the `registrant_contact` must follow the instructions in the email they receive.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the `Registration`", + "enum": [ + "STATE_UNSPECIFIED", + "REGISTRATION_PENDING", + "REGISTRATION_FAILED", + "ACTIVE", + "SUSPENDED", + "EXPORTED" + ], + "enumDescriptions": [ + "The state is undefined.", + "The domain is being registered.", + "The domain registration failed. You can delete resources in this state to allow registration to be retried.", + "The domain is registered and operational. The domain renews automatically as long as it remains in this state.", + "The domain is suspended and inoperative. For more details, see the `issues` field.", + "The domain has been exported from Cloud Domains to [Google Domains](https://domains.google/). You can no longer update it with this API, and information shown about it may be stale. Without further action, domains in this state expire at their `expire_time`. You can delete the resource after the `expire_time` has passed." + ], + "readOnly": true, + "type": "string" + }, + "supportedPrivacy": { + "description": "Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports.", + "items": { + "enum": [ + "CONTACT_PRIVACY_UNSPECIFIED", + "PUBLIC_CONTACT_DATA", + "PRIVATE_CONTACT_DATA", + "REDACTED_CONTACT_DATA" + ], + "enumDescriptions": [ + "The contact privacy settings are undefined.", + "All the data from `ContactSettings` is publicly available. When setting this option, you must also provide a `PUBLIC_CONTACT_DATA_ACKNOWLEDGEMENT` in the `contact_notices` field of the request.", + "None of the data from `ContactSettings` is publicly available. Instead, proxy contact data is published for your domain. Email sent to the proxy email address is forwarded to the registrant's email address. Cloud Domains provides this privacy proxy service at no additional cost.", + "Some data from `ContactSettings` is publicly available. The actual information redacted depends on the domain. For details, see [the registration privacy article](https://support.google.com/domains/answer/3251242)." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ResetAuthorizationCodeRequest": { + "description": "Request for the `ResetAuthorizationCode` method.", + "id": "ResetAuthorizationCodeRequest", + "properties": {}, + "type": "object" + }, + "RetrieveRegisterParametersResponse": { + "description": "Response for the `RetrieveRegisterParameters` method.", + "id": "RetrieveRegisterParametersResponse", + "properties": { + "registerParameters": { + "$ref": "RegisterParameters", + "description": "Parameters to use when calling the `RegisterDomain` method." + } + }, + "type": "object" + }, + "SearchDomainsResponse": { + "description": "Response for the `SearchDomains` method.", + "id": "SearchDomainsResponse", + "properties": { + "registerParameters": { + "description": "Results of the domain name search.", + "items": { + "$ref": "RegisterParameters" + }, + "type": "array" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "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 Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "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\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "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": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud Domains API", + "version": "v1beta1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/factchecktools__v1alpha1.json b/discovery/googleapis_beta/factchecktools__v1alpha1.json index 461f478..1087fb5 100644 --- a/discovery/googleapis_beta/factchecktools__v1alpha1.json +++ b/discovery/googleapis_beta/factchecktools__v1alpha1.json
@@ -296,7 +296,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": {
diff --git a/discovery/googleapis_beta/firebase__v1beta1.json b/discovery/googleapis_beta/firebase__v1beta1.json index 22c3e02..817422e 100644 --- a/discovery/googleapis_beta/firebase__v1beta1.json +++ b/discovery/googleapis_beta/firebase__v1beta1.json
@@ -415,7 +415,7 @@ ], "parameters": { "filter": { - "description": "A query string compatible with Google's [AIP-160](https://google.aip.dev/160) standard. Use any of the following fields in a query: * [`appId`](../projects.apps#FirebaseProjectInfo.FIELDS.app_id) * [`namespace`](../projects.apps#FirebaseProjectInfo.FIELDS.namespace) * [`platform`](../projects.apps#FirebaseProjectInfo.FIELDS.platform)", + "description": "A query string compatible with Google's [AIP-160](https://google.aip.dev/160) standard. Use any of the following fields in a query: * [`app_id`](../projects.apps#FirebaseAppInfo.FIELDS.app_id) * [`namespace`](../projects.apps#FirebaseAppInfo.FIELDS.namespace) * [`platform`](../projects.apps#FirebaseAppInfo.FIELDS.platform) We also support the following \"virtual\" fields (fields which are not actually part of the returned resource object, but can be queried as if they are pre-populated with specific values): * `sha1_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-1 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `sha256_hash`: This field is considered to be a repeated `string` field, populated with the list of all SHA-256 certificate fingerprints registered with the app. This list is empty if the app is not an Android app. * `app_store_id`: This field is considered to be a singular `string` field, populated with the Apple App Store ID registered with the app. This field is empty if the app is not an iOS app. * `team_id`: This field is considered to be a singular `string` field, populated with the Apple team ID registered with the app. This field is empty if the app is not an iOS app.", "location": "query", "type": "string" }, @@ -1088,7 +1088,7 @@ } } }, - "revision": "20201006", + "revision": "20210203", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": {
diff --git a/discovery/googleapis_beta/firebasedatabase__v1beta.json b/discovery/googleapis_beta/firebasedatabase__v1beta.json new file mode 100644 index 0000000..649b60d --- /dev/null +++ b/discovery/googleapis_beta/firebasedatabase__v1beta.json
@@ -0,0 +1,399 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/firebase": { + "description": "View and administer all your Firebase data and settings" + }, + "https://www.googleapis.com/auth/firebase.readonly": { + "description": "View all your Firebase data and settings" + } + } + } + }, + "basePath": "", + "baseUrl": "https://firebasedatabase.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Firebase Realtime Database", + "description": "The Firebase Realtime Database Management API enables programmatic provisioning and management of Realtime Database instances.", + "discoveryVersion": "v1", + "documentationLink": "https://firebase.google.com/docs/reference/rest/database/database-management/rest/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "firebasedatabase:v1beta", + "kind": "discovery#restDescription", + "name": "firebasedatabase", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "instances": { + "methods": { + "create": { + "description": "Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.", + "httpMethod": "POST", + "id": "firebasedatabase.projects.locations.instances.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "databaseId": { + "description": "The globally unique identifier of the database instance.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent project for which to create a database instance, in the form: `projects/{project-number}/locations/{location-id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "When set to true, the request will be validated but not submitted.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/instances", + "request": { + "$ref": "DatabaseInstance" + }, + "response": { + "$ref": "DatabaseInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "delete": { + "description": "Marks a DatabaseInstance to be deleted. The DatabaseInstance will be purged within 30 days. The default database cannot be deleted. IDs for deleted database instances may never be recovered or re-used. The Database may only be deleted if it is already in a DISABLED state.", + "httpMethod": "DELETE", + "id": "firebasedatabase.projects.locations.instances.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "DatabaseInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "disable": { + "description": "Disables a DatabaseInstance. The database can be re-enabled later using ReenableDatabaseInstance. When a database is disabled, all reads and writes are denied, including view access in the Firebase console.", + "httpMethod": "POST", + "id": "firebasedatabase.projects.locations.instances.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:disable", + "request": { + "$ref": "DisableDatabaseInstanceRequest" + }, + "response": { + "$ref": "DatabaseInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "get": { + "description": "Gets the DatabaseInstance identified by the specified resource name.", + "httpMethod": "GET", + "id": "firebasedatabase.projects.locations.instances.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`. `database-id` is a globally unique identifier across all parent collections. For convenience, this method allows you to supply `-` as a wildcard character in place of specific collections under `projects` and `locations`. The resulting wildcarding form of the method is: `projects/-/locations/-/instances/{database-id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "DatabaseInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ] + }, + "list": { + "description": "Lists each DatabaseInstance associated with the specified parent project. The list items are returned in no particular order, but will be a consistent view of the database instances when additional requests are made with a `pageToken`. The resulting list contains instances in any STATE. The list results may be stale by a few seconds. Use GetDatabaseInstance for consistent reads.", + "httpMethod": "GET", + "id": "firebasedatabase.projects.locations.instances.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of database instances to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token returned from a previous call to `ListDatabaseInstances` indicating where in the set of database instances to resume listing.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The parent project for which to list database instances, in the form: `projects/{project-number}/locations/{location-id}` To list across all locations, use a parent in the form: `projects/{project-number}/locations/-`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/instances", + "response": { + "$ref": "ListDatabaseInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ] + }, + "reenable": { + "description": "Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.", + "httpMethod": "POST", + "id": "firebasedatabase.projects.locations.instances.reenable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:reenable", + "request": { + "$ref": "ReenableDatabaseInstanceRequest" + }, + "response": { + "$ref": "DatabaseInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + } + } + } + } + } + } + } + }, + "revision": "20210203", + "rootUrl": "https://firebasedatabase.googleapis.com/", + "schemas": { + "DatabaseInstance": { + "description": "Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.", + "id": "DatabaseInstance", + "properties": { + "databaseUrl": { + "description": "Immutable. The globally unique hostname of the database.", + "type": "string" + }, + "name": { + "description": "The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`. Currently the only supported location is 'us-central1'.", + "type": "string" + }, + "project": { + "description": "The resource name of the project this instance belongs to. For example: `projects/{project-number}`.", + "type": "string" + }, + "state": { + "description": "The database's lifecycle state. Read-only.", + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "ACTIVE", + "DISABLED", + "DELETED" + ], + "enumDescriptions": [ + "Unspecified state, likely the result of an error on the backend. This is only used for distinguishing unset values.", + "The normal and active state.", + "The database is in a disabled state. It can be re-enabled later.", + "The database is in a deleted state." + ], + "type": "string" + }, + "type": { + "description": "The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.", + "enum": [ + "DATABASE_INSTANCE_TYPE_UNSPECIFIED", + "DEFAULT_DATABASE", + "USER_DATABASE" + ], + "enumDescriptions": [ + "Unknown state, likely the result of an error on the backend. This is only used for distinguishing unset values.", + "The default database that is provisioned when a project is created.", + "A database that the user created." + ], + "type": "string" + } + }, + "type": "object" + }, + "DisableDatabaseInstanceRequest": { + "description": "The request sent to the DisableDatabaseInstance method.", + "id": "DisableDatabaseInstanceRequest", + "properties": {}, + "type": "object" + }, + "ListDatabaseInstancesResponse": { + "description": "The response from the ListDatabaseInstances method.", + "id": "ListDatabaseInstancesResponse", + "properties": { + "instances": { + "description": "List of each DatabaseInstance that is in the parent Firebase project.", + "items": { + "$ref": "DatabaseInstance" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to `ListDatabaseInstances` to find the next group of database instances. Page tokens are short-lived and should not be persisted.", + "type": "string" + } + }, + "type": "object" + }, + "ReenableDatabaseInstanceRequest": { + "description": "The request sent to the ReenableDatabaseInstance method.", + "id": "ReenableDatabaseInstanceRequest", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "Firebase Realtime Database Management API", + "version": "v1beta", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/firebasehosting__v1beta1.json b/discovery/googleapis_beta/firebasehosting__v1beta1.json deleted file mode 100644 index 264dbd7..0000000 --- a/discovery/googleapis_beta/firebasehosting__v1beta1.json +++ /dev/null
@@ -1,2569 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/firebase": { - "description": "View and administer all your Firebase data and settings" - }, - "https://www.googleapis.com/auth/firebase.readonly": { - "description": "View all your Firebase data and settings" - } - } - } - }, - "basePath": "", - "baseUrl": "https://firebasehosting.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Firebase Hosting", - "description": "The Firebase Hosting REST API enables programmatic and customizable deployments to your Firebase-hosted sites. Use this REST API to deploy new or updated hosting configurations and content files.", - "discoveryVersion": "v1", - "documentationLink": "https://firebase.google.com/docs/hosting/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "firebasehosting:v1beta1", - "kind": "discovery#restDescription", - "name": "firebasehosting", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "firebasehosting.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - } - } - }, - "sites": { - "methods": { - "getConfig": { - "description": "Gets the Hosting metadata for a specific site.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.getConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/config$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "SiteConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "updateConfig": { - "description": "Sets the Hosting metadata for a specific site.", - "httpMethod": "PATCH", - "id": "firebasehosting.projects.sites.updateConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/config$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "SiteConfig" - }, - "response": { - "$ref": "SiteConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - }, - "resources": { - "channels": { - "methods": { - "create": { - "description": "Creates a new channel in the specified site.", - "httpMethod": "POST", - "id": "firebasehosting.projects.sites.channels.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "channelId": { - "description": "Required. Immutable. A unique id within the site to identify the channel.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The site in which this channel should be created.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/channels", - "request": { - "$ref": "Channel" - }, - "response": { - "$ref": "Channel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "delete": { - "description": "Deletes a channel of a site. The `live` channel cannot be deleted.", - "httpMethod": "DELETE", - "id": "firebasehosting.projects.sites.channels.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fully-qualified identifier for the site.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "get": { - "description": "Retrieves information for the specified channel of a site.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.channels.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fully-qualified identifier for the channel.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Channel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "list": { - "description": "Lists the channels for the specified site. All sites have a default \"live\" channel.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.channels.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 channels will be returned. The maximum value is 100; valuupdateses above 100 will be coerced to 100", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The site from which to list channels.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/channels", - "response": { - "$ref": "ListChannelsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "patch": { - "description": "Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.", - "httpMethod": "PATCH", - "id": "firebasehosting.projects.sites.channels.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The fully-qualified identifier of the Channel.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "A comma-separated list of fields to be updated in this request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Channel" - }, - "response": { - "$ref": "Channel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - }, - "resources": { - "releases": { - "methods": { - "create": { - "description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).", - "httpMethod": "POST", - "id": "firebasehosting.projects.sites.channels.releases.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The site that the release belongs to, in the format: sites/ site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - }, - "versionName": { - "description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "request": { - "$ref": "Release" - }, - "response": { - "$ref": "Release" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "list": { - "description": "Lists the releases that have been created on the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.channels.releases.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list files, in the format: sites/site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "response": { - "$ref": "ListReleasesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - } - } - } - } - }, - "domains": { - "methods": { - "create": { - "description": "Creates a domain mapping on the specified site.", - "httpMethod": "POST", - "id": "firebasehosting.projects.sites.domains.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent to create the domain association for, in the format: sites/site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/domains", - "request": { - "$ref": "Domain" - }, - "response": { - "$ref": "Domain" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "delete": { - "description": "Deletes the existing domain mapping on the specified site.", - "httpMethod": "DELETE", - "id": "firebasehosting.projects.sites.domains.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the domain association to delete.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "get": { - "description": "Gets a domain mapping on the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.domains.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the domain configuration to get.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Domain" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "list": { - "description": "Lists the domains for the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.domains.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 50.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list domains, in the format: sites/ site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/domains", - "response": { - "$ref": "ListDomainsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "update": { - "description": "Updates the specified domain mapping, creating the mapping as if it does not exist.", - "httpMethod": "PUT", - "id": "firebasehosting.projects.sites.domains.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the domain association to update or create, if an association doesn't already exist.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/domains/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Domain" - }, - "response": { - "$ref": "Domain" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - } - }, - "releases": { - "methods": { - "create": { - "description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).", - "httpMethod": "POST", - "id": "firebasehosting.projects.sites.releases.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The site that the release belongs to, in the format: sites/ site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - }, - "versionName": { - "description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "request": { - "$ref": "Release" - }, - "response": { - "$ref": "Release" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "list": { - "description": "Lists the releases that have been created on the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.releases.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list files, in the format: sites/site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "response": { - "$ref": "ListReleasesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - } - } - }, - "versions": { - "methods": { - "clone": { - "description": "Creates a new version on the target site using the content of the specified version.", - "httpMethod": "POST", - "id": "firebasehosting.projects.sites.versions.clone", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The target site where the cloned version will reside, in the format: `sites/{site}`", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/versions:clone", - "request": { - "$ref": "CloneVersionRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "create": { - "description": "Creates a new version for a site.", - "httpMethod": "POST", - "id": "firebasehosting.projects.sites.versions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent to create the version for, in the format: sites/ site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - }, - "sizeBytes": { - "description": "The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.", - "format": "int64", - "location": "query", - "type": "string" - }, - "versionId": { - "description": "A unique id for the new version. This is was only specified for legacy version creations, and should be blank.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/versions", - "request": { - "$ref": "Version" - }, - "response": { - "$ref": "Version" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "delete": { - "description": "Deletes the specified version.", - "httpMethod": "DELETE", - "id": "firebasehosting.projects.sites.versions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the version to be deleted, in the format: sites/ site-name/versions/versionID", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "list": { - "description": "Lists the versions that have been created on the specified site. Will include filtering in the future.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.versions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list files, in the format: sites/site-name", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/versions", - "response": { - "$ref": "ListVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "patch": { - "description": "Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`.", - "httpMethod": "PATCH", - "id": "firebasehosting.projects.sites.versions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "A set of field names from your [version](../sites.versions) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Version" - }, - "response": { - "$ref": "Version" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "populateFiles": { - "description": "Adds content files to a version. Each file must be under 2 GB.", - "httpMethod": "POST", - "id": "firebasehosting.projects.sites.versions.populateFiles", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The version to add files to, in the format: sites/site-name /versions/versionID", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}:populateFiles", - "request": { - "$ref": "PopulateVersionFilesRequest" - }, - "response": { - "$ref": "PopulateVersionFilesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - }, - "resources": { - "files": { - "methods": { - "list": { - "description": "Lists the remaining files to be uploaded for the specified version.", - "httpMethod": "GET", - "id": "firebasehosting.projects.sites.versions.files.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent to list files for, in the format: sites/site-name /versions/versionID", - "location": "path", - "pattern": "^projects/[^/]+/sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - }, - "status": { - "description": "The type of files in the version that should be listed.", - "enum": [ - "STATUS_UNSPECIFIED", - "EXPECTED", - "ACTIVE" - ], - "enumDescriptions": [ - "The default status; should not be intentionally used.", - "The file has been included in the version and is expected to be uploaded in the near future.", - "The file has already been uploaded to Firebase Hosting." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/files", - "response": { - "$ref": "ListVersionFilesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - } - } - } - } - } - } - } - } - }, - "sites": { - "methods": { - "getConfig": { - "description": "Gets the Hosting metadata for a specific site.", - "httpMethod": "GET", - "id": "firebasehosting.sites.getConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The site for which to get the SiteConfig, in the format: sites/ site-name/config", - "location": "path", - "pattern": "^sites/[^/]+/config$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "SiteConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "updateConfig": { - "description": "Sets the Hosting metadata for a specific site.", - "httpMethod": "PATCH", - "id": "firebasehosting.sites.updateConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The site for which to update the SiteConfig, in the format: sites/ site-name/config", - "location": "path", - "pattern": "^sites/[^/]+/config$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "SiteConfig" - }, - "response": { - "$ref": "SiteConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - }, - "resources": { - "channels": { - "methods": { - "create": { - "description": "Creates a new channel in the specified site.", - "httpMethod": "POST", - "id": "firebasehosting.sites.channels.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "channelId": { - "description": "Required. Immutable. A unique id within the site to identify the channel.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The site in which this channel should be created.", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/channels", - "request": { - "$ref": "Channel" - }, - "response": { - "$ref": "Channel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "delete": { - "description": "Deletes a channel of a site. The `live` channel cannot be deleted.", - "httpMethod": "DELETE", - "id": "firebasehosting.sites.channels.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fully-qualified identifier for the site.", - "location": "path", - "pattern": "^sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "get": { - "description": "Retrieves information for the specified channel of a site.", - "httpMethod": "GET", - "id": "firebasehosting.sites.channels.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fully-qualified identifier for the channel.", - "location": "path", - "pattern": "^sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Channel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "list": { - "description": "Lists the channels for the specified site. All sites have a default \"live\" channel.", - "httpMethod": "GET", - "id": "firebasehosting.sites.channels.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 channels will be returned. The maximum value is 100; valuupdateses above 100 will be coerced to 100", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The site from which to list channels.", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/channels", - "response": { - "$ref": "ListChannelsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "patch": { - "description": "Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.", - "httpMethod": "PATCH", - "id": "firebasehosting.sites.channels.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The fully-qualified identifier of the Channel.", - "location": "path", - "pattern": "^sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "A comma-separated list of fields to be updated in this request.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Channel" - }, - "response": { - "$ref": "Channel" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - }, - "resources": { - "releases": { - "methods": { - "create": { - "description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).", - "httpMethod": "POST", - "id": "firebasehosting.sites.channels.releases.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The site that the release belongs to, in the format: sites/ site-name", - "location": "path", - "pattern": "^sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - }, - "versionName": { - "description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "request": { - "$ref": "Release" - }, - "response": { - "$ref": "Release" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "list": { - "description": "Lists the releases that have been created on the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.sites.channels.releases.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list files, in the format: sites/site-name", - "location": "path", - "pattern": "^sites/[^/]+/channels/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "response": { - "$ref": "ListReleasesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - } - } - } - } - }, - "domains": { - "methods": { - "create": { - "description": "Creates a domain mapping on the specified site.", - "httpMethod": "POST", - "id": "firebasehosting.sites.domains.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent to create the domain association for, in the format: sites/site-name", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/domains", - "request": { - "$ref": "Domain" - }, - "response": { - "$ref": "Domain" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "delete": { - "description": "Deletes the existing domain mapping on the specified site.", - "httpMethod": "DELETE", - "id": "firebasehosting.sites.domains.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the domain association to delete.", - "location": "path", - "pattern": "^sites/[^/]+/domains/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "get": { - "description": "Gets a domain mapping on the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.sites.domains.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the domain configuration to get.", - "location": "path", - "pattern": "^sites/[^/]+/domains/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Domain" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "list": { - "description": "Lists the domains for the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.sites.domains.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 50.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list domains, in the format: sites/ site-name", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/domains", - "response": { - "$ref": "ListDomainsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "update": { - "description": "Updates the specified domain mapping, creating the mapping as if it does not exist.", - "httpMethod": "PUT", - "id": "firebasehosting.sites.domains.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the domain association to update or create, if an association doesn't already exist.", - "location": "path", - "pattern": "^sites/[^/]+/domains/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Domain" - }, - "response": { - "$ref": "Domain" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - } - }, - "releases": { - "methods": { - "create": { - "description": "Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).", - "httpMethod": "POST", - "id": "firebasehosting.sites.releases.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The site that the release belongs to, in the format: sites/ site-name", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - }, - "versionName": { - "description": "The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "request": { - "$ref": "Release" - }, - "response": { - "$ref": "Release" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "list": { - "description": "Lists the releases that have been created on the specified site.", - "httpMethod": "GET", - "id": "firebasehosting.sites.releases.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list files, in the format: sites/site-name", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/releases", - "response": { - "$ref": "ListReleasesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - } - } - }, - "versions": { - "methods": { - "clone": { - "description": "Creates a new version on the target site using the content of the specified version.", - "httpMethod": "POST", - "id": "firebasehosting.sites.versions.clone", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The target site where the cloned version will reside, in the format: `sites/{site}`", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/versions:clone", - "request": { - "$ref": "CloneVersionRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "create": { - "description": "Creates a new version for a site.", - "httpMethod": "POST", - "id": "firebasehosting.sites.versions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent to create the version for, in the format: sites/ site-name", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - }, - "sizeBytes": { - "description": "The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.", - "format": "int64", - "location": "query", - "type": "string" - }, - "versionId": { - "description": "A unique id for the new version. This is was only specified for legacy version creations, and should be blank.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/versions", - "request": { - "$ref": "Version" - }, - "response": { - "$ref": "Version" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "delete": { - "description": "Deletes the specified version.", - "httpMethod": "DELETE", - "id": "firebasehosting.sites.versions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the version to be deleted, in the format: sites/ site-name/versions/versionID", - "location": "path", - "pattern": "^sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "list": { - "description": "Lists the versions that have been created on the specified site. Will include filtering in the future.", - "httpMethod": "GET", - "id": "firebasehosting.sites.versions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent for which to list files, in the format: sites/site-name", - "location": "path", - "pattern": "^sites/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/versions", - "response": { - "$ref": "ListVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - }, - "patch": { - "description": "Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`.", - "httpMethod": "PATCH", - "id": "firebasehosting.sites.versions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.", - "location": "path", - "pattern": "^sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "A set of field names from your [version](../sites.versions) that you want to update. A field will be overwritten if, and only if, it's in the mask. If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Version" - }, - "response": { - "$ref": "Version" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - }, - "populateFiles": { - "description": "Adds content files to a version. Each file must be under 2 GB.", - "httpMethod": "POST", - "id": "firebasehosting.sites.versions.populateFiles", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The version to add files to, in the format: sites/site-name /versions/versionID", - "location": "path", - "pattern": "^sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}:populateFiles", - "request": { - "$ref": "PopulateVersionFilesRequest" - }, - "response": { - "$ref": "PopulateVersionFilesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ] - } - }, - "resources": { - "files": { - "methods": { - "list": { - "description": "Lists the remaining files to be uploaded for the specified version.", - "httpMethod": "GET", - "id": "firebasehosting.sites.versions.files.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The page size to return. Defaults to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent to list files for, in the format: sites/site-name /versions/versionID", - "location": "path", - "pattern": "^sites/[^/]+/versions/[^/]+$", - "required": true, - "type": "string" - }, - "status": { - "description": "The type of files in the version that should be listed.", - "enum": [ - "STATUS_UNSPECIFIED", - "EXPECTED", - "ACTIVE" - ], - "enumDescriptions": [ - "The default status; should not be intentionally used.", - "The file has been included in the version and is expected to be uploaded in the near future.", - "The file has already been uploaded to Firebase Hosting." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/files", - "response": { - "$ref": "ListVersionFilesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ] - } - } - } - } - } - } - } - }, - "revision": "20200920", - "rootUrl": "https://firebasehosting.googleapis.com/", - "schemas": { - "ActingUser": { - "description": "Contains metadata about the user who performed an action, such as creating a release or finalizing a version.", - "id": "ActingUser", - "properties": { - "email": { - "description": "The email address of the user when the user performed the action.", - "type": "string" - }, - "imageUrl": { - "description": "A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.", - "type": "string" - } - }, - "type": "object" - }, - "CertDnsChallenge": { - "description": "Represents a DNS certificate challenge.", - "id": "CertDnsChallenge", - "properties": { - "domainName": { - "description": "The domain name upon which the DNS challenge must be satisfied.", - "type": "string" - }, - "token": { - "description": "The value that must be present as a TXT record on the domain name to satisfy the challenge.", - "type": "string" - } - }, - "type": "object" - }, - "CertHttpChallenge": { - "description": "Represents an HTTP certificate challenge.", - "id": "CertHttpChallenge", - "properties": { - "path": { - "description": "The URL path on which to serve the specified token to satisfy the certificate challenge.", - "type": "string" - }, - "token": { - "description": "The token to serve at the specified URL path to satisfy the certificate challenge.", - "type": "string" - } - }, - "type": "object" - }, - "Channel": { - "description": "A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains.", - "id": "Channel", - "properties": { - "createTime": { - "description": "Output only. The time at which the channel was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "expireTime": { - "description": "The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field.", - "format": "google-datetime", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Text labels used for extra metadata and/or filtering.", - "type": "object" - }, - "name": { - "description": "The fully-qualified identifier of the Channel.", - "type": "string" - }, - "release": { - "$ref": "Release", - "description": "Output only. The current release for the channel, if any.", - "readOnly": true - }, - "retainedReleaseCount": { - "description": "The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.", - "format": "int32", - "type": "integer" - }, - "ttl": { - "description": "Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request.", - "format": "google-duration", - "type": "string" - }, - "updateTime": { - "description": "Output only. The time at which the channel was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "url": { - "description": "Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "CloneVersionRequest": { - "description": "The request sent to CloneVersion.", - "id": "CloneVersionRequest", - "properties": { - "exclude": { - "$ref": "PathFilter", - "description": "If provided, only paths that do not match any of the regexes in this list will be included in the new version." - }, - "finalize": { - "description": "If true, immediately finalize the version after cloning is complete.", - "type": "boolean" - }, - "include": { - "$ref": "PathFilter", - "description": "If provided, only paths that match one or more regexes in this list will be included in the new version." - }, - "sourceVersion": { - "description": "Required. The name of the version to be cloned, in the format: `sites/{site}/versions/{version}`", - "type": "string" - } - }, - "type": "object" - }, - "CloudRunRewrite": { - "description": "A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error).", - "id": "CloudRunRewrite", - "properties": { - "region": { - "description": "Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.", - "type": "string" - }, - "serviceId": { - "description": "Required. User-defined ID of the Cloud Run service.", - "type": "string" - } - }, - "type": "object" - }, - "Domain": { - "description": "The intended behavior and status information of a domain.", - "id": "Domain", - "properties": { - "domainName": { - "description": "Required. The domain name of the association.", - "type": "string" - }, - "domainRedirect": { - "$ref": "DomainRedirect", - "description": "If set, the domain should redirect with the provided parameters." - }, - "provisioning": { - "$ref": "DomainProvisioning", - "description": "Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain." - }, - "site": { - "description": "Required. The site name of the association.", - "type": "string" - }, - "status": { - "description": "Output only. Additional status of the domain association.", - "enum": [ - "DOMAIN_STATUS_UNSPECIFIED", - "DOMAIN_CHANGE_PENDING", - "DOMAIN_ACTIVE", - "DOMAIN_VERIFICATION_REQUIRED", - "DOMAIN_VERIFICATION_LOST" - ], - "enumDescriptions": [ - "Unspecified domain association status.", - "An external operation is in progress on the domain association and no further operations can be performed until it is complete. Formerly used for metabase updates. Not currently used", - "The domain association is active and no additional action is required.", - "The domain was previously verified in the legacy system. User must reverify the domain through the ownership service.", - "The domain verification has been lost and the domain is in the grace period before being removed from the Firebase Hosting site." - ], - "type": "string" - }, - "updateTime": { - "description": "Output only. The time at which the domain was last updated.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "DomainProvisioning": { - "description": "The current certificate provisioning status information for a domain.", - "id": "DomainProvisioning", - "properties": { - "certChallengeDiscoveredTxt": { - "description": "The TXT records (for the certificate challenge) that were found at the last DNS fetch.", - "items": { - "type": "string" - }, - "type": "array" - }, - "certChallengeDns": { - "$ref": "CertDnsChallenge", - "description": "The DNS challenge for generating a certificate." - }, - "certChallengeHttp": { - "$ref": "CertHttpChallenge", - "description": "The HTTP challenge for generating a certificate." - }, - "certStatus": { - "description": "The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.", - "enum": [ - "CERT_STATUS_UNSPECIFIED", - "CERT_PENDING", - "CERT_MISSING", - "CERT_PROCESSING", - "CERT_PROPAGATING", - "CERT_ACTIVE", - "CERT_ERROR" - ], - "enumDescriptions": [ - "Unspecified certificate provisioning status.", - "Waiting for certificate challenge to be created.", - "Waiting for certificate challenge to be met.", - "Certificate challenge met; attempting to acquire/propagate certificate.", - "Certificate obtained; propagating to the CDN.", - "Certificate provisioned and deployed across the CDN.", - "Certificate provisioning failed in a non-recoverable manner." - ], - "type": "string" - }, - "discoveredIps": { - "description": "The IPs found at the last DNS fetch.", - "items": { - "type": "string" - }, - "type": "array" - }, - "dnsFetchTime": { - "description": "The time at which the last DNS fetch occurred.", - "format": "google-datetime", - "type": "string" - }, - "dnsStatus": { - "description": "The DNS record match status as of the last DNS fetch.", - "enum": [ - "DNS_STATUS_UNSPECIFIED", - "DNS_PENDING", - "DNS_MISSING", - "DNS_PARTIAL_MATCH", - "DNS_MATCH", - "DNS_EXTRANEOUS_MATCH" - ], - "enumDescriptions": [ - "Unspecified DNS status.", - "No DNS records have been specified for this domain yet.", - "None of the required DNS records have been detected on the domain.", - "Some of the required DNS records were detected, but not all of them. No extra (non-required) DNS records were detected.", - "All required DNS records were detected. No extra (non-required) DNS records were detected.", - "The domain has at least one of the required DNS records, and it has at least one extra (non-required) DNS record." - ], - "type": "string" - }, - "expectedIps": { - "description": "The list of IPs to which the domain is expected to resolve.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "DomainRedirect": { - "description": "Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.", - "id": "DomainRedirect", - "properties": { - "domainName": { - "description": "Required. The domain name to redirect to.", - "type": "string" - }, - "type": { - "description": "Required. The redirect status code.", - "enum": [ - "REDIRECT_TYPE_UNSPECIFIED", - "MOVED_PERMANENTLY" - ], - "enumDescriptions": [ - "The default redirect type; should not be intentionlly used.", - "The redirect will respond with an HTTP status code of `301 Moved Permanently`." - ], - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Header": { - "description": "A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.", - "id": "Header", - "properties": { - "glob": { - "description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.", - "type": "string" - }, - "headers": { - "additionalProperties": { - "type": "string" - }, - "description": "Required. The additional headers to add to the response.", - "type": "object" - }, - "regex": { - "description": "The user-supplied RE2 regular expression to match against the request URL path.", - "type": "string" - } - }, - "type": "object" - }, - "I18nConfig": { - "description": "If provided, i18n rewrites are enabled.", - "id": "I18nConfig", - "properties": { - "root": { - "description": "Required. The user-supplied path where country and language specific content will be looked for within the public directory.", - "type": "string" - } - }, - "type": "object" - }, - "ListChannelsResponse": { - "description": "The response returned by ListChannels.", - "id": "ListChannelsResponse", - "properties": { - "channels": { - "description": "The list of channels.", - "items": { - "$ref": "Channel" - }, - "type": "array" - }, - "nextPageToken": { - "description": "If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.channels/list) call to continue with the next set of releases.", - "type": "string" - } - }, - "type": "object" - }, - "ListDomainsResponse": { - "description": "The response to listing Domains.", - "id": "ListDomainsResponse", - "properties": { - "domains": { - "description": "The list of domains, if any exist.", - "items": { - "$ref": "Domain" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The pagination token, if more results exist.", - "type": "string" - } - }, - "type": "object" - }, - "ListReleasesResponse": { - "id": "ListReleasesResponse", - "properties": { - "nextPageToken": { - "description": "If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases.", - "type": "string" - }, - "releases": { - "description": "The list of hashes of files that still need to be uploaded, if any exist.", - "items": { - "$ref": "Release" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListVersionFilesResponse": { - "id": "ListVersionFilesResponse", - "properties": { - "files": { - "description": "The list path/hashes in the specified version.", - "items": { - "$ref": "VersionFile" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The pagination token, if more results exist.", - "type": "string" - } - }, - "type": "object" - }, - "ListVersionsResponse": { - "id": "ListVersionsResponse", - "properties": { - "nextPageToken": { - "description": "The pagination token, if more results exist", - "type": "string" - }, - "versions": { - "description": "The list of versions, if any exist.", - "items": { - "$ref": "Version" - }, - "type": "array" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "PathFilter": { - "description": "A representation of filter path.", - "id": "PathFilter", - "properties": { - "regexes": { - "description": "An array of regexes to filter by.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "PopulateVersionFilesRequest": { - "description": "The request to populate a Version's Files.", - "id": "PopulateVersionFilesRequest", - "properties": { - "files": { - "additionalProperties": { - "type": "string" - }, - "description": "A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file.", - "type": "object" - } - }, - "type": "object" - }, - "PopulateVersionFilesResponse": { - "id": "PopulateVersionFilesResponse", - "properties": { - "uploadRequiredHashes": { - "description": "The content hashes of the specified files that need to be uploaded to the specified endpoint.", - "items": { - "type": "string" - }, - "type": "array" - }, - "uploadUrl": { - "description": "The URL to which the files should be uploaded, in the format: \"https://upload-firebasehosting.googleapis.com/upload/sites/site-name /versions/versionID/files\". Perform a multipart `POST` of the Gzipped file contents to the URL using a forward slash and the hash of the file appended to the end.", - "type": "string" - } - }, - "type": "object" - }, - "PreviewConfig": { - "description": "Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version.", - "id": "PreviewConfig", - "properties": { - "active": { - "description": "If true, preview URLs are enabled for this version.", - "type": "boolean" - }, - "expireTime": { - "description": "Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "Redirect": { - "description": "A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.", - "id": "Redirect", - "properties": { - "glob": { - "description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.", - "type": "string" - }, - "location": { - "description": "Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: \"glob\": \"/:capture*\", \"statusCode\": 301, \"location\": \"https://example.com/foo/:capture\"", - "type": "string" - }, - "regex": { - "description": "The user-supplied RE2 regular expression to match against the request URL path.", - "type": "string" - }, - "statusCode": { - "description": "Required. The status HTTP code to return in the response. It must be a valid 3xx status code.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Release": { - "description": "A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.", - "id": "Release", - "properties": { - "message": { - "description": "The deploy description when the release was created. The value can be up to 512 characters.", - "type": "string" - }, - "name": { - "description": "Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.", - "type": "string" - }, - "releaseTime": { - "description": "Output only. The time at which the version is set to be public.", - "format": "google-datetime", - "type": "string" - }, - "releaseUser": { - "$ref": "ActingUser", - "description": "Output only. Identifies the user who created the release." - }, - "type": { - "description": "Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.", - "enum": [ - "TYPE_UNSPECIFIED", - "DEPLOY", - "ROLLBACK", - "SITE_DISABLE" - ], - "enumDescriptions": [ - "An unspecified type. Indicates that a version was released. This is the default value when no other `type` is explicitly specified.", - "A version was uploaded to Firebase Hosting and released.", - "The release points back to a previously deployed version.", - "The release prevents the site from serving content. Firebase Hosting acts as if the site never existed." - ], - "type": "string" - }, - "version": { - "$ref": "Version", - "description": "Output only. The configuration and content that was released." - } - }, - "type": "object" - }, - "Rewrite": { - "description": "A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.", - "id": "Rewrite", - "properties": { - "dynamicLinks": { - "description": "The request will be forwarded to Firebase Dynamic Links.", - "type": "boolean" - }, - "function": { - "description": "The function to proxy requests to. Must match the exported function name exactly.", - "type": "string" - }, - "glob": { - "description": "The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.", - "type": "string" - }, - "path": { - "description": "The URL path to rewrite the request to.", - "type": "string" - }, - "regex": { - "description": "The user-supplied RE2 regular expression to match against the request URL path.", - "type": "string" - }, - "run": { - "$ref": "CloudRunRewrite", - "description": "The request will be forwarded to Cloud Run." - } - }, - "type": "object" - }, - "ServingConfig": { - "description": "The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order).", - "id": "ServingConfig", - "properties": { - "appAssociation": { - "description": "How to handle well known App Association files.", - "enum": [ - "AUTO", - "NONE" - ], - "enumDescriptions": [ - "The app association files will be automatically created from the apps that exist in the Firebase project.", - "No special handling of the app association files will occur, these paths will result in a 404 unless caught with a Rewrite." - ], - "type": "string" - }, - "cleanUrls": { - "description": "Defines whether to drop the file extension from uploaded files.", - "type": "boolean" - }, - "headers": { - "description": "An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.", - "items": { - "$ref": "Header" - }, - "type": "array" - }, - "i18n": { - "$ref": "I18nConfig", - "description": "Optional. Defines i18n rewrite behavior." - }, - "redirects": { - "description": "An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.", - "items": { - "$ref": "Redirect" - }, - "type": "array" - }, - "rewrites": { - "description": "An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.", - "items": { - "$ref": "Rewrite" - }, - "type": "array" - }, - "trailingSlashBehavior": { - "description": "Defines how to handle a trailing slash in the URL path.", - "enum": [ - "TRAILING_SLASH_BEHAVIOR_UNSPECIFIED", - "ADD", - "REMOVE" - ], - "enumDescriptions": [ - "No behavior is specified. Files are served at their exact location only, and trailing slashes are only added to directory indexes.", - "Trailing slashes are _added_ to directory indexes as well as to any URL path not ending in a file extension.", - "Trailing slashes are _removed_ from directory indexes as well as from any URL path not ending in a file extension." - ], - "type": "string" - } - }, - "type": "object" - }, - "SiteConfig": { - "description": "A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior", - "id": "SiteConfig", - "properties": { - "cloudLoggingEnabled": { - "description": "Whether or not web requests made by site visitors are logged via Cloud Logging.", - "type": "boolean" - }, - "maxVersions": { - "description": "The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "Version": { - "description": "A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.", - "id": "Version", - "properties": { - "config": { - "$ref": "ServingConfig", - "description": "The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file." - }, - "createTime": { - "description": "Output only. The time at which the version was created.", - "format": "google-datetime", - "type": "string" - }, - "createUser": { - "$ref": "ActingUser", - "description": "Output only. Identifies the user who created the version." - }, - "deleteTime": { - "description": "Output only. The time at which the version was `DELETED`.", - "format": "google-datetime", - "type": "string" - }, - "deleteUser": { - "$ref": "ActingUser", - "description": "Output only. Identifies the user who `DELETED` the version." - }, - "fileCount": { - "description": "Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.", - "format": "int64", - "type": "string" - }, - "finalizeTime": { - "description": "Output only. The time at which the version was `FINALIZED`.", - "format": "google-datetime", - "type": "string" - }, - "finalizeUser": { - "$ref": "ActingUser", - "description": "Output only. Identifies the user who `FINALIZED` the version." - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The labels used for extra metadata and/or filtering.", - "type": "object" - }, - "name": { - "description": "The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.", - "type": "string" - }, - "preview": { - "$ref": "PreviewConfig", - "description": "Version preview configuration for the site version. This configuration specfies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version." - }, - "status": { - "description": "The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.", - "enum": [ - "VERSION_STATUS_UNSPECIFIED", - "CREATED", - "FINALIZED", - "DELETED", - "ABANDONED", - "EXPIRED", - "CLONING" - ], - "enumDescriptions": [ - "The default status; should not be intentionally used.", - "The version has been created, and content is currently being added to the version.", - "All content has been added to the version, and the version can no longer be changed.", - "The version has been deleted.", - "The version was not updated to `FINALIZED` within 12 hours and was automatically deleted.", - "The version is outside the site-configured limit for the number of retained versions, so the version's content is scheduled for deletion.", - "The version is being cloned from another version. All content is still being copied over." - ], - "type": "string" - }, - "versionBytes": { - "description": "Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "VersionFile": { - "description": "A static content file that is part of a version.", - "id": "VersionFile", - "properties": { - "hash": { - "description": "The SHA256 content hash of the file.", - "type": "string" - }, - "path": { - "description": "The URI at which the file's content should display.", - "type": "string" - }, - "status": { - "description": "Output only. The current status of a particular file in the specified version. The value will be either `pending upload` or `uploaded`.", - "enum": [ - "STATUS_UNSPECIFIED", - "EXPECTED", - "ACTIVE" - ], - "enumDescriptions": [ - "The default status; should not be intentionally used.", - "The file has been included in the version and is expected to be uploaded in the near future.", - "The file has already been uploaded to Firebase Hosting." - ], - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Firebase Hosting API", - "version": "v1beta1", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/firebaseml__v1beta2.json b/discovery/googleapis_beta/firebaseml__v1beta2.json deleted file mode 100644 index 2479afa..0000000 --- a/discovery/googleapis_beta/firebaseml__v1beta2.json +++ /dev/null
@@ -1,505 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://firebaseml.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Firebase ML", - "description": "Access custom machine learning models hosted via Firebase ML.", - "discoveryVersion": "v1", - "documentationLink": "https://firebase.google.com", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "firebaseml:v1beta2", - "kind": "discovery#restDescription", - "name": "firebaseml", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "models": { - "methods": { - "create": { - "description": "Creates a model in Firebase ML. The longrunning operation will eventually return a Model", - "httpMethod": "POST", - "id": "firebaseml.projects.models.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent project resource where the model is to be created. The parent must have the form `projects/{project_id}`", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+parent}/models", - "request": { - "$ref": "Model" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a model", - "httpMethod": "DELETE", - "id": "firebaseml.projects.models.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the model to delete. The name must have the form `projects/{project_id}/models/{model_id}`", - "location": "path", - "pattern": "^projects/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a model resource.", - "httpMethod": "GET", - "id": "firebaseml.projects.models.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the model to get. The name must have the form `projects/{project_id}/models/{model_id}`", - "location": "path", - "pattern": "^projects/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "response": { - "$ref": "Model" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists the models", - "httpMethod": "GET", - "id": "firebaseml.projects.models.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "A filter for the list e.g. 'tags: abc' to list models which are tagged with \"abc\"", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous List request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The name of the parent to list models for. The parent must have the form `projects/{project_id}'", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+parent}/models", - "response": { - "$ref": "ListModelsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a model. The longrunning operation will eventually return a Model.", - "httpMethod": "PATCH", - "id": "firebaseml.projects.models.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.", - "location": "path", - "pattern": "^projects/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "The update mask", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "request": { - "$ref": "Model" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "firebaseml.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - }, - "revision": "20201007", - "rootUrl": "https://firebaseml.googleapis.com/", - "schemas": { - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "ListModelsResponse": { - "description": "The response for list models", - "id": "ListModelsResponse", - "properties": { - "models": { - "description": "The list of models", - "items": { - "$ref": "Model" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", - "type": "string" - } - }, - "type": "object" - }, - "Model": { - "description": "An ML model hosted in Firebase ML", - "id": "Model", - "properties": { - "activeOperations": { - "description": "Output only. Lists operation ids associated with this model whose status is NOT done.", - "items": { - "$ref": "Operation" - }, - "readOnly": true, - "type": "array" - }, - "createTime": { - "description": "Output only. Timestamp when this model was created in Firebase ML.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter.", - "type": "string" - }, - "etag": { - "description": "Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3", - "readOnly": true, - "type": "string" - }, - "modelHash": { - "description": "Output only. The model_hash will change if a new file is available for download.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model.", - "type": "string" - }, - "state": { - "$ref": "ModelState", - "description": "State common to all model types. Includes publishing and validation information." - }, - "tags": { - "description": "User defined tags which can be used to group/filter models during listing", - "items": { - "type": "string" - }, - "type": "array" - }, - "tfliteModel": { - "$ref": "TfLiteModel", - "description": "A TFLite Model" - }, - "updateTime": { - "description": "Output only. Timestamp when this model was updated in Firebase ML.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "ModelOperationMetadata": { - "description": "This is returned in the longrunning operations for create/update.", - "id": "ModelOperationMetadata", - "properties": { - "basicOperationStatus": { - "enum": [ - "BASIC_OPERATION_STATUS_UNSPECIFIED", - "BASIC_OPERATION_STATUS_UPLOADING", - "BASIC_OPERATION_STATUS_VERIFYING" - ], - "enumDescriptions": [ - "The status is unspecified", - "The model file is being uploaded", - "The model file is being verified" - ], - "type": "string" - }, - "name": { - "description": "The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}`", - "type": "string" - } - }, - "type": "object" - }, - "ModelState": { - "description": "State common to all model types. Includes publishing and validation information.", - "id": "ModelState", - "properties": { - "published": { - "description": "Indicates if this model has been published.", - "type": "boolean" - }, - "validationError": { - "$ref": "Status", - "description": "Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models.", - "readOnly": true - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "TfLiteModel": { - "description": "Information that is specific to TfLite models.", - "id": "TfLiteModel", - "properties": { - "automlModel": { - "description": "The AutoML model id referencing a model you created with the AutoML API. The name should have format 'projects//locations//models/' (This is the model resource name returned from the AutoML API)", - "type": "string" - }, - "gcsTfliteUri": { - "description": "The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file.", - "type": "string" - }, - "sizeBytes": { - "description": "Output only. The size of the TFLite model", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Firebase ML API", - "version": "v1beta2", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/language__v1beta1.json b/discovery/googleapis_beta/language__v1beta1.json deleted file mode 100644 index c95b22f..0000000 --- a/discovery/googleapis_beta/language__v1beta1.json +++ /dev/null
@@ -1,1094 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-language": { - "description": "Apply machine learning models to reveal the structure and meaning of text" - }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://language.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud Natural Language", - "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/natural-language/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "language:v1beta1", - "kind": "discovery#restDescription", - "name": "language", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "documents": { - "methods": { - "analyzeEntities": { - "description": "Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.", - "httpMethod": "POST", - "id": "language.documents.analyzeEntities", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta1/documents:analyzeEntities", - "request": { - "$ref": "AnalyzeEntitiesRequest" - }, - "response": { - "$ref": "AnalyzeEntitiesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "analyzeSentiment": { - "description": "Analyzes the sentiment of the provided text.", - "httpMethod": "POST", - "id": "language.documents.analyzeSentiment", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta1/documents:analyzeSentiment", - "request": { - "$ref": "AnalyzeSentimentRequest" - }, - "response": { - "$ref": "AnalyzeSentimentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "analyzeSyntax": { - "description": "Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.", - "httpMethod": "POST", - "id": "language.documents.analyzeSyntax", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta1/documents:analyzeSyntax", - "request": { - "$ref": "AnalyzeSyntaxRequest" - }, - "response": { - "$ref": "AnalyzeSyntaxResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "annotateText": { - "description": "A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.", - "httpMethod": "POST", - "id": "language.documents.annotateText", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta1/documents:annotateText", - "request": { - "$ref": "AnnotateTextRequest" - }, - "response": { - "$ref": "AnnotateTextResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - }, - "revision": "20200919", - "rootUrl": "https://language.googleapis.com/", - "schemas": { - "AnalyzeEntitiesRequest": { - "description": "The entity analysis request message.", - "id": "AnalyzeEntitiesRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeEntitiesResponse": { - "description": "The entity analysis response message.", - "id": "AnalyzeEntitiesResponse", - "properties": { - "entities": { - "description": "The recognized entities in the input document.", - "items": { - "$ref": "Entity" - }, - "type": "array" - }, - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeSentimentRequest": { - "description": "The sentiment analysis request message.", - "id": "AnalyzeSentimentRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate sentence offsets for the sentence sentiment.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeSentimentResponse": { - "description": "The sentiment analysis response message.", - "id": "AnalyzeSentimentResponse", - "properties": { - "documentSentiment": { - "$ref": "Sentiment", - "description": "The overall sentiment of the input document." - }, - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "The sentiment for all the sentences in the document.", - "items": { - "$ref": "Sentence" - }, - "type": "array" - } - }, - "type": "object" - }, - "AnalyzeSyntaxRequest": { - "description": "The syntax analysis request message.", - "id": "AnalyzeSyntaxRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeSyntaxResponse": { - "description": "The syntax analysis response message.", - "id": "AnalyzeSyntaxResponse", - "properties": { - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "Sentences in the input document.", - "items": { - "$ref": "Sentence" - }, - "type": "array" - }, - "tokens": { - "description": "Tokens, along with their syntactic information, in the input document.", - "items": { - "$ref": "Token" - }, - "type": "array" - } - }, - "type": "object" - }, - "AnnotateTextRequest": { - "description": "The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.", - "id": "AnnotateTextRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and Javascript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - }, - "features": { - "$ref": "Features", - "description": "The enabled features." - } - }, - "type": "object" - }, - "AnnotateTextResponse": { - "description": "The text annotations response message.", - "id": "AnnotateTextResponse", - "properties": { - "documentSentiment": { - "$ref": "Sentiment", - "description": "The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment." - }, - "entities": { - "description": "Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.", - "items": { - "$ref": "Entity" - }, - "type": "array" - }, - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.", - "items": { - "$ref": "Sentence" - }, - "type": "array" - }, - "tokens": { - "description": "Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.", - "items": { - "$ref": "Token" - }, - "type": "array" - } - }, - "type": "object" - }, - "DependencyEdge": { - "description": "Represents dependency parse tree information for a token.", - "id": "DependencyEdge", - "properties": { - "headTokenIndex": { - "description": "Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index.", - "format": "int32", - "type": "integer" - }, - "label": { - "description": "The parse label for the token.", - "enum": [ - "UNKNOWN", - "ABBREV", - "ACOMP", - "ADVCL", - "ADVMOD", - "AMOD", - "APPOS", - "ATTR", - "AUX", - "AUXPASS", - "CC", - "CCOMP", - "CONJ", - "CSUBJ", - "CSUBJPASS", - "DEP", - "DET", - "DISCOURSE", - "DOBJ", - "EXPL", - "GOESWITH", - "IOBJ", - "MARK", - "MWE", - "MWV", - "NEG", - "NN", - "NPADVMOD", - "NSUBJ", - "NSUBJPASS", - "NUM", - "NUMBER", - "P", - "PARATAXIS", - "PARTMOD", - "PCOMP", - "POBJ", - "POSS", - "POSTNEG", - "PRECOMP", - "PRECONJ", - "PREDET", - "PREF", - "PREP", - "PRONL", - "PRT", - "PS", - "QUANTMOD", - "RCMOD", - "RCMODREL", - "RDROP", - "REF", - "REMNANT", - "REPARANDUM", - "ROOT", - "SNUM", - "SUFF", - "TMOD", - "TOPIC", - "VMOD", - "VOCATIVE", - "XCOMP", - "SUFFIX", - "TITLE", - "ADVPHMOD", - "AUXCAUS", - "AUXVV", - "DTMOD", - "FOREIGN", - "KW", - "LIST", - "NOMC", - "NOMCSUBJ", - "NOMCSUBJPASS", - "NUMC", - "COP", - "DISLOCATED", - "ASP", - "GMOD", - "GOBJ", - "INFMOD", - "MES", - "NCOMP" - ], - "enumDescriptions": [ - "Unknown", - "Abbreviation modifier", - "Adjectival complement", - "Adverbial clause modifier", - "Adverbial modifier", - "Adjectival modifier of an NP", - "Appositional modifier of an NP", - "Attribute dependent of a copular verb", - "Auxiliary (non-main) verb", - "Passive auxiliary", - "Coordinating conjunction", - "Clausal complement of a verb or adjective", - "Conjunct", - "Clausal subject", - "Clausal passive subject", - "Dependency (unable to determine)", - "Determiner", - "Discourse", - "Direct object", - "Expletive", - "Goes with (part of a word in a text not well edited)", - "Indirect object", - "Marker (word introducing a subordinate clause)", - "Multi-word expression", - "Multi-word verbal expression", - "Negation modifier", - "Noun compound modifier", - "Noun phrase used as an adverbial modifier", - "Nominal subject", - "Passive nominal subject", - "Numeric modifier of a noun", - "Element of compound number", - "Punctuation mark", - "Parataxis relation", - "Participial modifier", - "The complement of a preposition is a clause", - "Object of a preposition", - "Possession modifier", - "Postverbal negative particle", - "Predicate complement", - "Preconjunt", - "Predeterminer", - "Prefix", - "Prepositional modifier", - "The relationship between a verb and verbal morpheme", - "Particle", - "Associative or possessive marker", - "Quantifier phrase modifier", - "Relative clause modifier", - "Complementizer in relative clause", - "Ellipsis without a preceding predicate", - "Referent", - "Remnant", - "Reparandum", - "Root", - "Suffix specifying a unit of number", - "Suffix", - "Temporal modifier", - "Topic marker", - "Clause headed by an infinite form of the verb that modifies a noun", - "Vocative", - "Open clausal complement", - "Name suffix", - "Name title", - "Adverbial phrase modifier", - "Causative auxiliary", - "Helper auxiliary", - "Rentaishi (Prenominal modifier)", - "Foreign words", - "Keyword", - "List for chains of comparable items", - "Nominalized clause", - "Nominalized clausal subject", - "Nominalized clausal passive", - "Compound of numeric modifier", - "Copula", - "Dislocated relation (for fronted/topicalized elements)", - "Aspect marker", - "Genitive modifier", - "Genitive object", - "Infinitival modifier", - "Measure", - "Nominal complement of a noun" - ], - "type": "string" - } - }, - "type": "object" - }, - "Document": { - "description": "################################################################ # Represents the input to API methods.", - "id": "Document", - "properties": { - "content": { - "description": "The content of the input in string format. Cloud audit logging exempt since it is based on user data.", - "type": "string" - }, - "gcsContentUri": { - "description": "The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.", - "type": "string" - }, - "language": { - "description": "The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. [Language Support](https://cloud.google.com/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned.", - "type": "string" - }, - "type": { - "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.", - "enum": [ - "TYPE_UNSPECIFIED", - "PLAIN_TEXT", - "HTML" - ], - "enumDescriptions": [ - "The content type is not specified.", - "Plain text", - "HTML" - ], - "type": "string" - } - }, - "type": "object" - }, - "Entity": { - "description": "Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.", - "id": "Entity", - "properties": { - "mentions": { - "description": "The mentions of this entity in the input document. The API currently supports proper noun mentions.", - "items": { - "$ref": "EntityMention" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Metadata associated with the entity. Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if available. The associated keys are \"wikipedia_url\" and \"mid\", respectively.", - "type": "object" - }, - "name": { - "description": "The representative name for the entity.", - "type": "string" - }, - "salience": { - "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", - "format": "float", - "type": "number" - }, - "type": { - "description": "The entity type.", - "enum": [ - "UNKNOWN", - "PERSON", - "LOCATION", - "ORGANIZATION", - "EVENT", - "WORK_OF_ART", - "CONSUMER_GOOD", - "OTHER" - ], - "enumDescriptions": [ - "Unknown", - "Person", - "Location", - "Organization", - "Event", - "Work of art", - "Consumer goods", - "Other types" - ], - "type": "string" - } - }, - "type": "object" - }, - "EntityMention": { - "description": "Represents a mention for an entity in the text. Currently, proper noun mentions are supported.", - "id": "EntityMention", - "properties": { - "text": { - "$ref": "TextSpan", - "description": "The mention text." - }, - "type": { - "description": "The type of the entity mention.", - "enum": [ - "TYPE_UNKNOWN", - "PROPER", - "COMMON" - ], - "enumDescriptions": [ - "Unknown", - "Proper name", - "Common noun (or noun compound)" - ], - "type": "string" - } - }, - "type": "object" - }, - "Features": { - "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.", - "id": "Features", - "properties": { - "extractDocumentSentiment": { - "description": "Extract document-level sentiment.", - "type": "boolean" - }, - "extractEntities": { - "description": "Extract entities.", - "type": "boolean" - }, - "extractSyntax": { - "description": "Extract syntax information.", - "type": "boolean" - } - }, - "type": "object" - }, - "PartOfSpeech": { - "description": "Represents part of speech information for a token.", - "id": "PartOfSpeech", - "properties": { - "aspect": { - "description": "The grammatical aspect.", - "enum": [ - "ASPECT_UNKNOWN", - "PERFECTIVE", - "IMPERFECTIVE", - "PROGRESSIVE" - ], - "enumDescriptions": [ - "Aspect is not applicable in the analyzed language or is not predicted.", - "Perfective", - "Imperfective", - "Progressive" - ], - "type": "string" - }, - "case": { - "description": "The grammatical case.", - "enum": [ - "CASE_UNKNOWN", - "ACCUSATIVE", - "ADVERBIAL", - "COMPLEMENTIVE", - "DATIVE", - "GENITIVE", - "INSTRUMENTAL", - "LOCATIVE", - "NOMINATIVE", - "OBLIQUE", - "PARTITIVE", - "PREPOSITIONAL", - "REFLEXIVE_CASE", - "RELATIVE_CASE", - "VOCATIVE" - ], - "enumDescriptions": [ - "Case is not applicable in the analyzed language or is not predicted.", - "Accusative", - "Adverbial", - "Complementive", - "Dative", - "Genitive", - "Instrumental", - "Locative", - "Nominative", - "Oblique", - "Partitive", - "Prepositional", - "Reflexive", - "Relative", - "Vocative" - ], - "type": "string" - }, - "form": { - "description": "The grammatical form.", - "enum": [ - "FORM_UNKNOWN", - "ADNOMIAL", - "AUXILIARY", - "COMPLEMENTIZER", - "FINAL_ENDING", - "GERUND", - "REALIS", - "IRREALIS", - "SHORT", - "LONG", - "ORDER", - "SPECIFIC" - ], - "enumDescriptions": [ - "Form is not applicable in the analyzed language or is not predicted.", - "Adnomial", - "Auxiliary", - "Complementizer", - "Final ending", - "Gerund", - "Realis", - "Irrealis", - "Short form", - "Long form", - "Order form", - "Specific form" - ], - "type": "string" - }, - "gender": { - "description": "The grammatical gender.", - "enum": [ - "GENDER_UNKNOWN", - "FEMININE", - "MASCULINE", - "NEUTER" - ], - "enumDescriptions": [ - "Gender is not applicable in the analyzed language or is not predicted.", - "Feminine", - "Masculine", - "Neuter" - ], - "type": "string" - }, - "mood": { - "description": "The grammatical mood.", - "enum": [ - "MOOD_UNKNOWN", - "CONDITIONAL_MOOD", - "IMPERATIVE", - "INDICATIVE", - "INTERROGATIVE", - "JUSSIVE", - "SUBJUNCTIVE" - ], - "enumDescriptions": [ - "Mood is not applicable in the analyzed language or is not predicted.", - "Conditional", - "Imperative", - "Indicative", - "Interrogative", - "Jussive", - "Subjunctive" - ], - "type": "string" - }, - "number": { - "description": "The grammatical number.", - "enum": [ - "NUMBER_UNKNOWN", - "SINGULAR", - "PLURAL", - "DUAL" - ], - "enumDescriptions": [ - "Number is not applicable in the analyzed language or is not predicted.", - "Singular", - "Plural", - "Dual" - ], - "type": "string" - }, - "person": { - "description": "The grammatical person.", - "enum": [ - "PERSON_UNKNOWN", - "FIRST", - "SECOND", - "THIRD", - "REFLEXIVE_PERSON" - ], - "enumDescriptions": [ - "Person is not applicable in the analyzed language or is not predicted.", - "First", - "Second", - "Third", - "Reflexive" - ], - "type": "string" - }, - "proper": { - "description": "The grammatical properness.", - "enum": [ - "PROPER_UNKNOWN", - "PROPER", - "NOT_PROPER" - ], - "enumDescriptions": [ - "Proper is not applicable in the analyzed language or is not predicted.", - "Proper", - "Not proper" - ], - "type": "string" - }, - "reciprocity": { - "description": "The grammatical reciprocity.", - "enum": [ - "RECIPROCITY_UNKNOWN", - "RECIPROCAL", - "NON_RECIPROCAL" - ], - "enumDescriptions": [ - "Reciprocity is not applicable in the analyzed language or is not predicted.", - "Reciprocal", - "Non-reciprocal" - ], - "type": "string" - }, - "tag": { - "description": "The part of speech tag.", - "enum": [ - "UNKNOWN", - "ADJ", - "ADP", - "ADV", - "CONJ", - "DET", - "NOUN", - "NUM", - "PRON", - "PRT", - "PUNCT", - "VERB", - "X", - "AFFIX" - ], - "enumDescriptions": [ - "Unknown", - "Adjective", - "Adposition (preposition and postposition)", - "Adverb", - "Conjunction", - "Determiner", - "Noun (common and proper)", - "Cardinal number", - "Pronoun", - "Particle or other function word", - "Punctuation", - "Verb (all tenses and modes)", - "Other: foreign words, typos, abbreviations", - "Affix" - ], - "type": "string" - }, - "tense": { - "description": "The grammatical tense.", - "enum": [ - "TENSE_UNKNOWN", - "CONDITIONAL_TENSE", - "FUTURE", - "PAST", - "PRESENT", - "IMPERFECT", - "PLUPERFECT" - ], - "enumDescriptions": [ - "Tense is not applicable in the analyzed language or is not predicted.", - "Conditional", - "Future", - "Past", - "Present", - "Imperfect", - "Pluperfect" - ], - "type": "string" - }, - "voice": { - "description": "The grammatical voice.", - "enum": [ - "VOICE_UNKNOWN", - "ACTIVE", - "CAUSATIVE", - "PASSIVE" - ], - "enumDescriptions": [ - "Voice is not applicable in the analyzed language or is not predicted.", - "Active", - "Causative", - "Passive" - ], - "type": "string" - } - }, - "type": "object" - }, - "Sentence": { - "description": "Represents a sentence in the input document.", - "id": "Sentence", - "properties": { - "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence." - }, - "text": { - "$ref": "TextSpan", - "description": "The sentence text." - } - }, - "type": "object" - }, - "Sentiment": { - "description": "Represents the feeling associated with the entire text or entities in the text.", - "id": "Sentiment", - "properties": { - "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).", - "format": "float", - "type": "number" - }, - "polarity": { - "description": "DEPRECATED FIELD - This field is being deprecated in favor of score. Please refer to our documentation at https://cloud.google.com/natural-language/docs for more information.", - "format": "float", - "type": "number" - }, - "score": { - "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "TextSpan": { - "description": "Represents an output piece of text.", - "id": "TextSpan", - "properties": { - "beginOffset": { - "description": "The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.", - "format": "int32", - "type": "integer" - }, - "content": { - "description": "The content of the output text.", - "type": "string" - } - }, - "type": "object" - }, - "Token": { - "description": "Represents the smallest syntactic building block of the text.", - "id": "Token", - "properties": { - "dependencyEdge": { - "$ref": "DependencyEdge", - "description": "Dependency tree parse for this token." - }, - "lemma": { - "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.", - "type": "string" - }, - "partOfSpeech": { - "$ref": "PartOfSpeech", - "description": "Parts of speech tag for this token." - }, - "text": { - "$ref": "TextSpan", - "description": "The token text." - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Natural Language API", - "version": "v1beta1", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/language__v1beta2.json b/discovery/googleapis_beta/language__v1beta2.json deleted file mode 100644 index bf65388..0000000 --- a/discovery/googleapis_beta/language__v1beta2.json +++ /dev/null
@@ -1,1262 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-language": { - "description": "Apply machine learning models to reveal the structure and meaning of text" - }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://language.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud Natural Language", - "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/natural-language/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "language:v1beta2", - "kind": "discovery#restDescription", - "name": "language", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "documents": { - "methods": { - "analyzeEntities": { - "description": "Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.", - "httpMethod": "POST", - "id": "language.documents.analyzeEntities", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta2/documents:analyzeEntities", - "request": { - "$ref": "AnalyzeEntitiesRequest" - }, - "response": { - "$ref": "AnalyzeEntitiesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "analyzeEntitySentiment": { - "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.", - "httpMethod": "POST", - "id": "language.documents.analyzeEntitySentiment", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta2/documents:analyzeEntitySentiment", - "request": { - "$ref": "AnalyzeEntitySentimentRequest" - }, - "response": { - "$ref": "AnalyzeEntitySentimentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "analyzeSentiment": { - "description": "Analyzes the sentiment of the provided text.", - "httpMethod": "POST", - "id": "language.documents.analyzeSentiment", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta2/documents:analyzeSentiment", - "request": { - "$ref": "AnalyzeSentimentRequest" - }, - "response": { - "$ref": "AnalyzeSentimentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "analyzeSyntax": { - "description": "Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.", - "httpMethod": "POST", - "id": "language.documents.analyzeSyntax", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta2/documents:analyzeSyntax", - "request": { - "$ref": "AnalyzeSyntaxRequest" - }, - "response": { - "$ref": "AnalyzeSyntaxResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "annotateText": { - "description": "A convenience method that provides all syntax, sentiment, entity, and classification features in one call.", - "httpMethod": "POST", - "id": "language.documents.annotateText", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta2/documents:annotateText", - "request": { - "$ref": "AnnotateTextRequest" - }, - "response": { - "$ref": "AnnotateTextResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "classifyText": { - "description": "Classifies a document into categories.", - "httpMethod": "POST", - "id": "language.documents.classifyText", - "parameterOrder": [], - "parameters": {}, - "path": "v1beta2/documents:classifyText", - "request": { - "$ref": "ClassifyTextRequest" - }, - "response": { - "$ref": "ClassifyTextResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - }, - "revision": "20200919", - "rootUrl": "https://language.googleapis.com/", - "schemas": { - "AnalyzeEntitiesRequest": { - "description": "The entity analysis request message.", - "id": "AnalyzeEntitiesRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Required. Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeEntitiesResponse": { - "description": "The entity analysis response message.", - "id": "AnalyzeEntitiesResponse", - "properties": { - "entities": { - "description": "The recognized entities in the input document.", - "items": { - "$ref": "Entity" - }, - "type": "array" - }, - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeEntitySentimentRequest": { - "description": "The entity-level sentiment analysis request message.", - "id": "AnalyzeEntitySentimentRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Required. Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeEntitySentimentResponse": { - "description": "The entity-level sentiment analysis response message.", - "id": "AnalyzeEntitySentimentResponse", - "properties": { - "entities": { - "description": "The recognized entities in the input document with associated sentiments.", - "items": { - "$ref": "Entity" - }, - "type": "array" - }, - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeSentimentRequest": { - "description": "The sentiment analysis request message.", - "id": "AnalyzeSentimentRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Required. Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate sentence offsets for the sentence sentiment.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeSentimentResponse": { - "description": "The sentiment analysis response message.", - "id": "AnalyzeSentimentResponse", - "properties": { - "documentSentiment": { - "$ref": "Sentiment", - "description": "The overall sentiment of the input document." - }, - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "The sentiment for all the sentences in the document.", - "items": { - "$ref": "Sentence" - }, - "type": "array" - } - }, - "type": "object" - }, - "AnalyzeSyntaxRequest": { - "description": "The syntax analysis request message.", - "id": "AnalyzeSyntaxRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Required. Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - } - }, - "type": "object" - }, - "AnalyzeSyntaxResponse": { - "description": "The syntax analysis response message.", - "id": "AnalyzeSyntaxResponse", - "properties": { - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "Sentences in the input document.", - "items": { - "$ref": "Sentence" - }, - "type": "array" - }, - "tokens": { - "description": "Tokens, along with their syntactic information, in the input document.", - "items": { - "$ref": "Token" - }, - "type": "array" - } - }, - "type": "object" - }, - "AnnotateTextRequest": { - "description": "The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.", - "id": "AnnotateTextRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Required. Input document." - }, - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively." - ], - "type": "string" - }, - "features": { - "$ref": "Features", - "description": "Required. The enabled features." - } - }, - "type": "object" - }, - "AnnotateTextResponse": { - "description": "The text annotations response message.", - "id": "AnnotateTextResponse", - "properties": { - "categories": { - "description": "Categories identified in the input document.", - "items": { - "$ref": "ClassificationCategory" - }, - "type": "array" - }, - "documentSentiment": { - "$ref": "Sentiment", - "description": "The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment." - }, - "entities": { - "description": "Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.", - "items": { - "$ref": "Entity" - }, - "type": "array" - }, - "language": { - "description": "The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.", - "items": { - "$ref": "Sentence" - }, - "type": "array" - }, - "tokens": { - "description": "Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.", - "items": { - "$ref": "Token" - }, - "type": "array" - } - }, - "type": "object" - }, - "ClassificationCategory": { - "description": "Represents a category returned from the text classifier.", - "id": "ClassificationCategory", - "properties": { - "confidence": { - "description": "The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.", - "format": "float", - "type": "number" - }, - "name": { - "description": "The name of the category representing the document, from the [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).", - "type": "string" - } - }, - "type": "object" - }, - "ClassifyTextRequest": { - "description": "The document classification request message.", - "id": "ClassifyTextRequest", - "properties": { - "document": { - "$ref": "Document", - "description": "Required. Input document." - } - }, - "type": "object" - }, - "ClassifyTextResponse": { - "description": "The document classification response message.", - "id": "ClassifyTextResponse", - "properties": { - "categories": { - "description": "Categories representing the input document.", - "items": { - "$ref": "ClassificationCategory" - }, - "type": "array" - } - }, - "type": "object" - }, - "DependencyEdge": { - "description": "Represents dependency parse tree information for a token.", - "id": "DependencyEdge", - "properties": { - "headTokenIndex": { - "description": "Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the `head_token_index` is its own index.", - "format": "int32", - "type": "integer" - }, - "label": { - "description": "The parse label for the token.", - "enum": [ - "UNKNOWN", - "ABBREV", - "ACOMP", - "ADVCL", - "ADVMOD", - "AMOD", - "APPOS", - "ATTR", - "AUX", - "AUXPASS", - "CC", - "CCOMP", - "CONJ", - "CSUBJ", - "CSUBJPASS", - "DEP", - "DET", - "DISCOURSE", - "DOBJ", - "EXPL", - "GOESWITH", - "IOBJ", - "MARK", - "MWE", - "MWV", - "NEG", - "NN", - "NPADVMOD", - "NSUBJ", - "NSUBJPASS", - "NUM", - "NUMBER", - "P", - "PARATAXIS", - "PARTMOD", - "PCOMP", - "POBJ", - "POSS", - "POSTNEG", - "PRECOMP", - "PRECONJ", - "PREDET", - "PREF", - "PREP", - "PRONL", - "PRT", - "PS", - "QUANTMOD", - "RCMOD", - "RCMODREL", - "RDROP", - "REF", - "REMNANT", - "REPARANDUM", - "ROOT", - "SNUM", - "SUFF", - "TMOD", - "TOPIC", - "VMOD", - "VOCATIVE", - "XCOMP", - "SUFFIX", - "TITLE", - "ADVPHMOD", - "AUXCAUS", - "AUXVV", - "DTMOD", - "FOREIGN", - "KW", - "LIST", - "NOMC", - "NOMCSUBJ", - "NOMCSUBJPASS", - "NUMC", - "COP", - "DISLOCATED", - "ASP", - "GMOD", - "GOBJ", - "INFMOD", - "MES", - "NCOMP" - ], - "enumDescriptions": [ - "Unknown", - "Abbreviation modifier", - "Adjectival complement", - "Adverbial clause modifier", - "Adverbial modifier", - "Adjectival modifier of an NP", - "Appositional modifier of an NP", - "Attribute dependent of a copular verb", - "Auxiliary (non-main) verb", - "Passive auxiliary", - "Coordinating conjunction", - "Clausal complement of a verb or adjective", - "Conjunct", - "Clausal subject", - "Clausal passive subject", - "Dependency (unable to determine)", - "Determiner", - "Discourse", - "Direct object", - "Expletive", - "Goes with (part of a word in a text not well edited)", - "Indirect object", - "Marker (word introducing a subordinate clause)", - "Multi-word expression", - "Multi-word verbal expression", - "Negation modifier", - "Noun compound modifier", - "Noun phrase used as an adverbial modifier", - "Nominal subject", - "Passive nominal subject", - "Numeric modifier of a noun", - "Element of compound number", - "Punctuation mark", - "Parataxis relation", - "Participial modifier", - "The complement of a preposition is a clause", - "Object of a preposition", - "Possession modifier", - "Postverbal negative particle", - "Predicate complement", - "Preconjunt", - "Predeterminer", - "Prefix", - "Prepositional modifier", - "The relationship between a verb and verbal morpheme", - "Particle", - "Associative or possessive marker", - "Quantifier phrase modifier", - "Relative clause modifier", - "Complementizer in relative clause", - "Ellipsis without a preceding predicate", - "Referent", - "Remnant", - "Reparandum", - "Root", - "Suffix specifying a unit of number", - "Suffix", - "Temporal modifier", - "Topic marker", - "Clause headed by an infinite form of the verb that modifies a noun", - "Vocative", - "Open clausal complement", - "Name suffix", - "Name title", - "Adverbial phrase modifier", - "Causative auxiliary", - "Helper auxiliary", - "Rentaishi (Prenominal modifier)", - "Foreign words", - "Keyword", - "List for chains of comparable items", - "Nominalized clause", - "Nominalized clausal subject", - "Nominalized clausal passive", - "Compound of numeric modifier", - "Copula", - "Dislocated relation (for fronted/topicalized elements)", - "Aspect marker", - "Genitive modifier", - "Genitive object", - "Infinitival modifier", - "Measure", - "Nominal complement of a noun" - ], - "type": "string" - } - }, - "type": "object" - }, - "Document": { - "description": "################################################################ # Represents the input to API methods.", - "id": "Document", - "properties": { - "boilerplateHandling": { - "description": "Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.", - "enum": [ - "BOILERPLATE_HANDLING_UNSPECIFIED", - "SKIP_BOILERPLATE", - "KEEP_BOILERPLATE" - ], - "enumDescriptions": [ - "The boilerplate handling is not specified.", - "Do not analyze detected boilerplate. Reference web URI is required for detecting boilerplate.", - "Treat boilerplate the same as content." - ], - "type": "string" - }, - "content": { - "description": "The content of the input in string format. Cloud audit logging exempt since it is based on user data.", - "type": "string" - }, - "gcsContentUri": { - "description": "The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.", - "type": "string" - }, - "language": { - "description": "The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. [Language Support](https://cloud.google.com/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned.", - "type": "string" - }, - "referenceWebUri": { - "description": "The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document.", - "type": "string" - }, - "type": { - "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.", - "enum": [ - "TYPE_UNSPECIFIED", - "PLAIN_TEXT", - "HTML" - ], - "enumDescriptions": [ - "The content type is not specified.", - "Plain text", - "HTML" - ], - "type": "string" - } - }, - "type": "object" - }, - "Entity": { - "description": "Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.", - "id": "Entity", - "properties": { - "mentions": { - "description": "The mentions of this entity in the input document. The API currently supports proper noun mentions.", - "items": { - "$ref": "EntityMention" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Metadata associated with the entity. For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are available. For the metadata associated with other entity types, see the Type table below.", - "type": "object" - }, - "name": { - "description": "The representative name for the entity.", - "type": "string" - }, - "salience": { - "description": "The salience score associated with the entity in the [0, 1.0] range. The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.", - "format": "float", - "type": "number" - }, - "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document." - }, - "type": { - "description": "The entity type.", - "enum": [ - "UNKNOWN", - "PERSON", - "LOCATION", - "ORGANIZATION", - "EVENT", - "WORK_OF_ART", - "CONSUMER_GOOD", - "OTHER", - "PHONE_NUMBER", - "ADDRESS", - "DATE", - "NUMBER", - "PRICE" - ], - "enumDescriptions": [ - "Unknown", - "Person", - "Location", - "Organization", - "Event", - "Artwork", - "Consumer product", - "Other types of entities", - "Phone number The metadata lists the phone number, formatted according to local convention, plus whichever additional elements appear in the text: * `number` - the actual number, broken down into sections as per local convention * `national_prefix` - country code, if detected * `area_code` - region or area code, if detected * `extension` - phone extension (to be dialed after connection), if detected", - "Address The metadata identifies the street number and locality plus whichever additional elements appear in the text: * `street_number` - street number * `locality` - city or town * `street_name` - street/route name, if detected * `postal_code` - postal code, if detected * `country` - country, if detected< * `broad_region` - administrative area, such as the state, if detected * `narrow_region` - smaller administrative area, such as county, if detected * `sublocality` - used in Asian addresses to demark a district within a city, if detected", - "Date The metadata identifies the components of the date: * `year` - four digit year, if detected * `month` - two digit month number, if detected * `day` - two digit day number, if detected", - "Number The metadata is the number itself.", - "Price The metadata identifies the `value` and `currency`." - ], - "type": "string" - } - }, - "type": "object" - }, - "EntityMention": { - "description": "Represents a mention for an entity in the text. Currently, proper noun mentions are supported.", - "id": "EntityMention", - "properties": { - "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document." - }, - "text": { - "$ref": "TextSpan", - "description": "The mention text." - }, - "type": { - "description": "The type of the entity mention.", - "enum": [ - "TYPE_UNKNOWN", - "PROPER", - "COMMON" - ], - "enumDescriptions": [ - "Unknown", - "Proper name", - "Common noun (or noun compound)" - ], - "type": "string" - } - }, - "type": "object" - }, - "Features": { - "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 10", - "id": "Features", - "properties": { - "classifyText": { - "description": "Classify the full document into categories. If this is true, the API will use the default model which classifies into a [predefined taxonomy](https://cloud.google.com/natural-language/docs/categories).", - "type": "boolean" - }, - "extractDocumentSentiment": { - "description": "Extract document-level sentiment.", - "type": "boolean" - }, - "extractEntities": { - "description": "Extract entities.", - "type": "boolean" - }, - "extractEntitySentiment": { - "description": "Extract entities and their associated sentiment.", - "type": "boolean" - }, - "extractSyntax": { - "description": "Extract syntax information.", - "type": "boolean" - } - }, - "type": "object" - }, - "PartOfSpeech": { - "description": "Represents part of speech information for a token.", - "id": "PartOfSpeech", - "properties": { - "aspect": { - "description": "The grammatical aspect.", - "enum": [ - "ASPECT_UNKNOWN", - "PERFECTIVE", - "IMPERFECTIVE", - "PROGRESSIVE" - ], - "enumDescriptions": [ - "Aspect is not applicable in the analyzed language or is not predicted.", - "Perfective", - "Imperfective", - "Progressive" - ], - "type": "string" - }, - "case": { - "description": "The grammatical case.", - "enum": [ - "CASE_UNKNOWN", - "ACCUSATIVE", - "ADVERBIAL", - "COMPLEMENTIVE", - "DATIVE", - "GENITIVE", - "INSTRUMENTAL", - "LOCATIVE", - "NOMINATIVE", - "OBLIQUE", - "PARTITIVE", - "PREPOSITIONAL", - "REFLEXIVE_CASE", - "RELATIVE_CASE", - "VOCATIVE" - ], - "enumDescriptions": [ - "Case is not applicable in the analyzed language or is not predicted.", - "Accusative", - "Adverbial", - "Complementive", - "Dative", - "Genitive", - "Instrumental", - "Locative", - "Nominative", - "Oblique", - "Partitive", - "Prepositional", - "Reflexive", - "Relative", - "Vocative" - ], - "type": "string" - }, - "form": { - "description": "The grammatical form.", - "enum": [ - "FORM_UNKNOWN", - "ADNOMIAL", - "AUXILIARY", - "COMPLEMENTIZER", - "FINAL_ENDING", - "GERUND", - "REALIS", - "IRREALIS", - "SHORT", - "LONG", - "ORDER", - "SPECIFIC" - ], - "enumDescriptions": [ - "Form is not applicable in the analyzed language or is not predicted.", - "Adnomial", - "Auxiliary", - "Complementizer", - "Final ending", - "Gerund", - "Realis", - "Irrealis", - "Short form", - "Long form", - "Order form", - "Specific form" - ], - "type": "string" - }, - "gender": { - "description": "The grammatical gender.", - "enum": [ - "GENDER_UNKNOWN", - "FEMININE", - "MASCULINE", - "NEUTER" - ], - "enumDescriptions": [ - "Gender is not applicable in the analyzed language or is not predicted.", - "Feminine", - "Masculine", - "Neuter" - ], - "type": "string" - }, - "mood": { - "description": "The grammatical mood.", - "enum": [ - "MOOD_UNKNOWN", - "CONDITIONAL_MOOD", - "IMPERATIVE", - "INDICATIVE", - "INTERROGATIVE", - "JUSSIVE", - "SUBJUNCTIVE" - ], - "enumDescriptions": [ - "Mood is not applicable in the analyzed language or is not predicted.", - "Conditional", - "Imperative", - "Indicative", - "Interrogative", - "Jussive", - "Subjunctive" - ], - "type": "string" - }, - "number": { - "description": "The grammatical number.", - "enum": [ - "NUMBER_UNKNOWN", - "SINGULAR", - "PLURAL", - "DUAL" - ], - "enumDescriptions": [ - "Number is not applicable in the analyzed language or is not predicted.", - "Singular", - "Plural", - "Dual" - ], - "type": "string" - }, - "person": { - "description": "The grammatical person.", - "enum": [ - "PERSON_UNKNOWN", - "FIRST", - "SECOND", - "THIRD", - "REFLEXIVE_PERSON" - ], - "enumDescriptions": [ - "Person is not applicable in the analyzed language or is not predicted.", - "First", - "Second", - "Third", - "Reflexive" - ], - "type": "string" - }, - "proper": { - "description": "The grammatical properness.", - "enum": [ - "PROPER_UNKNOWN", - "PROPER", - "NOT_PROPER" - ], - "enumDescriptions": [ - "Proper is not applicable in the analyzed language or is not predicted.", - "Proper", - "Not proper" - ], - "type": "string" - }, - "reciprocity": { - "description": "The grammatical reciprocity.", - "enum": [ - "RECIPROCITY_UNKNOWN", - "RECIPROCAL", - "NON_RECIPROCAL" - ], - "enumDescriptions": [ - "Reciprocity is not applicable in the analyzed language or is not predicted.", - "Reciprocal", - "Non-reciprocal" - ], - "type": "string" - }, - "tag": { - "description": "The part of speech tag.", - "enum": [ - "UNKNOWN", - "ADJ", - "ADP", - "ADV", - "CONJ", - "DET", - "NOUN", - "NUM", - "PRON", - "PRT", - "PUNCT", - "VERB", - "X", - "AFFIX" - ], - "enumDescriptions": [ - "Unknown", - "Adjective", - "Adposition (preposition and postposition)", - "Adverb", - "Conjunction", - "Determiner", - "Noun (common and proper)", - "Cardinal number", - "Pronoun", - "Particle or other function word", - "Punctuation", - "Verb (all tenses and modes)", - "Other: foreign words, typos, abbreviations", - "Affix" - ], - "type": "string" - }, - "tense": { - "description": "The grammatical tense.", - "enum": [ - "TENSE_UNKNOWN", - "CONDITIONAL_TENSE", - "FUTURE", - "PAST", - "PRESENT", - "IMPERFECT", - "PLUPERFECT" - ], - "enumDescriptions": [ - "Tense is not applicable in the analyzed language or is not predicted.", - "Conditional", - "Future", - "Past", - "Present", - "Imperfect", - "Pluperfect" - ], - "type": "string" - }, - "voice": { - "description": "The grammatical voice.", - "enum": [ - "VOICE_UNKNOWN", - "ACTIVE", - "CAUSATIVE", - "PASSIVE" - ], - "enumDescriptions": [ - "Voice is not applicable in the analyzed language or is not predicted.", - "Active", - "Causative", - "Passive" - ], - "type": "string" - } - }, - "type": "object" - }, - "Sentence": { - "description": "Represents a sentence in the input document.", - "id": "Sentence", - "properties": { - "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence." - }, - "text": { - "$ref": "TextSpan", - "description": "The sentence text." - } - }, - "type": "object" - }, - "Sentiment": { - "description": "Represents the feeling associated with the entire text or entities in the text. Next ID: 6", - "id": "Sentiment", - "properties": { - "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).", - "format": "float", - "type": "number" - }, - "score": { - "description": "Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "TextSpan": { - "description": "Represents an output piece of text.", - "id": "TextSpan", - "properties": { - "beginOffset": { - "description": "The API calculates the beginning offset of the content in the original document according to the EncodingType specified in the API request.", - "format": "int32", - "type": "integer" - }, - "content": { - "description": "The content of the output text.", - "type": "string" - } - }, - "type": "object" - }, - "Token": { - "description": "Represents the smallest syntactic building block of the text.", - "id": "Token", - "properties": { - "dependencyEdge": { - "$ref": "DependencyEdge", - "description": "Dependency tree parse for this token." - }, - "lemma": { - "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.", - "type": "string" - }, - "partOfSpeech": { - "$ref": "PartOfSpeech", - "description": "Parts of speech tag for this token." - }, - "text": { - "$ref": "TextSpan", - "description": "The token text." - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Natural Language API", - "version": "v1beta2", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/lifesciences__v2beta.json b/discovery/googleapis_beta/lifesciences__v2beta.json index ae76cd6..d837f05 100644 --- a/discovery/googleapis_beta/lifesciences__v2beta.json +++ b/discovery/googleapis_beta/lifesciences__v2beta.json
@@ -304,7 +304,7 @@ } } }, - "revision": "20200918", + "revision": "20210116", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { @@ -331,6 +331,10 @@ "description": "By default, after an action fails, no further actions are run. This flag indicates that this action must be run even if the pipeline has already failed. This is useful for actions that copy output files off of the VM or for debugging. Note that no actions will be run if image prefetching fails.", "type": "boolean" }, + "blockExternalNetwork": { + "description": "Prevents the container from accessing the external network.", + "type": "boolean" + }, "commands": { "description": "If specified, overrides the `CMD` specified in the container. If the container also has an `ENTRYPOINT` the values are used as entrypoint arguments. Otherwise, they are used as a command and arguments to run inside the container.", "items": { @@ -501,7 +505,7 @@ "type": "object" }, "Disk": { - "description": "Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.", + "description": "Carries information about a disk that can be attached to a VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations. Specify either `Volume` or `Disk`, but not both.", "id": "Disk", "properties": { "name": { @@ -586,6 +590,17 @@ }, "type": "object" }, + "ExistingDisk": { + "description": "Configuration for an existing disk to be attached to the VM.", + "id": "ExistingDisk", + "properties": { + "disk": { + "description": "If `disk` contains slashes, the Cloud Life Sciences API assumes that it is a complete URL for the disk. If `disk` does not contain slashes, the Cloud Life Sciences API assumes that the disk is a zonal disk and a URL will be generated of the form `zones//disks/`, where `` is the zone in which the instance is allocated. The disk must be ext4 formatted. If all `Mount` references to this disk have the `read_only` flag set to true, the disk will be attached in `read-only` mode and can be shared with other instances. Otherwise, the disk will be available for writing but cannot be shared.", + "type": "string" + } + }, + "type": "object" + }, "FailedEvent": { "description": "An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.", "id": "FailedEvent", @@ -768,6 +783,17 @@ }, "type": "object" }, + "NFSMount": { + "description": "Configuration for an `NFSMount` to be attached to the VM.", + "id": "NFSMount", + "properties": { + "target": { + "description": "A target NFS mount. The target must be specified as `address:/mount\".", + "type": "string" + } + }, + "type": "object" + }, "Network": { "description": "VM networking options.", "id": "Network", @@ -822,6 +848,26 @@ }, "type": "object" }, + "PersistentDisk": { + "description": "Configuration for a persistent disk to be attached to the VM. See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.", + "id": "PersistentDisk", + "properties": { + "sizeGb": { + "description": "The size, in GB, of the disk to attach. If the size is not specified, a default is chosen to ensure reasonable I/O performance. If the disk type is specified as `local-ssd`, multiple local drives are automatically combined to provide the requested size. Note, however, that each physical SSD is 375GB in size, and no more than 8 drives can be attached to a single instance.", + "format": "int32", + "type": "integer" + }, + "sourceImage": { + "description": "An image to put on the disk before attaching it to the VM.", + "type": "string" + }, + "type": { + "description": "The Compute Engine disk type. If unspecified, `pd-standard` is used.", + "type": "string" + } + }, + "type": "object" + }, "Pipeline": { "description": "Specifies a series of actions to execute, expressed as Docker containers.", "id": "Pipeline", @@ -1025,14 +1071,14 @@ "type": "string" }, "disks": { - "description": "The list of disks to create and attach to the VM.", + "description": "The list of disks to create and attach to the VM. Specify either the `volumes[]` field or the `disks[]` field, but not both.", "items": { "$ref": "Disk" }, "type": "array" }, "dockerCacheImages": { - "description": "The Compute Engine Disk Images to use as a Docker cache. The disks will be mounted into the Docker folder in a way that the images present in the cache will not need to be pulled. The digests of the cached images must match those of the tags used or the latest version will still be pulled. The root directory of the ext4 image must contain `image` and `overlay2` directories copied from the Docker directory of a VM where the desired Docker images have already been pulled. Only a single image is supported.", + "description": "The Compute Engine Disk Images to use as a Docker cache. The disks will be mounted into the Docker folder in a way that the images present in the cache will not need to be pulled. The digests of the cached images must match those of the tags used or the latest version will still be pulled. The root directory of the ext4 image must contain `image` and `overlay2` directories copied from the Docker directory of a VM where the desired Docker images have already been pulled. Any images pulled that are not cached will be stored on the first cache disk instead of the boot disk. Only a single image is supported.", "items": { "type": "string" }, @@ -1068,6 +1114,36 @@ "serviceAccount": { "$ref": "ServiceAccount", "description": "The service account to install on the VM. This account does not need any permissions other than those required by the pipeline." + }, + "volumes": { + "description": "The list of disks and other storage to create or attach to the VM. Specify either the `volumes[]` field or the `disks[]` field, but not both.", + "items": { + "$ref": "Volume" + }, + "type": "array" + } + }, + "type": "object" + }, + "Volume": { + "description": "Carries information about storage that can be attached to a VM. Specify either `Volume` or `Disk`, but not both.", + "id": "Volume", + "properties": { + "existingDisk": { + "$ref": "ExistingDisk", + "description": "Configuration for a existing disk." + }, + "nfsMount": { + "$ref": "NFSMount", + "description": "Configuration for an NFS mount." + }, + "persistentDisk": { + "$ref": "PersistentDisk", + "description": "Configuration for a persistent disk." + }, + "volume": { + "description": "A user-supplied name for the volume. Used when mounting the volume into `Actions`. The name must contain only upper and lowercase alphanumeric characters and hyphens and cannot start with a hyphen.", + "type": "string" } }, "type": "object"
diff --git a/discovery/googleapis_beta/metastore__v1beta.json b/discovery/googleapis_beta/metastore__v1beta.json new file mode 100644 index 0000000..dda6bbb --- /dev/null +++ b/discovery/googleapis_beta/metastore__v1beta.json
@@ -0,0 +1,1463 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://metastore.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Dataproc Metastore", + "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "metastore:v1beta", + "kind": "discovery#restDescription", + "name": "metastore", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "metastore.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "metastore.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.", + "httpMethod": "DELETE", + "id": "metastore.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "metastore.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "metastore.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "services": { + "methods": { + "create": { + "description": "Creates a metastore service in a project and location.", + "httpMethod": "POST", + "id": "metastore.projects.locations.services.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The relative resource name of the location in which to create a metastore service, in the following form:\"projects/{project_number}/locations/{location_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", + "location": "query", + "type": "string" + }, + "serviceId": { + "description": "Required. The ID of the metastore service, which is used as the final component of the metastore service's name.This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/services", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single service.", + "httpMethod": "DELETE", + "id": "metastore.projects.locations.services.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the metastore service to delete, in the following form:\"projects/{project_number}/locations/{location_id}/services/{service_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "exportMetadata": { + "description": "Exports metadata from a service.", + "httpMethod": "POST", + "id": "metastore.projects.locations.services.exportMetadata", + "parameterOrder": [ + "service" + ], + "parameters": { + "service": { + "description": "Required. The relative resource name of the metastore service to run export, in the following form:\"projects/{project_id}/locations/{location_id}/services/{service_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+service}:exportMetadata", + "request": { + "$ref": "ExportMetadataRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a single service.", + "httpMethod": "GET", + "id": "metastore.projects.locations.services.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the metastore service to retrieve, in the following form:\"projects/{project_number}/locations/{location_id}/services/{service_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Service" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "metastore.projects.locations.services.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists services in a project and location.", + "httpMethod": "GET", + "id": "metastore.projects.locations.services.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter to apply to list results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListServices must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The relative resource name of the location of metastore services to list, in the following form:\"projects/{project_number}/locations/{location_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/services", + "response": { + "$ref": "ListServicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single service.", + "httpMethod": "PATCH", + "id": "metastore.projects.locations.services.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The relative resource name of the metastore service, of the form:\"projects/{project_number}/locations/{location_id}/services/{service_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", + "httpMethod": "POST", + "id": "metastore.projects.locations.services.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "metastore.projects.locations.services.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "metadataImports": { + "methods": { + "create": { + "description": "Creates a new MetadataImport in a given project and location.", + "httpMethod": "POST", + "id": "metastore.projects.locations.services.metadataImports.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "metadataImportId": { + "description": "Required. The ID of the metadata import, which is used as the final component of the metadata import's name.This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The relative resource name of the service in which to create a metastore import, in the following form:\"projects/{project_number}/locations/{location_id}/services/{service_id}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/metadataImports", + "request": { + "$ref": "MetadataImport" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single import.", + "httpMethod": "GET", + "id": "metastore.projects.locations.services.metadataImports.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the metadata import to retrieve, in the following form:\"projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/metadataImports/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "MetadataImport" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists imports in a service.", + "httpMethod": "GET", + "id": "metastore.projects.locations.services.metadataImports.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter to apply to list results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of imports to return. The response may contain less than the maximum number. If unspecified, no more than 500 imports are returned. The maximum value is 1000; values above 1000 are changed to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous DataprocMetastore.ListServices call. Provide this token to retrieve the subsequent page.To retrieve the first page, supply an empty page token.When paginating, other parameters provided to DataprocMetastore.ListServices must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The relative resource name of the service whose metadata imports to list, in the following form:\"projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/metadataImports", + "response": { + "$ref": "ListMetadataImportsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single import. Only the description field of MetadataImport is supported to be updated.", + "httpMethod": "PATCH", + "id": "metastore.projects.locations.services.metadataImports.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The relative resource name of the metadata import, of the form:\"projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/metadataImports/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. A field mask used to specify the fields to be overwritten in the metadata import resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "MetadataImport" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20210128", + "rootUrl": "https://metastore.googleapis.com/", + "schemas": { + "AuditConfig": { + "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.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "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" + }, + "AuditLogConfig": { + "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.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates members with a role.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "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 members 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)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform 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. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseDump": { + "description": "A specification of the location of and metadata about a database dump from a relational database management system.", + "id": "DatabaseDump", + "properties": { + "databaseType": { + "description": "The type of the database.", + "enum": [ + "DATABASE_TYPE_UNSPECIFIED", + "MYSQL" + ], + "enumDescriptions": [ + "The type of the source database is unknown.", + "The type of the source database is MySQL." + ], + "type": "string" + }, + "gcsUri": { + "description": "A Cloud Storage object URI that specifies the source from which to import metadata. It must begin with gs://.", + "type": "string" + }, + "sourceDatabase": { + "description": "The name of the source database.", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for Empty is empty JSON object {}.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ExportMetadataRequest": { + "description": "Request message for DataprocMetastore.ExportMetadata.", + "id": "ExportMetadataRequest", + "properties": { + "destinationGcsFolder": { + "description": "Required. A Cloud Storage URI of a folder that metadata are exported to, in the format gs:///. A sub-folder containing exported files will be created below it.", + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.", + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "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() < 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", + "properties": { + "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" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "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" + }, + "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" + }, + "HiveMetastoreConfig": { + "description": "Specifies configuration information specific to running Hive metastore software as the metastore service.", + "id": "HiveMetastoreConfig", + "properties": { + "configOverrides": { + "additionalProperties": { + "type": "string" + }, + "description": "A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden).", + "type": "object" + }, + "kerberosConfig": { + "$ref": "KerberosConfig", + "description": "Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the UpdateService method and specify this field's path (\"hive_metastore_config.kerberos_config\") in the request's update_mask while omitting this field from the request's service." + }, + "version": { + "description": "Immutable. The Hive metastore schema version.", + "type": "string" + } + }, + "type": "object" + }, + "HiveMetastoreVersion": { + "description": "A specification of a supported version of the Hive Metastore software.", + "id": "HiveMetastoreVersion", + "properties": { + "isDefault": { + "description": "Whether version will be chosen by the server if a metastore service is created with a HiveMetastoreConfig that omits the version.", + "type": "boolean" + }, + "version": { + "description": "The semantic version of the Hive Metastore software.", + "type": "string" + } + }, + "type": "object" + }, + "KerberosConfig": { + "description": "Configuration information for a Kerberos principal.", + "id": "KerberosConfig", + "properties": { + "keytab": { + "$ref": "Secret", + "description": "A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC)." + }, + "krb5ConfigGcsUri": { + "description": "A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.", + "type": "string" + }, + "principal": { + "description": "A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form \"primary/instance@REALM\", but there is no exact format.", + "type": "string" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListMetadataImportsResponse": { + "description": "Response message for DataprocMetastore.ListMetadataImports.", + "id": "ListMetadataImportsResponse", + "properties": { + "metadataImports": { + "description": "The imports in the specified service.", + "items": { + "$ref": "MetadataImport" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListServicesResponse": { + "description": "Response message for DataprocMetastore.ListServices.", + "id": "ListServicesResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "services": { + "description": "The services in the specified location.", + "items": { + "$ref": "Service" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"} ", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: \"us-east1\".", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", + "type": "string" + } + }, + "type": "object" + }, + "LocationMetadata": { + "description": "Metadata about the service in a location.", + "id": "LocationMetadata", + "properties": { + "supportedHiveMetastoreVersions": { + "description": "The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default.", + "items": { + "$ref": "HiveMetastoreVersion" + }, + "type": "array" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.", + "id": "MaintenanceWindow", + "properties": { + "dayOfWeek": { + "description": "The day of week, when the window starts.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "hourOfDay": { + "description": "The hour of day (0-23) when the window starts.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "MetadataExport": { + "description": "The details of a metadata export operation.", + "id": "MetadataExport", + "properties": { + "destinationGcsUri": { + "description": "Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of gs:////, where ` is automatically generated.", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time when the export ended.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. The time when the export started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the export.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "The state of the metadata export is unknown.", + "The metadata export is running.", + "The metadata export completed successfully.", + "The metadata export failed.", + "The metadata export is cancelled." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MetadataImport": { + "description": "A metastore resource that imports metadata.", + "id": "MetadataImport", + "properties": { + "createTime": { + "description": "Output only. The time when the metadata import was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "databaseDump": { + "$ref": "DatabaseDump", + "description": "Immutable. A database dump from a pre-existing metastore's database." + }, + "description": { + "description": "The description of the metadata import.", + "type": "string" + }, + "name": { + "description": "Immutable. The relative resource name of the metadata import, of the form:\"projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}\".", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the metadata import.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "SUCCEEDED", + "UPDATING", + "FAILED" + ], + "enumDescriptions": [ + "The state of the metadata import is unknown.", + "The metadata import is running.", + "The metadata import completed successfully.", + "The metadata import is being updated.", + "The metadata import failed, and attempted metadata changes were rolled back." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the metadata import was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MetadataIntegration": { + "description": "Specifies how metastore metadata should be integrated with external services.", + "id": "MetadataIntegration", + "properties": {}, + "type": "object" + }, + "MetadataManagementActivity": { + "description": "The metadata management activities of the metastore service.", + "id": "MetadataManagementActivity", + "properties": { + "metadataExports": { + "description": "Output only. The latest metadata exports of the metastore service.", + "items": { + "$ref": "MetadataExport" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.", + "type": "object" + } + }, + "type": "object" + }, + "Policy": { + "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 to a single role. Members 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 < 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 < 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/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of members to 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 member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "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" + }, + "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 conditionsImportant: 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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Secret": { + "description": "A securely stored value.", + "id": "Secret", + "properties": { + "cloudSecret": { + "description": "The relative resource name of a Secret Manager secret version, in the following form:\"projects/{project_number}/secrets/{secret_id}/versions/{version_id}\".", + "type": "string" + } + }, + "type": "object" + }, + "Service": { + "description": "A managed metastore service that serves metadata queries.", + "id": "Service", + "properties": { + "artifactGcsUri": { + "description": "Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the metastore service was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endpointUri": { + "description": "Output only. The URI of the endpoint used to access the metastore service.", + "readOnly": true, + "type": "string" + }, + "hiveMetastoreConfig": { + "$ref": "HiveMetastoreConfig", + "description": "Configuration information specific to running Hive metastore software as the metastore service." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "User-defined labels for the metastore service.", + "type": "object" + }, + "maintenanceWindow": { + "$ref": "MaintenanceWindow", + "description": "The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time." + }, + "metadataIntegration": { + "$ref": "MetadataIntegration", + "description": "The setting that defines how metastore metadata should be integrated with external services and systems." + }, + "metadataManagementActivity": { + "$ref": "MetadataManagementActivity", + "description": "Output only. The metadata management activities of the metastore service.", + "readOnly": true + }, + "name": { + "description": "Immutable. The relative resource name of the metastore service, of the form:\"projects/{project_number}/locations/{location_id}/services/{service_id}\".", + "type": "string" + }, + "network": { + "description": "Immutable. The relative resource name of the VPC network on which the instance can be accessed. The network must belong to the same project as the metastore instance. It is specified in the following form:\"projects/{project_number}/global/networks/{network_id}\".", + "type": "string" + }, + "port": { + "description": "The TCP port at which the metastore service is reached. Default: 9083.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "Output only. The current state of the metastore service.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "SUSPENDING", + "SUSPENDED", + "UPDATING", + "DELETING", + "ERROR" + ], + "enumDescriptions": [ + "The state of the metastore service is unknown.", + "The metastore service is in the process of being created.", + "The metastore service is running and ready to serve queries.", + "The metastore service is entering suspension. Its query-serving availability may cease unexpectedly.", + "The metastore service is suspended and unable to serve queries.", + "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", + "The metastore service is undergoing deletion. It cannot be used.", + "The metastore service has encountered an error and cannot be used. The metastore service should be deleted." + ], + "readOnly": true, + "type": "string" + }, + "stateMessage": { + "description": "Output only. Additional information about the current state of the metastore service, if available.", + "readOnly": true, + "type": "string" + }, + "tier": { + "description": "The tier of the service.", + "enum": [ + "TIER_UNSPECIFIED", + "DEVELOPER", + "ENTERPRISE" + ], + "enumDescriptions": [ + "The tier is not set.", + "The developer tier provides limited scalability and no fault tolerance. Good for low-cost proof-of-concept.", + "The enterprise tier provides multi-zone high availability, and sufficient scalability for enterprise-level Dataproc Metastore workloads." + ], + "type": "string" + }, + "uid": { + "description": "Output only. The globally unique resource identifier of the metastore service.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the metastore service was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for SetIamPolicy method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "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 Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "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\"", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for TestIamPermissions method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "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": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for TestIamPermissions method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of TestPermissionsRequest.permissions that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Dataproc Metastore API", + "version": "v1beta", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/networkconnectivity__v1alpha1.json b/discovery/googleapis_beta/networkconnectivity__v1alpha1.json new file mode 100644 index 0000000..5462562 --- /dev/null +++ b/discovery/googleapis_beta/networkconnectivity__v1alpha1.json
@@ -0,0 +1,2317 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://networkconnectivity.googleapis.com/", + "batchPath": "batch", + "canonicalName": "networkconnectivity", + "description": "The Network Connectivity API will be home to various services which provide information pertaining to network connectivity.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "networkconnectivity:v1alpha1", + "kind": "discovery#restDescription", + "name": "networkconnectivity", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "global": { + "resources": { + "hubs": { + "methods": { + "create": { + "description": "Creates a new Hub in a given project and location.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.global.hubs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "hubId": { + "description": "Optional. Unique id for the Hub to create.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource's name of the Hub.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/hubs", + "request": { + "$ref": "Hub" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Hub.", + "httpMethod": "DELETE", + "id": "networkconnectivity.projects.locations.global.hubs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Hub to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Hub.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.global.hubs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the Hub resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Hub" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.global.hubs.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Hubs in a given project and location.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.global.hubs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters the results listed in the response.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sort the results by a certain order.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results per page that should be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/hubs", + "response": { + "$ref": "ListHubsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Hub.", + "httpMethod": "PATCH", + "id": "networkconnectivity.projects.locations.global.hubs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The name of a Hub resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Hub resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "Hub" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.global.hubs.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.global.hubs.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:cancel", + "request": { + "$ref": "GoogleLongrunningCancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "networkconnectivity.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "policyBasedRoutes": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.policyBasedRoutes.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/policyBasedRoutes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.policyBasedRoutes.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/policyBasedRoutes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.policyBasedRoutes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/policyBasedRoutes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "privateRanges": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.privateRanges.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.privateRanges.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.privateRanges.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateRanges/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "spokes": { + "methods": { + "create": { + "description": "Creates a new Spoke in a given project and location.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.spokes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent's resource name of the Spoke.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "spokeId": { + "description": "Optional. Unique id for the Spoke to create.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/spokes", + "request": { + "$ref": "Spoke" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Spoke.", + "httpMethod": "DELETE", + "id": "networkconnectivity.projects.locations.spokes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Spoke to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Spoke.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.spokes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of Spoke resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "Spoke" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.spokes.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Spokes in a given project and location.", + "httpMethod": "GET", + "id": "networkconnectivity.projects.locations.spokes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters the results listed in the response.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sort the results by a certain order.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results per page that should be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent's resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/spokes", + "response": { + "$ref": "ListSpokesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Spoke.", + "httpMethod": "PATCH", + "id": "networkconnectivity.projects.locations.spokes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The name of a Spoke resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the Spoke resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "Spoke" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.spokes.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "networkconnectivity.projects.locations.spokes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210128", + "rootUrl": "https://networkconnectivity.googleapis.com/", + "schemas": { + "AttributeValue": { + "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.", + "id": "AttributeValue", + "properties": { + "boolValue": { + "description": "A Boolean value represented by `true` or `false`.", + "type": "boolean" + }, + "intValue": { + "description": "A 64-bit signed integer.", + "format": "int64", + "type": "string" + }, + "stringValue": { + "$ref": "TruncatableString", + "description": "A string up to 256 bytes long." + } + }, + "type": "object" + }, + "Attributes": { + "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.", + "id": "Attributes", + "properties": { + "attributeMap": { + "additionalProperties": { + "$ref": "AttributeValue" + }, + "description": "The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: \"/instance_id\": \"my-instance\" \"/http/user_agent\": \"\" \"/http/request_bytes\": 300 \"abc.com/myattribute\": true", + "type": "object" + }, + "droppedAttributesCount": { + "description": "The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AuditConfig": { + "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.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "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" + }, + "AuditLogConfig": { + "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.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "BillingView": { + "description": "Message for reporting billing requests through Eventstream.", + "id": "BillingView", + "properties": { + "reportRequests": { + "description": "Billing requests to be reported for cloud.eventstream.v2.ResourceEvent Each request contains billing operations to be reported under a service name. See go/billing-view-construction for documentation on constructing billing view report requests.", + "items": { + "$ref": "ReportRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "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 members 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)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "Distribution": { + "description": "Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information: - the arithmetic mean of the samples - the minimum and maximum of the samples - the sum-squared-deviation of the samples, used to compute variance - a histogram of the values of the sample points", + "id": "Distribution", + "properties": { + "bucketCounts": { + "description": "The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "count": { + "description": "The total number of samples in the distribution. Must be >= 0.", + "format": "int64", + "type": "string" + }, + "exemplars": { + "description": "Example points. Must be in increasing order of `value` field.", + "items": { + "$ref": "Exemplar" + }, + "type": "array" + }, + "explicitBuckets": { + "$ref": "ExplicitBuckets", + "description": "Buckets with arbitrary user-provided width." + }, + "exponentialBuckets": { + "$ref": "ExponentialBuckets", + "description": "Buckets with exponentially growing width." + }, + "linearBuckets": { + "$ref": "LinearBuckets", + "description": "Buckets with constant width." + }, + "maximum": { + "description": "The maximum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "mean": { + "description": "The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "The minimum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "sumOfSquaredDeviation": { + "description": "The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Exemplar": { + "description": "Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.", + "id": "Exemplar", + "properties": { + "attachments": { + "description": "Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "timestamp": { + "description": "The observation (sampling) time of the above value.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ExplicitBuckets": { + "description": "Describing buckets with arbitrary user-provided width.", + "id": "ExplicitBuckets", + "properties": { + "bounds": { + "description": "'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on `bucket_options` for details. The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExponentialBuckets": { + "description": "Describing buckets with exponentially growing width.", + "id": "ExponentialBuckets", + "properties": { + "growthFactor": { + "description": "The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0.", + "format": "double", + "type": "number" + }, + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Expr": { + "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() < 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", + "properties": { + "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" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "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" + }, + "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" + }, + "GoogleLongrunningCancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "GoogleLongrunningCancelOperationRequest", + "properties": {}, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "HttpRequest": { + "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", + "id": "HttpRequest", + "properties": { + "cacheFillBytes": { + "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", + "format": "int64", + "type": "string" + }, + "cacheHit": { + "description": "Whether or not an entity was served from cache (with or without validation).", + "type": "boolean" + }, + "cacheLookup": { + "description": "Whether or not a cache lookup was attempted.", + "type": "boolean" + }, + "cacheValidatedWithOriginServer": { + "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.", + "type": "boolean" + }, + "latency": { + "description": "The request processing latency on the server, from the time the request was received until the response was sent.", + "format": "google-duration", + "type": "string" + }, + "protocol": { + "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", + "type": "string" + }, + "referer": { + "description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "type": "string" + }, + "remoteIp": { + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.", + "type": "string" + }, + "requestMethod": { + "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.", + "type": "string" + }, + "requestSize": { + "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", + "format": "int64", + "type": "string" + }, + "requestUrl": { + "description": "The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `\"http://example.com/some/info?color=red\"`.", + "type": "string" + }, + "responseSize": { + "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.", + "format": "int64", + "type": "string" + }, + "serverIp": { + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", + "type": "string" + }, + "status": { + "description": "The response code indicating the status of the response. Examples: 200, 404.", + "format": "int32", + "type": "integer" + }, + "userAgent": { + "description": "The user agent sent by the client. Example: `\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"`.", + "type": "string" + } + }, + "type": "object" + }, + "Hub": { + "description": "Network Connectivity Center is a hub-and-spoke abstraction for network connectivity management in Google Cloud. It reduces operational complexity through a simple, centralized connectivity management model. Following is the resource message of a hub.", + "id": "Hub", + "properties": { + "createTime": { + "description": "Time when the Hub was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Short description of the hub resource.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "User-defined labels.", + "type": "object" + }, + "name": { + "description": "Immutable. The name of a Hub resource.", + "type": "string" + }, + "spokes": { + "description": "Output only. A list of the URIs of all attached spokes", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The current lifecycle state of this Hub.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING" + ], + "enumDescriptions": [ + "No state information available", + "The resource's create operation is in progress", + "The resource is active", + "The resource's Delete operation is in progress" + ], + "readOnly": true, + "type": "string" + }, + "uniqueId": { + "description": "Output only. Google-generated UUID for this resource. This is unique across all Hub resources. If a Hub resource is deleted and another with the same name is created, it gets a different unique_id.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Time when the Hub was updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "LinearBuckets": { + "description": "Describing buckets with constant width.", + "id": "LinearBuckets", + "properties": { + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive.", + "format": "double", + "type": "number" + }, + "width": { + "description": "The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ListHubsResponse": { + "description": "Response for HubService.ListHubs method.", + "id": "ListHubsResponse", + "properties": { + "hubs": { + "description": "Hubs to be returned.", + "items": { + "$ref": "Hub" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListSpokesResponse": { + "description": "The response for HubService.ListSpokes.", + "id": "ListSpokesResponse", + "properties": { + "nextPageToken": { + "description": "The next pagination token in the List response. It should be used as page_token for the following request. An empty value means no more result.", + "type": "string" + }, + "spokes": { + "description": "Spokes to be returned.", + "items": { + "$ref": "Spoke" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "LogEntry": { + "description": "An individual log entry.", + "id": "LogEntry", + "properties": { + "httpRequest": { + "$ref": "HttpRequest", + "description": "Optional. Information about the HTTP request associated with this log entry, if applicable." + }, + "insertId": { + "description": "A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional information about the log entry.", + "type": "object" + }, + "name": { + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`, `\"book_log\"`.", + "type": "string" + }, + "operation": { + "$ref": "LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if applicable." + }, + "protoPayload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog.", + "type": "object" + }, + "severity": { + "description": "The severity of the log entry. The default value is `LogSeverity.DEFAULT`.", + "enum": [ + "DEFAULT", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or a configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ], + "type": "string" + }, + "sourceLocation": { + "$ref": "LogEntrySourceLocation", + "description": "Optional. Source code location information associated with the log entry, if any." + }, + "structPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", + "type": "object" + }, + "textPayload": { + "description": "The log entry payload, represented as a Unicode string (UTF-8).", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred. If omitted, defaults to operation start time.", + "format": "google-datetime", + "type": "string" + }, + "trace": { + "description": "Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`", + "type": "string" + } + }, + "type": "object" + }, + "LogEntryOperation": { + "description": "Additional information about a potentially long-running operation with which a log entry is associated.", + "id": "LogEntryOperation", + "properties": { + "first": { + "description": "Optional. Set this to True if this is the first log entry in the operation.", + "type": "boolean" + }, + "id": { + "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.", + "type": "string" + }, + "last": { + "description": "Optional. Set this to True if this is the last log entry in the operation.", + "type": "boolean" + }, + "producer": { + "description": "Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.", + "type": "string" + } + }, + "type": "object" + }, + "LogEntrySourceLocation": { + "description": "Additional information about the source code location that produced the log entry.", + "id": "LogEntrySourceLocation", + "properties": { + "file": { + "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", + "type": "string" + }, + "function": { + "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python).", + "type": "string" + }, + "line": { + "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "MetricValue": { + "description": "Represents a single metric value.", + "id": "MetricValue", + "properties": { + "boolValue": { + "description": "A boolean value.", + "type": "boolean" + }, + "distributionValue": { + "$ref": "Distribution", + "description": "A distribution value." + }, + "doubleValue": { + "description": "A double precision floating point value.", + "format": "double", + "type": "number" + }, + "endTime": { + "description": "The end of the time period over which this metric value's measurement applies. If not specified, google.api.servicecontrol.v1.Operation.end_time will be used.", + "format": "google-datetime", + "type": "string" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. Note that this map must not contain monitored resource labels.", + "type": "object" + }, + "moneyValue": { + "$ref": "Money", + "description": "A money value." + }, + "startTime": { + "description": "The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. If not specified, google.api.servicecontrol.v1.Operation.start_time will be used.", + "format": "google-datetime", + "type": "string" + }, + "stringValue": { + "description": "A text string value.", + "type": "string" + } + }, + "type": "object" + }, + "MetricValueSet": { + "description": "Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values.", + "id": "MetricValueSet", + "properties": { + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "metricValues": { + "description": "The values in this metric.", + "items": { + "$ref": "MetricValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "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", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "Represents information regarding an operation.", + "id": "Operation", + "properties": { + "consumerId": { + "description": "Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY.", + "type": "string" + }, + "endTime": { + "description": "End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.", + "format": "google-datetime", + "type": "string" + }, + "extensions": { + "description": "Unimplemented.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "importance": { + "description": "DO NOT USE. This is an experimental field.", + "enum": [ + "LOW", + "HIGH", + "DEBUG" + ], + "enumDescriptions": [ + "Allows data caching, batching, and aggregation. It provides higher performance with higher data loss risk.", + "Disables data aggregation to minimize data loss. It is for operations that contains significant monetary value or audit trail. This feature only applies to the client libraries.", + "Deprecated. Do not use. Disables data aggregation and enables additional validation logic. It should only be used during the onboarding process. It is only available to Google internal services, and the service must be approved by chemist-dev@google.com in order to use this level." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.", + "type": "object" + }, + "logEntries": { + "description": "Represents information to be logged.", + "items": { + "$ref": "LogEntry" + }, + "type": "array" + }, + "metricValueSets": { + "description": "Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.", + "items": { + "$ref": "MetricValueSet" + }, + "type": "array" + }, + "operationId": { + "description": "Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.", + "type": "string" + }, + "operationName": { + "description": "Fully qualified name of the operation. Reserved for future use.", + "type": "string" + }, + "quotaProperties": { + "$ref": "QuotaProperties", + "description": "Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed." + }, + "resources": { + "description": "The resources that are involved in the operation. The maximum supported number of entries in this field is 100.", + "items": { + "$ref": "ResourceInfo" + }, + "type": "array" + }, + "startTime": { + "description": "Required. Start time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "traceSpans": { + "description": "Unimplemented. A list of Cloud Trace spans. The span names shall contain the id of the destination project which can be either the produce or the consumer project.", + "items": { + "$ref": "TraceSpan" + }, + "type": "array" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Private Preview. This feature is only available for approved services. User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Policy": { + "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` to a single `role`. Members 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 < 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 < 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/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to 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 member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "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" + }, + "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "QuotaProperties": { + "description": "Represents the properties needed for quota operations.", + "id": "QuotaProperties", + "properties": { + "quotaMode": { + "description": "Quota mode for this operation.", + "enum": [ + "ACQUIRE", + "ACQUIRE_BEST_EFFORT", + "CHECK", + "RELEASE" + ], + "enumDescriptions": [ + "Decreases available quota by the cost specified for the operation. If cost is higher than available quota, operation fails and returns error.", + "Decreases available quota by the cost specified for the operation. If cost is higher than available quota, operation does not fail and available quota goes down to zero but it returns error.", + "Does not change any available quota. Only checks if there is enough quota. No lock is placed on the checked tokens neither.", + "Increases available quota by the operation cost specified for the operation." + ], + "type": "string" + } + }, + "type": "object" + }, + "ReportRequest": { + "description": "Request message for the Report method.", + "id": "ReportRequest", + "properties": { + "operations": { + "description": "Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. There is no limit on the number of operations in the same ReportRequest, however the ReportRequest size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior.", + "items": { + "$ref": "Operation" + }, + "type": "array" + }, + "serviceConfigId": { + "description": "Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used.", + "type": "string" + }, + "serviceName": { + "description": "The service name as specified in its service configuration. For example, `\"pubsub.googleapis.com\"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceInfo": { + "description": "Describes a resource associated with this operation.", + "id": "ResourceInfo", + "properties": { + "resourceContainer": { + "description": "The identifier of the parent of this resource instance. Must be in one of the following formats: - `projects/` - `folders/` - `organizations/`", + "type": "string" + }, + "resourceLocation": { + "description": "The location of the resource. If not empty, the resource will be checked against location policy. The value must be a valid zone, region or multiregion. For example: \"europe-west4\" or \"northamerica-northeast1-a\"", + "type": "string" + }, + "resourceName": { + "description": "Name of the resource. This is used for auditing purposes.", + "type": "string" + } + }, + "type": "object" + }, + "RouterApplianceInstance": { + "description": "RouterAppliance represents a Router appliance which is specified by a VM URI and a NIC address.", + "id": "RouterApplianceInstance", + "properties": { + "ipAddress": { + "description": "The IP address of the network interface to use for peering.", + "type": "string" + }, + "networkInterface": { + "type": "string" + }, + "virtualMachine": { + "description": "The URI of the virtual machine resource", + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "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 Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "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\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "Spoke": { + "description": "A Spoke is an abstraction of a network attachment being attached to a Hub. A Spoke can be underlying a VPN tunnel, a VLAN (interconnect) attachment, a Router appliance, etc.", + "id": "Spoke", + "properties": { + "createTime": { + "description": "The time when the Spoke was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Short description of the spoke resource", + "type": "string" + }, + "hub": { + "description": "The resource URL of the hub resource that the spoke is attached to", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "User-defined labels.", + "type": "object" + }, + "linkedInterconnectAttachments": { + "description": "The URIs of linked interconnect attachment resources", + "items": { + "type": "string" + }, + "type": "array" + }, + "linkedRouterApplianceInstances": { + "description": "The URIs of linked Router appliance resources", + "items": { + "$ref": "RouterApplianceInstance" + }, + "type": "array" + }, + "linkedVpnTunnels": { + "description": "The URIs of linked VPN tunnel resources", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Immutable. The name of a Spoke resource.", + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of this Hub.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING" + ], + "enumDescriptions": [ + "No state information available", + "The resource's create operation is in progress", + "The resource is active", + "The resource's Delete operation is in progress" + ], + "readOnly": true, + "type": "string" + }, + "uniqueId": { + "description": "Output only. Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets a different unique_id.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "The time when the Spoke was updated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "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": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TraceSpan": { + "description": "A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.", + "id": "TraceSpan", + "properties": { + "attributes": { + "$ref": "Attributes", + "description": "A set of attributes on the span. You can have up to 32 attributes per span." + }, + "childSpanCount": { + "description": "An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "$ref": "TruncatableString", + "description": "A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces." + }, + "endTime": { + "description": "The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.", + "type": "string" + }, + "parentSpanId": { + "description": "The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.", + "type": "string" + }, + "sameProcessAsParentSpan": { + "description": "(Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.", + "type": "boolean" + }, + "spanId": { + "description": "The [SPAN_ID] portion of the span's resource name.", + "type": "string" + }, + "spanKind": { + "description": "Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.", + "enum": [ + "SPAN_KIND_UNSPECIFIED", + "INTERNAL", + "SERVER", + "CLIENT", + "PRODUCER", + "CONSUMER" + ], + "enumDescriptions": [ + "Unspecified. Do NOT use as default. Implementations MAY assume SpanKind.INTERNAL to be default.", + "Indicates that the span is used internally. Default value.", + "Indicates that the span covers server-side handling of an RPC or other remote network request.", + "Indicates that the span covers the client-side wrapper around an RPC or other remote request.", + "Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. publishing a message to a pubsub service).", + "Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. receiving a message from a pubsub service subscription)." + ], + "type": "string" + }, + "startTime": { + "description": "The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.", + "format": "google-datetime", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "An optional final status for this span." + } + }, + "type": "object" + }, + "TruncatableString": { + "description": "Represents a string that might be shortened to a specified length.", + "id": "TruncatableString", + "properties": { + "truncatedByteCount": { + "description": "The number of bytes removed from the original string. If this value is 0, then the string was not shortened.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Network Connectivity API", + "version": "v1alpha1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/oslogin__v1alpha.json b/discovery/googleapis_beta/oslogin__v1alpha.json deleted file mode 100644 index 835087f..0000000 --- a/discovery/googleapis_beta/oslogin__v1alpha.json +++ /dev/null
@@ -1,484 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/compute": { - "description": "View and manage your Google Compute Engine resources" - }, - "https://www.googleapis.com/auth/compute.readonly": { - "description": "View your Google Compute Engine resources" - } - } - } - }, - "basePath": "", - "baseUrl": "https://oslogin.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud OS Login", - "description": "You can use OS Login to manage access to your VM instances using IAM roles.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "oslogin:v1alpha", - "kind": "discovery#restDescription", - "name": "oslogin", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "users": { - "methods": { - "getLoginProfile": { - "description": "Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.", - "httpMethod": "GET", - "id": "oslogin.users.getLoginProfile", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique ID for the user in format `users/{user}`.", - "location": "path", - "pattern": "^users/[^/]+$", - "required": true, - "type": "string" - }, - "operatingSystemType": { - "description": "The type of operating system associated with the account.", - "enum": [ - "OPERATING_SYSTEM_TYPE_UNSPECIFIED", - "LINUX", - "WINDOWS" - ], - "enumDescriptions": [ - "The operating system type associated with the user account information is unspecified.", - "Linux user account information.", - "Windows user account information." - ], - "location": "query", - "type": "string" - }, - "projectId": { - "description": "The project ID of the Google Cloud Platform project.", - "location": "query", - "type": "string" - }, - "systemId": { - "description": "A system ID for filtering the results of the request.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}/loginProfile", - "response": { - "$ref": "LoginProfile" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "importSshPublicKey": { - "description": "Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.", - "httpMethod": "POST", - "id": "oslogin.users.importSshPublicKey", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The unique ID for the user in format `users/{user}`.", - "location": "path", - "pattern": "^users/[^/]+$", - "required": true, - "type": "string" - }, - "projectId": { - "description": "The project ID of the Google Cloud Platform project.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+parent}:importSshPublicKey", - "request": { - "$ref": "SshPublicKey" - }, - "response": { - "$ref": "ImportSshPublicKeyResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - } - }, - "resources": { - "projects": { - "methods": { - "delete": { - "description": "Deletes a POSIX account.", - "httpMethod": "DELETE", - "id": "oslogin.users.projects.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`.", - "location": "path", - "pattern": "^users/[^/]+/projects/[^/]+$", - "required": true, - "type": "string" - }, - "operatingSystemType": { - "description": "The type of operating system associated with the account.", - "enum": [ - "OPERATING_SYSTEM_TYPE_UNSPECIFIED", - "LINUX", - "WINDOWS" - ], - "enumDescriptions": [ - "The operating system type associated with the user account information is unspecified.", - "Linux user account information.", - "Windows user account information." - ], - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - } - } - }, - "sshPublicKeys": { - "methods": { - "delete": { - "description": "Deletes an SSH public key.", - "httpMethod": "DELETE", - "id": "oslogin.users.sshPublicKeys.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", - "location": "path", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "description": "Retrieves an SSH public key.", - "httpMethod": "GET", - "id": "oslogin.users.sshPublicKeys.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", - "location": "path", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "SshPublicKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "patch": { - "description": "Updates an SSH public key and returns the profile information. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "oslogin.users.sshPublicKeys.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", - "location": "path", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Mask to control which fields get updated. Updates all if not present.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "request": { - "$ref": "SshPublicKey" - }, - "response": { - "$ref": "SshPublicKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - } - } - } - } - } - }, - "revision": "20200925", - "rootUrl": "https://oslogin.googleapis.com/", - "schemas": { - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "ImportSshPublicKeyResponse": { - "description": "A response message for importing an SSH public key.", - "id": "ImportSshPublicKeyResponse", - "properties": { - "details": { - "description": "Detailed information about import results.", - "type": "string" - }, - "loginProfile": { - "$ref": "LoginProfile", - "description": "The login profile information for the user." - } - }, - "type": "object" - }, - "LoginProfile": { - "description": "The user profile information used for logging in to a virtual machine on Google Compute Engine.", - "id": "LoginProfile", - "properties": { - "name": { - "description": "Required. A unique user ID.", - "type": "string" - }, - "posixAccounts": { - "description": "The list of POSIX accounts associated with the user.", - "items": { - "$ref": "PosixAccount" - }, - "type": "array" - }, - "sshPublicKeys": { - "additionalProperties": { - "$ref": "SshPublicKey" - }, - "description": "A map from SSH public key fingerprint to the associated key object.", - "type": "object" - } - }, - "type": "object" - }, - "PosixAccount": { - "description": "The POSIX account information associated with a Google account.", - "id": "PosixAccount", - "properties": { - "accountId": { - "description": "Output only. A POSIX account identifier.", - "readOnly": true, - "type": "string" - }, - "gecos": { - "description": "The GECOS (user information) entry for this account.", - "type": "string" - }, - "gid": { - "description": "The default group ID.", - "format": "int64", - "type": "string" - }, - "homeDirectory": { - "description": "The path to the home directory for this account.", - "type": "string" - }, - "name": { - "description": "Output only. The canonical resource name.", - "readOnly": true, - "type": "string" - }, - "operatingSystemType": { - "description": "The operating system type where this account applies.", - "enum": [ - "OPERATING_SYSTEM_TYPE_UNSPECIFIED", - "LINUX", - "WINDOWS" - ], - "enumDescriptions": [ - "The operating system type associated with the user account information is unspecified.", - "Linux user account information.", - "Windows user account information." - ], - "type": "string" - }, - "primary": { - "description": "Only one POSIX account can be marked as primary.", - "type": "boolean" - }, - "shell": { - "description": "The path to the logic shell for this account.", - "type": "string" - }, - "systemId": { - "description": "System identifier for which account the username or uid applies to. By default, the empty value is used.", - "type": "string" - }, - "uid": { - "description": "The user ID.", - "format": "int64", - "type": "string" - }, - "username": { - "description": "The username of the POSIX account.", - "type": "string" - } - }, - "type": "object" - }, - "SshPublicKey": { - "description": "The SSH public key information associated with a Google account.", - "id": "SshPublicKey", - "properties": { - "expirationTimeUsec": { - "description": "An expiration time in microseconds since epoch.", - "format": "int64", - "type": "string" - }, - "fingerprint": { - "description": "Output only. The SHA-256 fingerprint of the SSH public key.", - "readOnly": true, - "type": "string" - }, - "key": { - "description": "Public key text in SSH format, defined by RFC4253 section 6.6.", - "type": "string" - }, - "name": { - "description": "Output only. The canonical resource name.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud OS Login API", - "version": "v1alpha", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/oslogin__v1beta.json b/discovery/googleapis_beta/oslogin__v1beta.json deleted file mode 100644 index f2929aa..0000000 --- a/discovery/googleapis_beta/oslogin__v1beta.json +++ /dev/null
@@ -1,454 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/compute": { - "description": "View and manage your Google Compute Engine resources" - }, - "https://www.googleapis.com/auth/compute.readonly": { - "description": "View your Google Compute Engine resources" - } - } - } - }, - "basePath": "", - "baseUrl": "https://oslogin.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud OS Login", - "description": "You can use OS Login to manage access to your VM instances using IAM roles.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "oslogin:v1beta", - "kind": "discovery#restDescription", - "name": "oslogin", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "users": { - "methods": { - "getLoginProfile": { - "description": "Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.", - "httpMethod": "GET", - "id": "oslogin.users.getLoginProfile", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The unique ID for the user in format `users/{user}`.", - "location": "path", - "pattern": "^users/[^/]+$", - "required": true, - "type": "string" - }, - "projectId": { - "description": "The project ID of the Google Cloud Platform project.", - "location": "query", - "type": "string" - }, - "systemId": { - "description": "A system ID for filtering the results of the request.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/{+name}/loginProfile", - "response": { - "$ref": "LoginProfile" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "importSshPublicKey": { - "description": "Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.", - "httpMethod": "POST", - "id": "oslogin.users.importSshPublicKey", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The unique ID for the user in format `users/{user}`.", - "location": "path", - "pattern": "^users/[^/]+$", - "required": true, - "type": "string" - }, - "projectId": { - "description": "The project ID of the Google Cloud Platform project.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/{+parent}:importSshPublicKey", - "request": { - "$ref": "SshPublicKey" - }, - "response": { - "$ref": "ImportSshPublicKeyResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - } - }, - "resources": { - "projects": { - "methods": { - "delete": { - "description": "Deletes a POSIX account.", - "httpMethod": "DELETE", - "id": "oslogin.users.projects.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`.", - "location": "path", - "pattern": "^users/[^/]+/projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - } - } - }, - "sshPublicKeys": { - "methods": { - "delete": { - "description": "Deletes an SSH public key.", - "httpMethod": "DELETE", - "id": "oslogin.users.sshPublicKeys.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", - "location": "path", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "description": "Retrieves an SSH public key.", - "httpMethod": "GET", - "id": "oslogin.users.sshPublicKeys.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", - "location": "path", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "SshPublicKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "patch": { - "description": "Updates an SSH public key and returns the profile information. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "oslogin.users.sshPublicKeys.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format `users/{user}/sshPublicKeys/{fingerprint}`.", - "location": "path", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Mask to control which fields get updated. Updates all if not present.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/{+name}", - "request": { - "$ref": "SshPublicKey" - }, - "response": { - "$ref": "SshPublicKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - } - } - } - } - } - }, - "revision": "20200925", - "rootUrl": "https://oslogin.googleapis.com/", - "schemas": { - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "ImportSshPublicKeyResponse": { - "description": "A response message for importing an SSH public key.", - "id": "ImportSshPublicKeyResponse", - "properties": { - "details": { - "description": "Detailed information about import results.", - "type": "string" - }, - "loginProfile": { - "$ref": "LoginProfile", - "description": "The login profile information for the user." - } - }, - "type": "object" - }, - "LoginProfile": { - "description": "The user profile information used for logging in to a virtual machine on Google Compute Engine.", - "id": "LoginProfile", - "properties": { - "name": { - "description": "Required. A unique user ID.", - "type": "string" - }, - "posixAccounts": { - "description": "The list of POSIX accounts associated with the user.", - "items": { - "$ref": "PosixAccount" - }, - "type": "array" - }, - "sshPublicKeys": { - "additionalProperties": { - "$ref": "SshPublicKey" - }, - "description": "A map from SSH public key fingerprint to the associated key object.", - "type": "object" - } - }, - "type": "object" - }, - "PosixAccount": { - "description": "The POSIX account information associated with a Google account.", - "id": "PosixAccount", - "properties": { - "accountId": { - "description": "Output only. A POSIX account identifier.", - "readOnly": true, - "type": "string" - }, - "gecos": { - "description": "The GECOS (user information) entry for this account.", - "type": "string" - }, - "gid": { - "description": "The default group ID.", - "format": "int64", - "type": "string" - }, - "homeDirectory": { - "description": "The path to the home directory for this account.", - "type": "string" - }, - "name": { - "description": "Output only. The canonical resource name.", - "readOnly": true, - "type": "string" - }, - "operatingSystemType": { - "description": "The operating system type where this account applies.", - "enum": [ - "OPERATING_SYSTEM_TYPE_UNSPECIFIED", - "LINUX", - "WINDOWS" - ], - "enumDescriptions": [ - "The operating system type associated with the user account information is unspecified.", - "Linux user account information.", - "Windows user account information." - ], - "type": "string" - }, - "primary": { - "description": "Only one POSIX account can be marked as primary.", - "type": "boolean" - }, - "shell": { - "description": "The path to the logic shell for this account.", - "type": "string" - }, - "systemId": { - "description": "System identifier for which account the username or uid applies to. By default, the empty value is used.", - "type": "string" - }, - "uid": { - "description": "The user ID.", - "format": "int64", - "type": "string" - }, - "username": { - "description": "The username of the POSIX account.", - "type": "string" - } - }, - "type": "object" - }, - "SshPublicKey": { - "description": "The SSH public key information associated with a Google account.", - "id": "SshPublicKey", - "properties": { - "expirationTimeUsec": { - "description": "An expiration time in microseconds since epoch.", - "format": "int64", - "type": "string" - }, - "fingerprint": { - "description": "Output only. The SHA-256 fingerprint of the SSH public key.", - "readOnly": true, - "type": "string" - }, - "key": { - "description": "Public key text in SSH format, defined by RFC4253 section 6.6.", - "type": "string" - }, - "name": { - "description": "Output only. The canonical resource name.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud OS Login API", - "version": "v1beta", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/privateca__v1beta1.json b/discovery/googleapis_beta/privateca__v1beta1.json new file mode 100644 index 0000000..9f34c62 --- /dev/null +++ b/discovery/googleapis_beta/privateca__v1beta1.json
@@ -0,0 +1,3584 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://privateca.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Certificate Authority Service", + "description": "The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.\" ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "privateca:v1beta1", + "kind": "discovery#restDescription", + "name": "privateca", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "privateca.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "privateca.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "certificateAuthorities": { + "methods": { + "activate": { + "description": "Activate a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:activate", + "request": { + "$ref": "ActivateCertificateAuthorityRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Create a new CertificateAuthority in a given Project and Location.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "certificateAuthorityId": { + "description": "Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/certificateAuthorities", + "request": { + "$ref": "CertificateAuthority" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disable a CertificateAuthority.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:disable", + "request": { + "$ref": "DisableCertificateAuthorityRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enable": { + "description": "Enable a CertificateAuthority.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:enable", + "request": { + "$ref": "EnableCertificateAuthorityRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetch": { + "description": "Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state PENDING_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.fetch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:fetch", + "response": { + "$ref": "FetchCertificateAuthorityCsrResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns a CertificateAuthority.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CertificateAuthority to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "CertificateAuthority" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CertificateAuthorities.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Only include resources that match the filter in the response.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specify how the results should be sorted.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListCertificateAuthoritiesResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location associated with the CertificateAuthorities, in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/certificateAuthorities", + "response": { + "$ref": "ListCertificateAuthoritiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a CertificateAuthority.", + "httpMethod": "PATCH", + "id": "privateca.projects.locations.certificateAuthorities.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. A list of fields to be updated in this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "CertificateAuthority" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restore": { + "description": "Restore a CertificateAuthority that is scheduled for deletion.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:restore", + "request": { + "$ref": "RestoreCertificateAuthorityRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "scheduleDelete": { + "description": "Schedule a CertificateAuthority for deletion.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.scheduleDelete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:scheduleDelete", + "request": { + "$ref": "ScheduleDeleteCertificateAuthorityRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "certificateRevocationLists": { + "methods": { + "get": { + "description": "Returns a CertificateRevocationList.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CertificateRevocationList to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "CertificateRevocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CertificateRevocationLists.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Only include resources that match the filter in the response.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specify how the results should be sorted.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListCertificateRevocationListsResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location associated with the CertificateRevocationLists, in the format `projects/*/locations/*/certificateauthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/certificateRevocationLists", + "response": { + "$ref": "ListCertificateRevocationListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a CertificateRevocationList.", + "httpMethod": "PATCH", + "id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource path for this CertificateRevocationList in the format `projects/*/locations/*/certificateAuthorities/*/ certificateRevocationLists/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. A list of fields to be updated in this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "CertificateRevocationList" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.certificateRevocationLists.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificateRevocationLists/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "certificates": { + "methods": { + "create": { + "description": "Create a new Certificate in a given Project, Location from a particular CertificateAuthority.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.certificates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "certificateId": { + "description": "Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a CertificateAuthority in the Enterprise CertificateAuthority.Tier, but is optional and its value is ignored otherwise.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location and CertificateAuthority associated with the Certificate, in the format `projects/*/locations/*/certificateAuthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/certificates", + "request": { + "$ref": "Certificate" + }, + "response": { + "$ref": "Certificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns a Certificate.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.certificates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Certificate to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Certificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Certificates.", + "httpMethod": "GET", + "id": "privateca.projects.locations.certificateAuthorities.certificates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see [Certificates Filtering documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specify how the results should be sorted. For details on supported fields and syntax, see [Certificates Sorting documentation](https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListCertificatesResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location associated with the Certificates, in the format `projects/*/locations/*/certificateauthorities/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/certificates", + "response": { + "$ref": "ListCertificatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a Certificate. Currently, the only field you can update is the labels field.", + "httpMethod": "PATCH", + "id": "privateca.projects.locations.certificateAuthorities.certificates.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource path for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. A list of fields to be updated in this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "Certificate" + }, + "response": { + "$ref": "Certificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "revoke": { + "description": "Revoke a Certificate.", + "httpMethod": "POST", + "id": "privateca.projects.locations.certificateAuthorities.certificates.revoke", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateAuthorities/[^/]+/certificates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:revoke", + "request": { + "$ref": "RevokeCertificateRequest" + }, + "response": { + "$ref": "Certificate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "id": "privateca.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "privateca.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "privateca.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "privateca.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "reusableConfigs": { + "methods": { + "get": { + "description": "Returns a ReusableConfig.", + "httpMethod": "GET", + "id": "privateca.projects.locations.reusableConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReusableConfigs to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "ReusableConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "httpMethod": "GET", + "id": "privateca.projects.locations.reusableConfigs.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ReusableConfigs.", + "httpMethod": "GET", + "id": "privateca.projects.locations.reusableConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Only include resources that match the filter in the response.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specify how the results should be sorted.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Limit on the number of ReusableConfigs to include in the response. Further ReusableConfigs can subsequently be obtained by including the ListReusableConfigsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Pagination token, returned earlier via ListReusableConfigsResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location associated with the ReusableConfigs, in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/reusableConfigs", + "response": { + "$ref": "ListReusableConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "httpMethod": "POST", + "id": "privateca.projects.locations.reusableConfigs.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "httpMethod": "POST", + "id": "privateca.projects.locations.reusableConfigs.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reusableConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210125", + "rootUrl": "https://privateca.googleapis.com/", + "schemas": { + "AccessUrls": { + "description": "URLs where a CertificateAuthority will publish content.", + "id": "AccessUrls", + "properties": { + "caCertificateAccessUrl": { + "description": "The URL where this CertificateAuthority's CA certificate is published. This will only be set for CAs that have been activated.", + "type": "string" + }, + "crlAccessUrl": { + "description": "The URL where this CertificateAuthority's CRLs are published. This will only be set for CAs that have been activated.", + "type": "string" + } + }, + "type": "object" + }, + "ActivateCertificateAuthorityRequest": { + "description": "Request message for CertificateAuthorityService.ActivateCertificateAuthority.", + "id": "ActivateCertificateAuthorityRequest", + "properties": { + "pemCaCertificate": { + "description": "Required. The signed CA certificate issued from FetchCertificateAuthorityCsrResponse.pem_csr.", + "type": "string" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + }, + "subordinateConfig": { + "$ref": "SubordinateConfig", + "description": "Required. Must include information about the issuer of 'pem_ca_certificate', and any further issuers until the self-signed CA." + } + }, + "type": "object" + }, + "AllowedConfigList": { + "id": "AllowedConfigList", + "properties": { + "allowedConfigValues": { + "description": "Required. All Certificates issued by the CertificateAuthority must match at least one listed ReusableConfigWrapper. If a ReusableConfigWrapper has an empty field, any value will be allowed for that field.", + "items": { + "$ref": "ReusableConfigWrapper" + }, + "type": "array" + } + }, + "type": "object" + }, + "AllowedSubjectAltNames": { + "description": "AllowedSubjectAltNames specifies the allowed values for SubjectAltNames by the CertificateAuthority when issuing Certificates.", + "id": "AllowedSubjectAltNames", + "properties": { + "allowCustomSans": { + "description": "Optional. Specifies if to allow custom X509Extension values.", + "type": "boolean" + }, + "allowGlobbingDnsWildcards": { + "description": "Optional. Specifies if glob patterns used for allowed_dns_names allow wildcard certificates. If this is set, certificate requests with wildcard domains will be permitted to match a glob pattern specified in allowed_dns_names. Otherwise, certificate requests with wildcard domains will be permitted only if allowed_dns_names contains a literal wildcard.", + "type": "boolean" + }, + "allowedDnsNames": { + "description": "Optional. Contains valid, fully-qualified host names. Glob patterns are also supported. To allow an explicit wildcard certificate, escape with backlash (i.e. \"\\*\"). E.g. for globbed entries: '*bar.com' will allow 'foo.bar.com', but not '*.bar.com', unless the allow_globbing_dns_wildcards field is set. E.g. for wildcard entries: '\\*.bar.com' will allow '*.bar.com', but not 'foo.bar.com'.", + "items": { + "type": "string" + }, + "type": "array" + }, + "allowedEmailAddresses": { + "description": "Optional. Contains valid RFC 2822 E-mail addresses. Glob patterns are also supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "allowedIps": { + "description": "Optional. Contains valid 32-bit IPv4 addresses and subnet ranges or RFC 4291 IPv6 addresses and subnet ranges. Subnet ranges are specified using the '/' notation (e.g. 10.0.0.0/8, 2001:700:300:1800::/64). Glob patterns are supported only for ip address entries (i.e. not for subnet ranges).", + "items": { + "type": "string" + }, + "type": "array" + }, + "allowedUris": { + "description": "Optional. Contains valid RFC 3986 URIs. Glob patterns are also supported. To match across path seperators (i.e. '/') use the double star glob pattern (i.e. '**').", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuditConfig": { + "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.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "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" + }, + "AuditLogConfig": { + "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.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "BillingView": { + "description": "Message for reporting billing requests through Eventstream.", + "id": "BillingView", + "properties": { + "reportRequests": { + "description": "Billing requests to be reported for cloud.eventstream.v2.ResourceEvent Each request contains billing operations to be reported under a service name. See go/billing-view-construction for documentation on constructing billing view report requests.", + "items": { + "$ref": "GoogleApiServicecontrolV1ReportRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "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 members 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)." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + }, + "type": "object" + }, + "CaOptions": { + "description": "Describes values that are relevant in a CA certificate.", + "id": "CaOptions", + "properties": { + "isCa": { + "description": "Optional. Refers to the \"CA\" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.", + "type": "boolean" + }, + "maxIssuerPathLength": { + "description": "Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Certificate": { + "description": "A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.", + "id": "Certificate", + "properties": { + "certificateDescription": { + "$ref": "CertificateDescription", + "description": "Output only. A structured description of the issued X.509 certificate.", + "readOnly": true + }, + "config": { + "$ref": "CertificateConfig", + "description": "Immutable. A description of the certificate and key that does not require X.509 or ASN.1." + }, + "createTime": { + "description": "Output only. The time at which this Certificate was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels with user-defined metadata.", + "type": "object" + }, + "lifetime": { + "description": "Required. Immutable. The desired lifetime of a certificate. Used to create the \"not_before_time\" and \"not_after_time\" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain.", + "format": "google-duration", + "type": "string" + }, + "name": { + "description": "Output only. The resource path for this Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.", + "readOnly": true, + "type": "string" + }, + "pemCertificate": { + "description": "Output only. The pem-encoded, signed X.509 certificate.", + "readOnly": true, + "type": "string" + }, + "pemCertificateChain": { + "description": "Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "pemCsr": { + "description": "Immutable. A pem-encoded X.509 certificate signing request (CSR).", + "type": "string" + }, + "revocationDetails": { + "$ref": "RevocationDetails", + "description": "Output only. Details regarding the revocation of this Certificate. This Certificate is considered revoked if and only if this field is present.", + "readOnly": true + }, + "updateTime": { + "description": "Output only. The time at which this Certificate was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CertificateAuthority": { + "description": "A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.", + "id": "CertificateAuthority", + "properties": { + "accessUrls": { + "$ref": "AccessUrls", + "description": "Output only. URLs for accessing content published by this CA, such as the CA certificate and CRLs.", + "readOnly": true + }, + "caCertificateDescriptions": { + "description": "Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root.", + "items": { + "$ref": "CertificateDescription" + }, + "readOnly": true, + "type": "array" + }, + "certificatePolicy": { + "$ref": "CertificateAuthorityPolicy", + "description": "Optional. The CertificateAuthorityPolicy to enforce when issuing Certificates from this CertificateAuthority." + }, + "config": { + "$ref": "CertificateConfig", + "description": "Required. Immutable. The config used to create a self-signed X.509 certificate or CSR." + }, + "createTime": { + "description": "Output only. The time at which this CertificateAuthority was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. The time at which this CertificateAuthority will be deleted, if scheduled for deletion.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "gcsBucket": { + "description": "Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created.", + "type": "string" + }, + "issuingOptions": { + "$ref": "IssuingOptions", + "description": "Optional. The IssuingOptions to follow when issuing Certificates from this CertificateAuthority." + }, + "keySpec": { + "$ref": "KeyVersionSpec", + "description": "Required. Immutable. Used when issuing certificates for this CertificateAuthority. If this CertificateAuthority is a self-signed CertificateAuthority, this key is also used to sign the self-signed CA certificate. Otherwise, it is used to sign a CSR." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels with user-defined metadata.", + "type": "object" + }, + "lifetime": { + "description": "Required. The desired lifetime of the CA certificate. Used to create the \"not_before_time\" and \"not_after_time\" fields inside an X.509 certificate.", + "format": "google-duration", + "type": "string" + }, + "name": { + "description": "Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/certificateAuthorities/*`.", + "readOnly": true, + "type": "string" + }, + "pemCaCertificates": { + "description": "Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The State for this CertificateAuthority.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "PENDING_ACTIVATION", + "PENDING_DELETION" + ], + "enumDescriptions": [ + "Not specified.", + "Certificates can be issued from this CA. CRLs will be generated for this CA.", + "Certificates cannot be issued from this CA. CRLs will still be generated.", + "Certificates cannot be issued from this CA. CRLs will not be generated.", + "Certificates cannot be issued from this CA. CRLs will not be generated." + ], + "readOnly": true, + "type": "string" + }, + "subordinateConfig": { + "$ref": "SubordinateConfig", + "description": "Optional. If this is a subordinate CertificateAuthority, this field will be set with the subordinate configuration, which describes its issuers. This may be updated, but this CertificateAuthority must continue to validate." + }, + "tier": { + "description": "Required. Immutable. The Tier of this CertificateAuthority.", + "enum": [ + "TIER_UNSPECIFIED", + "ENTERPRISE", + "DEVOPS" + ], + "enumDescriptions": [ + "Not specified.", + "Enterprise tier.", + "DevOps tier." + ], + "type": "string" + }, + "type": { + "description": "Required. Immutable. The Type of this CertificateAuthority.", + "enum": [ + "TYPE_UNSPECIFIED", + "SELF_SIGNED", + "SUBORDINATE" + ], + "enumDescriptions": [ + "Not specified.", + "Self-signed CA.", + "Subordinate CA. Could be issued by a Private CA CertificateAuthority or an unmanaged CA." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which this CertificateAuthority was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CertificateAuthorityPolicy": { + "description": "The issuing policy for a CertificateAuthority. Certificates will not be successfully issued from this CertificateAuthority if they violate the policy.", + "id": "CertificateAuthorityPolicy", + "properties": { + "allowedCommonNames": { + "description": "Optional. If any value is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "allowedConfigList": { + "$ref": "AllowedConfigList", + "description": "Optional. All Certificates issued by the CertificateAuthority must match at least one listed ReusableConfigWrapper in the list." + }, + "allowedIssuanceModes": { + "$ref": "IssuanceModes", + "description": "Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates." + }, + "allowedLocationsAndOrganizations": { + "description": "Optional. If any Subject is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed Subject. If a Subject has an empty field, any value will be allowed for that field.", + "items": { + "$ref": "Subject" + }, + "type": "array" + }, + "allowedSans": { + "$ref": "AllowedSubjectAltNames", + "description": "Optional. If a AllowedSubjectAltNames is specified here, then all Certificates issued by the CertificateAuthority must match AllowedSubjectAltNames. If no value or an empty value is specified, any value will be allowed for the SubjectAltNames field." + }, + "maximumLifetime": { + "description": "Optional. The maximum lifetime allowed by the CertificateAuthority. Note that if the any part if the issuing chain expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated.", + "format": "google-duration", + "type": "string" + }, + "overwriteConfigValues": { + "$ref": "ReusableConfigWrapper", + "description": "Optional. All Certificates issued by the CertificateAuthority will use the provided configuration values, overwriting any requested configuration values." + } + }, + "type": "object" + }, + "CertificateConfig": { + "description": "A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.", + "id": "CertificateConfig", + "properties": { + "publicKey": { + "$ref": "PublicKey", + "description": "Optional. The public key that corresponds to this config. This is, for example, used when issuing Certificates, but not when creating a self-signed CertificateAuthority or CertificateAuthority CSR." + }, + "reusableConfig": { + "$ref": "ReusableConfigWrapper", + "description": "Required. Describes how some of the technical fields in a certificate should be populated." + }, + "subjectConfig": { + "$ref": "SubjectConfig", + "description": "Required. Specifies some of the values in a certificate that are related to the subject." + } + }, + "type": "object" + }, + "CertificateDescription": { + "description": "A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.", + "id": "CertificateDescription", + "properties": { + "aiaIssuingCertificateUrls": { + "description": "Describes lists of issuer CA certificate URLs that appear in the \"Authority Information Access\" extension in the certificate.", + "items": { + "type": "string" + }, + "type": "array" + }, + "authorityKeyId": { + "$ref": "KeyId", + "description": "Identifies the subject_key_id of the parent certificate, per https://tools.ietf.org/html/rfc5280#section-4.2.1.1" + }, + "certFingerprint": { + "$ref": "CertificateFingerprint", + "description": "The hash of the x.509 certificate." + }, + "configValues": { + "$ref": "ReusableConfigValues", + "description": "Describes some of the technical fields in a certificate." + }, + "crlDistributionPoints": { + "description": "Describes a list of locations to obtain CRL information, i.e. the DistributionPoint.fullName described by https://tools.ietf.org/html/rfc5280#section-4.2.1.13", + "items": { + "type": "string" + }, + "type": "array" + }, + "publicKey": { + "$ref": "PublicKey", + "description": "The public key that corresponds to an issued certificate." + }, + "subjectDescription": { + "$ref": "SubjectDescription", + "description": "Describes some of the values in a certificate that are related to the subject and lifetime." + }, + "subjectKeyId": { + "$ref": "KeyId", + "description": "Provides a means of identifiying certificates that contain a particular public key, per https://tools.ietf.org/html/rfc5280#section-4.2.1.2." + } + }, + "type": "object" + }, + "CertificateFingerprint": { + "description": "A group of fingerprints for the x509 certificate.", + "id": "CertificateFingerprint", + "properties": { + "sha256Hash": { + "description": "The SHA 256 hash, encoded in hexadecimal, of the DER x509 certificate.", + "type": "string" + } + }, + "type": "object" + }, + "CertificateRevocationList": { + "description": "A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.", + "id": "CertificateRevocationList", + "properties": { + "accessUrl": { + "description": "Output only. The location where 'pem_crl' can be accessed.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this CertificateRevocationList was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels with user-defined metadata.", + "type": "object" + }, + "name": { + "description": "Output only. The resource path for this CertificateRevocationList in the format `projects/*/locations/*/certificateAuthorities/*/ certificateRevocationLists/*`.", + "readOnly": true, + "type": "string" + }, + "pemCrl": { + "description": "Output only. The PEM-encoded X.509 CRL.", + "readOnly": true, + "type": "string" + }, + "revokedCertificates": { + "description": "Output only. The revoked serial numbers that appear in pem_crl.", + "items": { + "$ref": "RevokedCertificate" + }, + "readOnly": true, + "type": "array" + }, + "sequenceNumber": { + "description": "Output only. The CRL sequence number that appears in pem_crl.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The State for this CertificateRevocationList.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "SUPERSEDED" + ], + "enumDescriptions": [ + "Not specified.", + "The CertificateRevocationList is up to date.", + "The CertificateRevocationList is no longer current." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which this CertificateRevocationList was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DisableCertificateAuthorityRequest": { + "description": "Request message for CertificateAuthorityService.DisableCertificateAuthority.", + "id": "DisableCertificateAuthorityRequest", + "properties": { + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "EnableCertificateAuthorityRequest": { + "description": "Request message for CertificateAuthorityService.EnableCertificateAuthority.", + "id": "EnableCertificateAuthorityRequest", + "properties": { + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "Exemplar": { + "description": "Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.", + "id": "Exemplar", + "properties": { + "attachments": { + "description": "Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "timestamp": { + "description": "The observation (sampling) time of the above value.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Expr": { + "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() < 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", + "properties": { + "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" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "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" + }, + "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" + }, + "ExtendedKeyUsageOptions": { + "description": "KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value.", + "id": "ExtendedKeyUsageOptions", + "properties": { + "clientAuth": { + "description": "Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as \"TLS WWW client authentication\", though regularly used for non-WWW TLS.", + "type": "boolean" + }, + "codeSigning": { + "description": "Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as \"Signing of downloadable executable code client authentication\".", + "type": "boolean" + }, + "emailProtection": { + "description": "Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as \"Email protection\".", + "type": "boolean" + }, + "ocspSigning": { + "description": "Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as \"Signing OCSP responses\".", + "type": "boolean" + }, + "serverAuth": { + "description": "Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as \"TLS WWW server authentication\", though regularly used for non-WWW TLS.", + "type": "boolean" + }, + "timeStamping": { + "description": "Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as \"Binding the hash of an object to a time\".", + "type": "boolean" + } + }, + "type": "object" + }, + "FetchCertificateAuthorityCsrResponse": { + "description": "Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.", + "id": "FetchCertificateAuthorityCsrResponse", + "properties": { + "pemCsr": { + "description": "Output only. The PEM-encoded signed certificate signing request (CSR).", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1AttributeValue": { + "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.", + "id": "GoogleApiServicecontrolV1AttributeValue", + "properties": { + "boolValue": { + "description": "A Boolean value represented by `true` or `false`.", + "type": "boolean" + }, + "intValue": { + "description": "A 64-bit signed integer.", + "format": "int64", + "type": "string" + }, + "stringValue": { + "$ref": "GoogleApiServicecontrolV1TruncatableString", + "description": "A string up to 256 bytes long." + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1Attributes": { + "description": "A set of attributes, each in the format `[KEY]:[VALUE]`.", + "id": "GoogleApiServicecontrolV1Attributes", + "properties": { + "attributeMap": { + "additionalProperties": { + "$ref": "GoogleApiServicecontrolV1AttributeValue" + }, + "description": "The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: \"/instance_id\": \"my-instance\" \"/http/user_agent\": \"\" \"/http/request_bytes\": 300 \"abc.com/myattribute\": true", + "type": "object" + }, + "droppedAttributesCount": { + "description": "The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1Distribution": { + "description": "Distribution represents a frequency distribution of double-valued sample points. It contains the size of the population of sample points plus additional optional information: - the arithmetic mean of the samples - the minimum and maximum of the samples - the sum-squared-deviation of the samples, used to compute variance - a histogram of the values of the sample points", + "id": "GoogleApiServicecontrolV1Distribution", + "properties": { + "bucketCounts": { + "description": "The number of samples in each histogram bucket. `bucket_counts` are optional. If present, they must sum to the `count` value. The buckets are defined below in `bucket_option`. There are N buckets. `bucket_counts[0]` is the number of samples in the underflow bucket. `bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples in each of the finite buckets. And `bucket_counts[N] is the number of samples in the overflow bucket. See the comments of `bucket_option` below for more details. Any suffix of trailing zeros may be omitted.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "count": { + "description": "The total number of samples in the distribution. Must be >= 0.", + "format": "int64", + "type": "string" + }, + "exemplars": { + "description": "Example points. Must be in increasing order of `value` field.", + "items": { + "$ref": "Exemplar" + }, + "type": "array" + }, + "explicitBuckets": { + "$ref": "GoogleApiServicecontrolV1ExplicitBuckets", + "description": "Buckets with arbitrary user-provided width." + }, + "exponentialBuckets": { + "$ref": "GoogleApiServicecontrolV1ExponentialBuckets", + "description": "Buckets with exponentially growing width." + }, + "linearBuckets": { + "$ref": "GoogleApiServicecontrolV1LinearBuckets", + "description": "Buckets with constant width." + }, + "maximum": { + "description": "The maximum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "mean": { + "description": "The arithmetic mean of the samples in the distribution. If `count` is zero then this field must be zero.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "The minimum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "sumOfSquaredDeviation": { + "description": "The sum of squared deviations from the mean: Sum[i=1..count]((x_i - mean)^2) where each x_i is a sample values. If `count` is zero then this field must be zero, otherwise validation of the request fails.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1ExplicitBuckets": { + "description": "Describing buckets with arbitrary user-provided width.", + "id": "GoogleApiServicecontrolV1ExplicitBuckets", + "properties": { + "bounds": { + "description": "'bound' is a list of strictly increasing boundaries between buckets. Note that a list of length N-1 defines N buckets because of fenceposting. See comments on `bucket_options` for details. The i'th finite bucket covers the interval [bound[i-1], bound[i]) where i ranges from 1 to bound_size() - 1. Note that there are no finite buckets at all if 'bound' only contains a single element; in that special case the single bound defines the boundary between the underflow and overflow buckets. bucket number lower bound upper bound i == 0 (underflow) -inf bound[i] 0 < i < bound_size() bound[i-1] bound[i] i == bound_size() (overflow) bound[i-1] +inf", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1ExponentialBuckets": { + "description": "Describing buckets with exponentially growing width.", + "id": "GoogleApiServicecontrolV1ExponentialBuckets", + "properties": { + "growthFactor": { + "description": "The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be larger than 1.0.", + "format": "double", + "type": "number" + }, + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "The i'th exponential bucket covers the interval [scale * growth_factor^(i-1), scale * growth_factor^i) where i ranges from 1 to num_finite_buckets inclusive. Must be > 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1HttpRequest": { + "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", + "id": "GoogleApiServicecontrolV1HttpRequest", + "properties": { + "cacheFillBytes": { + "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", + "format": "int64", + "type": "string" + }, + "cacheHit": { + "description": "Whether or not an entity was served from cache (with or without validation).", + "type": "boolean" + }, + "cacheLookup": { + "description": "Whether or not a cache lookup was attempted.", + "type": "boolean" + }, + "cacheValidatedWithOriginServer": { + "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.", + "type": "boolean" + }, + "latency": { + "description": "The request processing latency on the server, from the time the request was received until the response was sent.", + "format": "google-duration", + "type": "string" + }, + "protocol": { + "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", + "type": "string" + }, + "referer": { + "description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "type": "string" + }, + "remoteIp": { + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.", + "type": "string" + }, + "requestMethod": { + "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.", + "type": "string" + }, + "requestSize": { + "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", + "format": "int64", + "type": "string" + }, + "requestUrl": { + "description": "The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `\"http://example.com/some/info?color=red\"`.", + "type": "string" + }, + "responseSize": { + "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.", + "format": "int64", + "type": "string" + }, + "serverIp": { + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", + "type": "string" + }, + "status": { + "description": "The response code indicating the status of the response. Examples: 200, 404.", + "format": "int32", + "type": "integer" + }, + "userAgent": { + "description": "The user agent sent by the client. Example: `\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1LinearBuckets": { + "description": "Describing buckets with constant width.", + "id": "GoogleApiServicecontrolV1LinearBuckets", + "properties": { + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets, the total number of buckets is `num_finite_buckets` + 2. See comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive.", + "format": "double", + "type": "number" + }, + "width": { + "description": "The i'th linear bucket covers the interval [offset + (i-1) * width, offset + i * width) where i ranges from 1 to num_finite_buckets, inclusive. Must be strictly positive.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1LogEntry": { + "description": "An individual log entry.", + "id": "GoogleApiServicecontrolV1LogEntry", + "properties": { + "httpRequest": { + "$ref": "GoogleApiServicecontrolV1HttpRequest", + "description": "Optional. Information about the HTTP request associated with this log entry, if applicable." + }, + "insertId": { + "description": "A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional information about the log entry.", + "type": "object" + }, + "name": { + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`, `\"book_log\"`.", + "type": "string" + }, + "operation": { + "$ref": "GoogleApiServicecontrolV1LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if applicable." + }, + "protoPayload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog.", + "type": "object" + }, + "severity": { + "description": "The severity of the log entry. The default value is `LogSeverity.DEFAULT`.", + "enum": [ + "DEFAULT", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or a configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ], + "type": "string" + }, + "sourceLocation": { + "$ref": "GoogleApiServicecontrolV1LogEntrySourceLocation", + "description": "Optional. Source code location information associated with the log entry, if any." + }, + "structPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", + "type": "object" + }, + "textPayload": { + "description": "The log entry payload, represented as a Unicode string (UTF-8).", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred. If omitted, defaults to operation start time.", + "format": "google-datetime", + "type": "string" + }, + "trace": { + "description": "Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1LogEntryOperation": { + "description": "Additional information about a potentially long-running operation with which a log entry is associated.", + "id": "GoogleApiServicecontrolV1LogEntryOperation", + "properties": { + "first": { + "description": "Optional. Set this to True if this is the first log entry in the operation.", + "type": "boolean" + }, + "id": { + "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.", + "type": "string" + }, + "last": { + "description": "Optional. Set this to True if this is the last log entry in the operation.", + "type": "boolean" + }, + "producer": { + "description": "Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1LogEntrySourceLocation": { + "description": "Additional information about the source code location that produced the log entry.", + "id": "GoogleApiServicecontrolV1LogEntrySourceLocation", + "properties": { + "file": { + "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", + "type": "string" + }, + "function": { + "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python).", + "type": "string" + }, + "line": { + "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1MetricValue": { + "description": "Represents a single metric value.", + "id": "GoogleApiServicecontrolV1MetricValue", + "properties": { + "boolValue": { + "description": "A boolean value.", + "type": "boolean" + }, + "distributionValue": { + "$ref": "GoogleApiServicecontrolV1Distribution", + "description": "A distribution value." + }, + "doubleValue": { + "description": "A double precision floating point value.", + "format": "double", + "type": "number" + }, + "endTime": { + "description": "The end of the time period over which this metric value's measurement applies. If not specified, google.api.servicecontrol.v1.Operation.end_time will be used.", + "format": "google-datetime", + "type": "string" + }, + "int64Value": { + "description": "A signed 64-bit integer value.", + "format": "int64", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels describing the metric value. See comments on google.api.servicecontrol.v1.Operation.labels for the overriding relationship. Note that this map must not contain monitored resource labels.", + "type": "object" + }, + "moneyValue": { + "$ref": "Money", + "description": "A money value." + }, + "startTime": { + "description": "The start of the time period over which this metric value's measurement applies. The time period has different semantics for different metric types (cumulative, delta, and gauge). See the metric definition documentation in the service configuration for details. If not specified, google.api.servicecontrol.v1.Operation.start_time will be used.", + "format": "google-datetime", + "type": "string" + }, + "stringValue": { + "description": "A text string value.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1MetricValueSet": { + "description": "Represents a set of metric values in the same metric. Each metric value in the set should have a unique combination of start time, end time, and label values.", + "id": "GoogleApiServicecontrolV1MetricValueSet", + "properties": { + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, + "metricValues": { + "description": "The values in this metric.", + "items": { + "$ref": "GoogleApiServicecontrolV1MetricValue" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1Operation": { + "description": "Represents information regarding an operation.", + "id": "GoogleApiServicecontrolV1Operation", + "properties": { + "consumerId": { + "description": "Identity of the consumer who is using the service. This field should be filled in for the operations initiated by a consumer, but not for service-initiated operations that are not related to a specific consumer. - This can be in one of the following formats: - project:PROJECT_ID, - project`_`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api`_`key:API_KEY.", + "type": "string" + }, + "endTime": { + "description": "End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.", + "format": "google-datetime", + "type": "string" + }, + "extensions": { + "description": "Unimplemented.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "importance": { + "description": "DO NOT USE. This is an experimental field.", + "enum": [ + "LOW", + "HIGH", + "DEBUG" + ], + "enumDescriptions": [ + "Allows data caching, batching, and aggregation. It provides higher performance with higher data loss risk.", + "Disables data aggregation to minimize data loss. It is for operations that contains significant monetary value or audit trail. This feature only applies to the client libraries.", + "Deprecated. Do not use. Disables data aggregation and enables additional validation logic. It should only be used during the onboarding process. It is only available to Google internal services, and the service must be approved by chemist-dev@google.com in order to use this level." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels describing the operation. Only the following labels are allowed: - Labels describing monitored resources as defined in the service configuration. - Default labels of metric values. When specified, labels defined in the metric value override these default. - The following labels defined by Google Cloud Platform: - `cloud.googleapis.com/location` describing the location where the operation happened, - `servicecontrol.googleapis.com/user_agent` describing the user agent of the API request, - `servicecontrol.googleapis.com/service_agent` describing the service used to handle the API request (e.g. ESP), - `servicecontrol.googleapis.com/platform` describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.", + "type": "object" + }, + "logEntries": { + "description": "Represents information to be logged.", + "items": { + "$ref": "GoogleApiServicecontrolV1LogEntry" + }, + "type": "array" + }, + "metricValueSets": { + "description": "Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition. Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.", + "items": { + "$ref": "GoogleApiServicecontrolV1MetricValueSet" + }, + "type": "array" + }, + "operationId": { + "description": "Identity of the operation. This must be unique within the scope of the service that generated the operation. If the service calls Check() and Report() on the same operation, the two calls should carry the same id. UUID version 4 is recommended, though not required. In scenarios where an operation is computed from existing information and an idempotent id is desirable for deduplication purpose, UUID version 5 is recommended. See RFC 4122 for details.", + "type": "string" + }, + "operationName": { + "description": "Fully qualified name of the operation. Reserved for future use.", + "type": "string" + }, + "quotaProperties": { + "$ref": "GoogleApiServicecontrolV1QuotaProperties", + "description": "Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed." + }, + "resources": { + "description": "The resources that are involved in the operation. The maximum supported number of entries in this field is 100.", + "items": { + "$ref": "GoogleApiServicecontrolV1ResourceInfo" + }, + "type": "array" + }, + "startTime": { + "description": "Required. Start time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "traceSpans": { + "description": "Unimplemented. A list of Cloud Trace spans. The span names shall contain the id of the destination project which can be either the produce or the consumer project.", + "items": { + "$ref": "GoogleApiServicecontrolV1TraceSpan" + }, + "type": "array" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Private Preview. This feature is only available for approved services. User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1QuotaProperties": { + "description": "Represents the properties needed for quota operations.", + "id": "GoogleApiServicecontrolV1QuotaProperties", + "properties": { + "quotaMode": { + "description": "Quota mode for this operation.", + "enum": [ + "ACQUIRE", + "ACQUIRE_BEST_EFFORT", + "CHECK", + "RELEASE" + ], + "enumDescriptions": [ + "Decreases available quota by the cost specified for the operation. If cost is higher than available quota, operation fails and returns error.", + "Decreases available quota by the cost specified for the operation. If cost is higher than available quota, operation does not fail and available quota goes down to zero but it returns error.", + "Does not change any available quota. Only checks if there is enough quota. No lock is placed on the checked tokens neither.", + "Increases available quota by the operation cost specified for the operation." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1ReportRequest": { + "description": "Request message for the Report method.", + "id": "GoogleApiServicecontrolV1ReportRequest", + "properties": { + "operations": { + "description": "Operations to be reported. Typically the service should report one operation per request. Putting multiple operations into a single request is allowed, but should be used only when multiple operations are natually available at the time of the report. There is no limit on the number of operations in the same ReportRequest, however the ReportRequest size should be no larger than 1MB. See ReportResponse.report_errors for partial failure behavior.", + "items": { + "$ref": "GoogleApiServicecontrolV1Operation" + }, + "type": "array" + }, + "serviceConfigId": { + "description": "Specifies which version of service config should be used to process the request. If unspecified or no matching version can be found, the latest one will be used.", + "type": "string" + }, + "serviceName": { + "description": "The service name as specified in its service configuration. For example, `\"pubsub.googleapis.com\"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1ResourceInfo": { + "description": "Describes a resource associated with this operation.", + "id": "GoogleApiServicecontrolV1ResourceInfo", + "properties": { + "resourceContainer": { + "description": "The identifier of the parent of this resource instance. Must be in one of the following formats: - `projects/` - `folders/` - `organizations/`", + "type": "string" + }, + "resourceLocation": { + "description": "The location of the resource. If not empty, the resource will be checked against location policy. The value must be a valid zone, region or multiregion. For example: \"europe-west4\" or \"northamerica-northeast1-a\"", + "type": "string" + }, + "resourceName": { + "description": "Name of the resource. This is used for auditing purposes.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1TraceSpan": { + "description": "A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.", + "id": "GoogleApiServicecontrolV1TraceSpan", + "properties": { + "attributes": { + "$ref": "GoogleApiServicecontrolV1Attributes", + "description": "A set of attributes on the span. You can have up to 32 attributes per span." + }, + "childSpanCount": { + "description": "An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "$ref": "GoogleApiServicecontrolV1TruncatableString", + "description": "A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces." + }, + "endTime": { + "description": "The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.", + "type": "string" + }, + "parentSpanId": { + "description": "The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.", + "type": "string" + }, + "sameProcessAsParentSpan": { + "description": "(Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.", + "type": "boolean" + }, + "spanId": { + "description": "The [SPAN_ID] portion of the span's resource name.", + "type": "string" + }, + "spanKind": { + "description": "Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call.", + "enum": [ + "SPAN_KIND_UNSPECIFIED", + "INTERNAL", + "SERVER", + "CLIENT", + "PRODUCER", + "CONSUMER" + ], + "enumDescriptions": [ + "Unspecified. Do NOT use as default. Implementations MAY assume SpanKind.INTERNAL to be default.", + "Indicates that the span is used internally. Default value.", + "Indicates that the span covers server-side handling of an RPC or other remote network request.", + "Indicates that the span covers the client-side wrapper around an RPC or other remote request.", + "Indicates that the span describes producer sending a message to a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. publishing a message to a pubsub service).", + "Indicates that the span describes consumer receiving a message from a broker. Unlike client and server, there is no direct critical path latency relationship between producer and consumer spans (e.g. receiving a message from a pubsub service subscription)." + ], + "type": "string" + }, + "startTime": { + "description": "The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.", + "format": "google-datetime", + "type": "string" + }, + "status": { + "$ref": "Status", + "description": "An optional final status for this span." + } + }, + "type": "object" + }, + "GoogleApiServicecontrolV1TruncatableString": { + "description": "Represents a string that might be shortened to a specified length.", + "id": "GoogleApiServicecontrolV1TruncatableString", + "properties": { + "truncatedByteCount": { + "description": "The number of bytes removed from the original string. If this value is 0, then the string was not shortened.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.", + "type": "string" + } + }, + "type": "object" + }, + "IssuanceModes": { + "description": "IssuanceModes specifies the allowed ways in which Certificates may be requested from this CertificateAuthority.", + "id": "IssuanceModes", + "properties": { + "allowConfigBasedIssuance": { + "description": "Required. When true, allows callers to create Certificates by specifying a CertificateConfig.", + "type": "boolean" + }, + "allowCsrBasedIssuance": { + "description": "Required. When true, allows callers to create Certificates by specifying a CSR.", + "type": "boolean" + } + }, + "type": "object" + }, + "IssuingOptions": { + "description": "Options that affect all certificates issued by a CertificateAuthority.", + "id": "IssuingOptions", + "properties": { + "includeCaCertUrl": { + "description": "Required. When true, includes a URL to the issuing CA certificate in the \"authority information access\" X.509 extension.", + "type": "boolean" + }, + "includeCrlAccessUrl": { + "description": "Required. When true, includes a URL to the CRL corresponding to certificates issued from a CertificateAuthority. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked.", + "type": "boolean" + } + }, + "type": "object" + }, + "KeyId": { + "description": "A KeyId identifies a specific public key, usually by hashing the public key.", + "id": "KeyId", + "properties": { + "keyId": { + "description": "Optional. The value of this KeyId encoded in lowercase hexadecimal. This is most likely the 160 bit SHA-1 hash of the public key.", + "type": "string" + } + }, + "type": "object" + }, + "KeyUsage": { + "description": "A KeyUsage describes key usage values that may appear in an X.509 certificate.", + "id": "KeyUsage", + "properties": { + "baseKeyUsage": { + "$ref": "KeyUsageOptions", + "description": "Describes high-level ways in which a key may be used." + }, + "extendedKeyUsage": { + "$ref": "ExtendedKeyUsageOptions", + "description": "Detailed scenarios in which a key may be used." + }, + "unknownExtendedKeyUsages": { + "description": "Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.", + "items": { + "$ref": "ObjectId" + }, + "type": "array" + } + }, + "type": "object" + }, + "KeyUsageOptions": { + "description": "KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.", + "id": "KeyUsageOptions", + "properties": { + "certSign": { + "description": "The key may be used to sign certificates.", + "type": "boolean" + }, + "contentCommitment": { + "description": "The key may be used for cryptographic commitments. Note that this may also be referred to as \"non-repudiation\".", + "type": "boolean" + }, + "crlSign": { + "description": "The key may be used sign certificate revocation lists.", + "type": "boolean" + }, + "dataEncipherment": { + "description": "The key may be used to encipher data.", + "type": "boolean" + }, + "decipherOnly": { + "description": "The key may be used to decipher only.", + "type": "boolean" + }, + "digitalSignature": { + "description": "The key may be used for digital signatures.", + "type": "boolean" + }, + "encipherOnly": { + "description": "The key may be used to encipher only.", + "type": "boolean" + }, + "keyAgreement": { + "description": "The key may be used in a key agreement protocol.", + "type": "boolean" + }, + "keyEncipherment": { + "description": "The key may be used to encipher other keys.", + "type": "boolean" + } + }, + "type": "object" + }, + "KeyVersionSpec": { + "description": "A Cloud KMS key configuration that a CertificateAuthority will use.", + "id": "KeyVersionSpec", + "properties": { + "algorithm": { + "description": "Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as `HSM`.", + "enum": [ + "SIGN_HASH_ALGORITHM_UNSPECIFIED", + "RSA_PSS_2048_SHA256", + "RSA_PSS_3072_SHA256", + "RSA_PSS_4096_SHA256", + "RSA_PKCS1_2048_SHA256", + "RSA_PKCS1_3072_SHA256", + "RSA_PKCS1_4096_SHA256", + "EC_P256_SHA256", + "EC_P384_SHA384" + ], + "enumDescriptions": [ + "Not specified.", + "maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_2048_SHA256", + "maps to CryptoKeyVersionAlgorithm. RSA_SIGN_PSS_3072_SHA256", + "maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_4096_SHA256", + "maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_2048_SHA256", + "maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_3072_SHA256", + "maps to CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_4096_SHA256", + "maps to CryptoKeyVersionAlgorithm.EC_SIGN_P256_SHA256", + "maps to CryptoKeyVersionAlgorithm.EC_SIGN_P384_SHA384" + ], + "type": "string" + }, + "cloudKmsKeyVersion": { + "description": "Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties.", + "type": "string" + } + }, + "type": "object" + }, + "ListCertificateAuthoritiesResponse": { + "description": "Response message for CertificateAuthorityService.ListCertificateAuthorities.", + "id": "ListCertificateAuthoritiesResponse", + "properties": { + "certificateAuthorities": { + "description": "The list of CertificateAuthorities.", + "items": { + "$ref": "CertificateAuthority" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass this value in ListCertificateAuthoritiesRequest.next_page_token to retrieve the next page of results.", + "type": "string" + }, + "unreachable": { + "description": "A list of locations (e.g. \"us-west1\") that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListCertificateRevocationListsResponse": { + "description": "Response message for CertificateAuthorityService.ListCertificateRevocationLists.", + "id": "ListCertificateRevocationListsResponse", + "properties": { + "certificateRevocationLists": { + "description": "The list of CertificateRevocationLists.", + "items": { + "$ref": "CertificateRevocationList" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass this value in ListCertificateRevocationListsRequest.next_page_token to retrieve the next page of results.", + "type": "string" + }, + "unreachable": { + "description": "A list of locations (e.g. \"us-west1\") that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListCertificatesResponse": { + "description": "Response message for CertificateAuthorityService.ListCertificates.", + "id": "ListCertificatesResponse", + "properties": { + "certificates": { + "description": "The list of Certificates.", + "items": { + "$ref": "Certificate" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass this value in ListCertificatesRequest.next_page_token to retrieve the next page of results.", + "type": "string" + }, + "unreachable": { + "description": "A list of locations (e.g. \"us-west1\") that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListReusableConfigsResponse": { + "description": "Response message for CertificateAuthorityService.ListReusableConfigs.", + "id": "ListReusableConfigsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass this value in ListReusableConfigsRequest.next_page_token to retrieve the next page of results.", + "type": "string" + }, + "reusableConfigs": { + "description": "The list of ReusableConfigs.", + "items": { + "$ref": "ReusableConfig" + }, + "type": "array" + }, + "unreachable": { + "description": "A list of locations (e.g. \"us-west1\") that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "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", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ObjectId": { + "description": "An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.", + "id": "ObjectId", + "properties": { + "objectIdPath": { + "description": "Required. The parts of an OID path. The most significant parts of the path come first.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Policy": { + "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` to a single `role`. Members 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 < 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 < 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/).", + "id": "Policy", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "items": { + "$ref": "AuditConfig" + }, + "type": "array" + }, + "bindings": { + "description": "Associates a list of `members` to 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 member.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "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" + }, + "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).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PublicKey": { + "description": "A PublicKey describes a public key.", + "id": "PublicKey", + "properties": { + "key": { + "description": "Required. A public key. When this is specified in a request, the padding and encoding can be any of the options described by the respective 'KeyType' value. When this is generated by the service, it will always be an RFC 5280 [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) structure containing an algorithm identifier and a key.", + "format": "byte", + "type": "string" + }, + "type": { + "description": "Optional. The type of public key. If specified, it must match the public key used for the`key` field.", + "enum": [ + "KEY_TYPE_UNSPECIFIED", + "PEM_RSA_KEY", + "PEM_EC_KEY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "A PEM-encoded PKCS#1/RFC 3447 RSAPublicKey structure, or an RFC 5280 [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) structure containing the former.", + "An RFC 5280 [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) structure containing a PEM-encoded compressed NIST P-256/secp256r1/prime256v1 or P-384 key." + ], + "type": "string" + } + }, + "type": "object" + }, + "RestoreCertificateAuthorityRequest": { + "description": "Request message for CertificateAuthorityService.RestoreCertificateAuthority.", + "id": "RestoreCertificateAuthorityRequest", + "properties": { + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "ReusableConfig": { + "description": "A ReusableConfig refers to a managed ReusableConfigValues. Those, in turn, are used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.", + "id": "ReusableConfig", + "properties": { + "createTime": { + "description": "Output only. The time at which this ReusableConfig was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A human-readable description of scenarios these ReusableConfigValues may be compatible with.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels with user-defined metadata.", + "type": "object" + }, + "name": { + "description": "Output only. The resource path for this ReusableConfig in the format `projects/*/locations/*/reusableConfigs/*`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which this ReusableConfig was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "values": { + "$ref": "ReusableConfigValues", + "description": "Required. The config values." + } + }, + "type": "object" + }, + "ReusableConfigValues": { + "description": "A ReusableConfigValues is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.", + "id": "ReusableConfigValues", + "properties": { + "additionalExtensions": { + "description": "Optional. Describes custom X.509 extensions.", + "items": { + "$ref": "X509Extension" + }, + "type": "array" + }, + "aiaOcspServers": { + "description": "Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the \"Authority Information Access\" extension in the certificate.", + "items": { + "type": "string" + }, + "type": "array" + }, + "caOptions": { + "$ref": "CaOptions", + "description": "Optional. Describes options in this ReusableConfigValues that are relevant in a CA certificate." + }, + "keyUsage": { + "$ref": "KeyUsage", + "description": "Optional. Indicates the intended use for keys that correspond to a certificate." + }, + "policyIds": { + "description": "Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.", + "items": { + "$ref": "ObjectId" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReusableConfigWrapper": { + "description": "A ReusableConfigWrapper describes values that may assist in creating an X.509 certificate, or a reference to a pre-defined set of values.", + "id": "ReusableConfigWrapper", + "properties": { + "reusableConfig": { + "description": "Required. A resource path to a ReusableConfig in the format `projects/*/locations/*/reusableConfigs/*`.", + "type": "string" + }, + "reusableConfigValues": { + "$ref": "ReusableConfigValues", + "description": "Required. A user-specified inline ReusableConfigValues." + } + }, + "type": "object" + }, + "RevocationDetails": { + "description": "Describes fields that are relavent to the revocation of a Certificate.", + "id": "RevocationDetails", + "properties": { + "revocationState": { + "description": "Indicates why a Certificate was revoked.", + "enum": [ + "REVOCATION_REASON_UNSPECIFIED", + "KEY_COMPROMISE", + "CERTIFICATE_AUTHORITY_COMPROMISE", + "AFFILIATION_CHANGED", + "SUPERSEDED", + "CESSATION_OF_OPERATION", + "CERTIFICATE_HOLD", + "PRIVILEGE_WITHDRAWN", + "ATTRIBUTE_AUTHORITY_COMPROMISE" + ], + "enumDescriptions": [ + "Default unspecified value. This value does indicate that a Certificate has been revoked, but that a reason has not been recorded.", + "Key material for this Certificate may have leaked.", + "The key material for a certificate authority in the issuing path may have leaked.", + "The subject or other attributes in this Certificate have changed.", + "This Certificate has been superseded.", + "This Certificate or entities in the issuing path have ceased to operate.", + "This Certificate should not be considered valid, it is expected that it may become valid in the future.", + "This Certificate no longer has permission to assert the listed attributes.", + "The authority which determines appropriate attributes for a Certificate may have been compromised." + ], + "type": "string" + }, + "revocationTime": { + "description": "The time at which this Certificate was revoked.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RevokeCertificateRequest": { + "description": "Request message for CertificateAuthorityService.RevokeCertificate.", + "id": "RevokeCertificateRequest", + "properties": { + "reason": { + "description": "Required. The RevocationReason for revoking this certificate.", + "enum": [ + "REVOCATION_REASON_UNSPECIFIED", + "KEY_COMPROMISE", + "CERTIFICATE_AUTHORITY_COMPROMISE", + "AFFILIATION_CHANGED", + "SUPERSEDED", + "CESSATION_OF_OPERATION", + "CERTIFICATE_HOLD", + "PRIVILEGE_WITHDRAWN", + "ATTRIBUTE_AUTHORITY_COMPROMISE" + ], + "enumDescriptions": [ + "Default unspecified value. This value does indicate that a Certificate has been revoked, but that a reason has not been recorded.", + "Key material for this Certificate may have leaked.", + "The key material for a certificate authority in the issuing path may have leaked.", + "The subject or other attributes in this Certificate have changed.", + "This Certificate has been superseded.", + "This Certificate or entities in the issuing path have ceased to operate.", + "This Certificate should not be considered valid, it is expected that it may become valid in the future.", + "This Certificate no longer has permission to assert the listed attributes.", + "The authority which determines appropriate attributes for a Certificate may have been compromised." + ], + "type": "string" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "RevokedCertificate": { + "description": "Describes a revoked Certificate.", + "id": "RevokedCertificate", + "properties": { + "certificate": { + "description": "The resource path for the Certificate in the format `projects/*/locations/*/certificateAuthorities/*/certificates/*`.", + "type": "string" + }, + "hexSerialNumber": { + "description": "The serial number of the Certificate.", + "type": "string" + }, + "revocationReason": { + "description": "The reason the Certificate was revoked.", + "enum": [ + "REVOCATION_REASON_UNSPECIFIED", + "KEY_COMPROMISE", + "CERTIFICATE_AUTHORITY_COMPROMISE", + "AFFILIATION_CHANGED", + "SUPERSEDED", + "CESSATION_OF_OPERATION", + "CERTIFICATE_HOLD", + "PRIVILEGE_WITHDRAWN", + "ATTRIBUTE_AUTHORITY_COMPROMISE" + ], + "enumDescriptions": [ + "Default unspecified value. This value does indicate that a Certificate has been revoked, but that a reason has not been recorded.", + "Key material for this Certificate may have leaked.", + "The key material for a certificate authority in the issuing path may have leaked.", + "The subject or other attributes in this Certificate have changed.", + "This Certificate has been superseded.", + "This Certificate or entities in the issuing path have ceased to operate.", + "This Certificate should not be considered valid, it is expected that it may become valid in the future.", + "This Certificate no longer has permission to assert the listed attributes.", + "The authority which determines appropriate attributes for a Certificate may have been compromised." + ], + "type": "string" + } + }, + "type": "object" + }, + "ScheduleDeleteCertificateAuthorityRequest": { + "description": "Request message for CertificateAuthorityService.ScheduleDeleteCertificateAuthority.", + "id": "ScheduleDeleteCertificateAuthorityRequest", + "properties": { + "ignoreActiveCertificates": { + "description": "Optional. This field allows the CA to be scheduled for deletion even if the CA has active certs. Active certs include both unrevoked and unexpired certs.", + "type": "boolean" + }, + "requestId": { + "description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "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 Cloud Platform services (such as Projects) might reject them." + }, + "updateMask": { + "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\"`", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "Subject": { + "description": "Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate.", + "id": "Subject", + "properties": { + "countryCode": { + "description": "The country code of the subject.", + "type": "string" + }, + "locality": { + "description": "The locality or city of the subject.", + "type": "string" + }, + "organization": { + "description": "The organization of the subject.", + "type": "string" + }, + "organizationalUnit": { + "description": "The organizational_unit of the subject.", + "type": "string" + }, + "postalCode": { + "description": "The postal code of the subject.", + "type": "string" + }, + "province": { + "description": "The province, territory, or regional state of the subject.", + "type": "string" + }, + "streetAddress": { + "description": "The street address of the subject.", + "type": "string" + } + }, + "type": "object" + }, + "SubjectAltNames": { + "description": "SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the \"common name\" in the distinguished name).", + "id": "SubjectAltNames", + "properties": { + "customSans": { + "description": "Contains additional subject alternative name values.", + "items": { + "$ref": "X509Extension" + }, + "type": "array" + }, + "dnsNames": { + "description": "Contains only valid, fully-qualified host names.", + "items": { + "type": "string" + }, + "type": "array" + }, + "emailAddresses": { + "description": "Contains only valid RFC 2822 E-mail addresses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ipAddresses": { + "description": "Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6 addresses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uris": { + "description": "Contains only valid RFC 3986 URIs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "SubjectConfig": { + "description": "These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.", + "id": "SubjectConfig", + "properties": { + "commonName": { + "description": "Optional. The \"common name\" of the distinguished name.", + "type": "string" + }, + "subject": { + "$ref": "Subject", + "description": "Required. Contains distinguished name fields such as the location and organization." + }, + "subjectAltName": { + "$ref": "SubjectAltNames", + "description": "Optional. The subject alternative name fields." + } + }, + "type": "object" + }, + "SubjectDescription": { + "description": "These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.", + "id": "SubjectDescription", + "properties": { + "commonName": { + "description": "The \"common name\" of the distinguished name.", + "type": "string" + }, + "hexSerialNumber": { + "description": "The serial number encoded in lowercase hexadecimal.", + "type": "string" + }, + "lifetime": { + "description": "For convenience, the actual lifetime of an issued certificate. Corresponds to 'not_after_time' - 'not_before_time'.", + "format": "google-duration", + "type": "string" + }, + "notAfterTime": { + "description": "The time at which the certificate expires.", + "format": "google-datetime", + "type": "string" + }, + "notBeforeTime": { + "description": "The time at which the certificate becomes valid.", + "format": "google-datetime", + "type": "string" + }, + "subject": { + "$ref": "Subject", + "description": "Contains distinguished name fields such as the location and organization." + }, + "subjectAltName": { + "$ref": "SubjectAltNames", + "description": "The subject alternative name fields." + } + }, + "type": "object" + }, + "SubordinateConfig": { + "description": "Describes a subordinate CA's issuers. This is either a resource path to a known issuing CertificateAuthority, or a PEM issuer certificate chain.", + "id": "SubordinateConfig", + "properties": { + "certificateAuthority": { + "description": "Required. This can refer to a CertificateAuthority in the same project that was used to create a subordinate CertificateAuthority. This field is used for information and usability purposes only. The resource name is in the format `projects/*/locations/*/certificateAuthorities/*`.", + "type": "string" + }, + "pemIssuerChain": { + "$ref": "SubordinateConfigChain", + "description": "Required. Contains the PEM certificate chain for the issuers of this CertificateAuthority, but not pem certificate for this CA itself." + } + }, + "type": "object" + }, + "SubordinateConfigChain": { + "description": "This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons.", + "id": "SubordinateConfigChain", + "properties": { + "pemCertificates": { + "description": "Required. Expected to be in leaf-to-root order according to RFC 5246.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "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": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "X509Extension": { + "description": "An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.", + "id": "X509Extension", + "properties": { + "critical": { + "description": "Required. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).", + "type": "boolean" + }, + "objectId": { + "$ref": "ObjectId", + "description": "Required. The OID for this X.509 extension." + }, + "value": { + "description": "Required. The value of this X.509 extension.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Certificate Authority API", + "version": "v1beta1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/prod_tt_sasportal__v1alpha1.json b/discovery/googleapis_beta/prod_tt_sasportal__v1alpha1.json index cd1495a..27a1092 100644 --- a/discovery/googleapis_beta/prod_tt_sasportal__v1alpha1.json +++ b/discovery/googleapis_beta/prod_tt_sasportal__v1alpha1.json
@@ -142,7 +142,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListCustomers method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListCustomers that indicates where this listing should continue from.", "location": "query", "type": "string" } @@ -192,6 +192,121 @@ "resources": { "deployments": { "methods": { + "create": { + "description": "Creates a new deployment.", + "httpMethod": "POST", + "id": "prod_tt_sasportal.customers.deployments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name where the deployment is to be created.", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "delete": { + "description": "Deletes a deployment.", + "httpMethod": "DELETE", + "id": "prod_tt_sasportal.customers.deployments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^customers/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "get": { + "description": "Returns a requested deployment.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.customers.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^customers/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.customers.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, "move": { "description": "Moves a deployment under another node or customer.", "httpMethod": "POST", @@ -218,6 +333,39 @@ "scopes": [ "https://www.googleapis.com/auth/userinfo.email" ] + }, + "patch": { + "description": "Updates an existing deployment.", + "httpMethod": "PATCH", + "id": "prod_tt_sasportal.customers.deployments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name.", + "location": "path", + "pattern": "^customers/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] } }, "resources": { @@ -286,7 +434,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -323,33 +471,6 @@ }, "devices": { "methods": { - "bulk": { - "description": "Creates a device under a node or customer. Returned devices are unordered.", - "httpMethod": "POST", - "id": "prod_tt_sasportal.customers.devices.bulk", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent resource.", - "location": "path", - "pattern": "^customers/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/devices:bulk", - "request": { - "$ref": "SasPortalBulkCreateDeviceRequest" - }, - "response": { - "$ref": "SasPortalBulkCreateDeviceResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - }, "create": { "description": "Creates a device under a node or customer.", "httpMethod": "POST", @@ -461,7 +582,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -693,6 +814,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -700,7 +826,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -782,6 +908,175 @@ } }, "resources": { + "deployments": { + "methods": { + "create": { + "description": "Creates a new deployment.", + "httpMethod": "POST", + "id": "prod_tt_sasportal.customers.nodes.deployments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name where the deployment is to be created.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.customers.nodes.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + } + }, + "devices": { + "methods": { + "create": { + "description": "Creates a device under a node or customer.", + "httpMethod": "POST", + "id": "prod_tt_sasportal.customers.nodes.devices.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/devices", + "request": { + "$ref": "SasPortalDevice" + }, + "response": { + "$ref": "SasPortalDevice" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "createSigned": { + "description": "Creates a signed device under a node or customer.", + "httpMethod": "POST", + "id": "prod_tt_sasportal.customers.nodes.devices.createSigned", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/devices:createSigned", + "request": { + "$ref": "SasPortalCreateSignedDeviceRequest" + }, + "response": { + "$ref": "SasPortalDevice" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists devices under a node or customer.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.customers.nodes.devices.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent resource.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/devices", + "response": { + "$ref": "SasPortalListDevicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + } + }, "nodes": { "methods": { "create": { @@ -819,6 +1114,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -826,7 +1126,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -853,6 +1153,32 @@ } }, "deployments": { + "methods": { + "get": { + "description": "Returns a requested deployment.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + }, "resources": { "devices": { "methods": { @@ -1025,7 +1351,7 @@ "installer": { "methods": { "generateSecret": { - "description": "Generates a secret to be used with the ValidateInstaller method", + "description": "Generates a secret to be used with the ValidateInstaller.", "httpMethod": "POST", "id": "prod_tt_sasportal.installer.generateSecret", "parameterOrder": [], @@ -1090,6 +1416,94 @@ "resources": { "deployments": { "methods": { + "delete": { + "description": "Deletes a deployment.", + "httpMethod": "DELETE", + "id": "prod_tt_sasportal.nodes.deployments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^nodes/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "get": { + "description": "Returns a requested deployment.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.nodes.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^nodes/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.nodes.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, "move": { "description": "Moves a deployment under another node or customer.", "httpMethod": "POST", @@ -1116,6 +1530,39 @@ "scopes": [ "https://www.googleapis.com/auth/userinfo.email" ] + }, + "patch": { + "description": "Updates an existing deployment.", + "httpMethod": "PATCH", + "id": "prod_tt_sasportal.nodes.deployments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name.", + "location": "path", + "pattern": "^nodes/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] } }, "resources": { @@ -1184,7 +1631,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -1221,33 +1668,6 @@ }, "devices": { "methods": { - "bulk": { - "description": "Creates a device under a node or customer. Returned devices are unordered.", - "httpMethod": "POST", - "id": "prod_tt_sasportal.nodes.devices.bulk", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent resource.", - "location": "path", - "pattern": "^nodes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/devices:bulk", - "request": { - "$ref": "SasPortalBulkCreateDeviceRequest" - }, - "response": { - "$ref": "SasPortalBulkCreateDeviceResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - }, "create": { "description": "Creates a device under a node or customer.", "httpMethod": "POST", @@ -1359,7 +1779,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -1591,6 +2011,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -1598,7 +2023,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -1680,35 +2105,79 @@ } }, "resources": { - "devices": { + "deployments": { "methods": { - "bulk": { - "description": "Creates a device under a node or customer. Returned devices are unordered.", + "create": { + "description": "Creates a new deployment.", "httpMethod": "POST", - "id": "prod_tt_sasportal.nodes.nodes.devices.bulk", + "id": "prod_tt_sasportal.nodes.nodes.deployments.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The name of the parent resource.", + "description": "Required. The parent resource name where the deployment is to be created.", "location": "path", "pattern": "^nodes/[^/]+/nodes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha1/{+parent}/devices:bulk", + "path": "v1alpha1/{+parent}/deployments", "request": { - "$ref": "SasPortalBulkCreateDeviceRequest" + "$ref": "SasPortalDeployment" }, "response": { - "$ref": "SasPortalBulkCreateDeviceResponse" + "$ref": "SasPortalDeployment" }, "scopes": [ "https://www.googleapis.com/auth/userinfo.email" ] }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "prod_tt_sasportal.nodes.nodes.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^nodes/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + } + }, + "devices": { + "methods": { "create": { "description": "Creates a device under a node or customer.", "httpMethod": "POST", @@ -1772,7 +2241,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -1842,6 +2311,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -1849,7 +2323,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -1931,7 +2405,7 @@ } } }, - "revision": "20201007", + "revision": "20210202", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -1952,42 +2426,17 @@ }, "type": "object" }, - "SasPortalBulkCreateDeviceRequest": { - "description": "Request for BulkCreateDevice method.", - "id": "SasPortalBulkCreateDeviceRequest", - "properties": { - "csv": { - "description": "Required. A csv with each row representing a [device]. Each row must conform to the regulations described on CreateDeviceRequest's device field.", - "type": "string" - } - }, - "type": "object" - }, - "SasPortalBulkCreateDeviceResponse": { - "description": "Response for BulkCreateDevice method.", - "id": "SasPortalBulkCreateDeviceResponse", - "properties": { - "devices": { - "description": "Required. The devices that were imported.", - "items": { - "$ref": "SasPortalDevice" - }, - "type": "array" - } - }, - "type": "object" - }, "SasPortalCreateSignedDeviceRequest": { - "description": "Request for CreateSignedDevice method.", + "description": "Request for CreateSignedDevice.", "id": "SasPortalCreateSignedDeviceRequest", "properties": { "encodedDevice": { - "description": "Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the [Device]. The user_id field must be set.", + "description": "Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The user_id field must be set.", "format": "byte", "type": "string" }, "installerId": { - "description": "Required. Unique installer id (cpiId) from the Certified Professional Installers database.", + "description": "Required. Unique installer id (CPI ID) from the Certified Professional Installers database.", "type": "string" } }, @@ -2015,6 +2464,60 @@ }, "type": "object" }, + "SasPortalDeployment": { + "description": "The Deployment.", + "id": "SasPortalDeployment", + "properties": { + "allowedBillingModes": { + "description": "The allowed billing modes under this deployment.", + "items": { + "enum": [ + "BILLING_MODE_UNSPECIFIED", + "MOBILE", + "FIXED_WIRELESS" + ], + "enumDescriptions": [ + "Billing mode has not been specified.", + "Price is based on category of CBSD: Category A, Category B registered with SAS.", + "Price is based on type of CBSD: Base station or CPE." + ], + "type": "string" + }, + "type": "array" + }, + "defaultBillingMode": { + "description": "Default billing mode for the deployment and devices under it.", + "enum": [ + "BILLING_MODE_UNSPECIFIED", + "MOBILE", + "FIXED_WIRELESS" + ], + "enumDescriptions": [ + "Billing mode has not been specified.", + "Price is based on category of CBSD: Category A, Category B registered with SAS.", + "Price is based on type of CBSD: Base station or CPE." + ], + "type": "string" + }, + "displayName": { + "description": "The deployment's display name.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name.", + "readOnly": true, + "type": "string" + }, + "sasUserIds": { + "description": "User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SasPortalDevice": { "id": "SasPortalDevice", "properties": { @@ -2077,7 +2580,7 @@ "id": "SasPortalDeviceAirInterface", "properties": { "radioTechnology": { - "description": "This field specifies the radio access technology that is used for the CBSD. Conditional", + "description": "Conditional. This field specifies the radio access technology that is used for the CBSD.", "enum": [ "RADIO_TECHNOLOGY_UNSPECIFIED", "E_UTRA", @@ -2103,7 +2606,7 @@ "type": "string" }, "supportedSpec": { - "description": "This field is related to the radioTechnology field and provides the air interface specification that the CBSD is compliant with at the time of registration. Optional", + "description": "Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.", "type": "string" } }, @@ -2140,7 +2643,7 @@ "description": "Installation parameters for the device." }, "isSigned": { - "description": "Output-only. Whether the configuration has been signed by a CPI.", + "description": "Output only. Whether the configuration has been signed by a CPI.", "type": "boolean" }, "measurementCapabilities": { @@ -2179,7 +2682,7 @@ "type": "string" }, "updateTime": { - "description": "Output-only. The last time the device configuration was edited.", + "description": "Output only. The last time the device configuration was edited.", "format": "google-datetime", "type": "string" }, @@ -2222,7 +2725,7 @@ "type": "string" }, "maxEirp": { - "description": "Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).", + "description": "Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).", "format": "double", "type": "number" }, @@ -2335,17 +2838,17 @@ "type": "object" }, "SasPortalGenerateSecretRequest": { - "description": "Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret].", + "description": "Request for GenerateSecret.", "id": "SasPortalGenerateSecretRequest", "properties": {}, "type": "object" }, "SasPortalGenerateSecretResponse": { - "description": "Response for GenerateSecret method.", + "description": "Response for GenerateSecret.", "id": "SasPortalGenerateSecretResponse", "properties": { "secret": { - "description": "The secret generated by the string and used by [ValidateInstaller] method.", + "description": "The secret generated by the string and used by ValidateInstaller.", "type": "string" } }, @@ -2400,7 +2903,7 @@ "type": "integer" }, "height": { - "description": "Device antenna height in meters. When the heightType parameter value is \"AGL\", the antenna height should be given relative to ground level. When the heightType parameter value is \"AMSL\", it is given with respect to WGS84 datum.", + "description": "Device antenna height in meters. When the `heightType` parameter value is \"AGL\", the antenna height should be given relative to ground level. When the `heightType` parameter value is \"AMSL\", it is given with respect to WGS84 datum.", "format": "double", "type": "number" }, @@ -2424,7 +2927,7 @@ "type": "number" }, "indoorDeployment": { - "description": "Whether the device antenna is indoor or not. True: indoor. False: outdoor.", + "description": "Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.", "type": "boolean" }, "latitude": { @@ -2433,7 +2936,7 @@ "type": "number" }, "longitude": { - "description": "Longitude of the device antenna location. in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.", + "description": "Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.", "format": "double", "type": "number" }, @@ -2457,14 +2960,32 @@ "type": "array" }, "nextPageToken": { - "description": "A pagination token returned from a previous call to ListCustomers method that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.", + "description": "A pagination token returned from a previous call to ListCustomers that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.", + "type": "string" + } + }, + "type": "object" + }, + "SasPortalListDeploymentsResponse": { + "description": "Response for ListDeployments.", + "id": "SasPortalListDeploymentsResponse", + "properties": { + "deployments": { + "description": "The deployments that match the request.", + "items": { + "$ref": "SasPortalDeployment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates from where listing should continue. If the field is missing or empty, it means there are no more deployments.", "type": "string" } }, "type": "object" }, "SasPortalListDevicesResponse": { - "description": "Response for ListDevices method.", + "description": "Response for ListDevices.", "id": "SasPortalListDevicesResponse", "properties": { "devices": { @@ -2475,18 +2996,18 @@ "type": "array" }, "nextPageToken": { - "description": "A pagination token returned from a previous call to ListDevices method that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices.", + "description": "A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices.", "type": "string" } }, "type": "object" }, "SasPortalListNodesResponse": { - "description": "Response for ListNodes method.", + "description": "Response for ListNodes.", "id": "SasPortalListNodesResponse", "properties": { "nextPageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes.", + "description": "A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes.", "type": "string" }, "nodes": { @@ -2500,33 +3021,33 @@ "type": "object" }, "SasPortalMoveDeploymentRequest": { - "description": "Request for MoveDeployment method.", + "description": "Request for MoveDeployment.", "id": "SasPortalMoveDeploymentRequest", "properties": { "destination": { - "description": "Required. The name of the new parent resource Node or Customer to reparent the deployment under.", + "description": "Required. The name of the new parent resource node or customer to reparent the deployment under.", "type": "string" } }, "type": "object" }, "SasPortalMoveDeviceRequest": { - "description": "Request for MoveDevice method.", + "description": "Request for MoveDevice.", "id": "SasPortalMoveDeviceRequest", "properties": { "destination": { - "description": "Required. The name of the new parent resource (Node or Customer) to reparent the device under.", + "description": "Required. The name of the new parent resource node or customer to reparent the device under.", "type": "string" } }, "type": "object" }, "SasPortalMoveNodeRequest": { - "description": "Request for MoveNode method.", + "description": "Request for MoveNode.", "id": "SasPortalMoveNodeRequest", "properties": { "destination": { - "description": "Required. The name of the new parent resource node or Customer) to reparent the node under.", + "description": "Required. The name of the new parent resource node or customer to reparent the node under.", "type": "string" } }, @@ -2594,13 +3115,14 @@ "id": "SasPortalPolicy", "properties": { "assignments": { + "description": "List of assignments", "items": { "$ref": "SasPortalAssignment" }, "type": "array" }, "etag": { - "description": "The [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 [GetPolicy], and systems are expected to put that etag in the request to [SetPolicy] to ensure that their change will be applied to the same version of the policy. If no [etag] is provided in the call to [SetPolicy], then the existing policy is overwritten blindly.", + "description": "The 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 GetPolicy, and systems are expected to put that etag in the request to SetPolicy to ensure that their change will be applied to the same version of the policy. If no etag is provided in the call to GetPolicy, then the existing policy is overwritten blindly.", "format": "byte", "type": "string" } @@ -2623,7 +3145,7 @@ "type": "object" }, "SasPortalSignDeviceRequest": { - "description": "Request for SignDevice method.", + "description": "Request for SignDevice.", "id": "SasPortalSignDeviceRequest", "properties": { "device": { @@ -2693,7 +3215,7 @@ "type": "object" }, "SasPortalUpdateSignedDeviceRequest": { - "description": "Request for UpdateSignedDevice method.", + "description": "Request for UpdateSignedDevice.", "id": "SasPortalUpdateSignedDeviceRequest", "properties": { "encodedDevice": { @@ -2709,7 +3231,7 @@ "type": "object" }, "SasPortalValidateInstallerRequest": { - "description": "Request for ValidateInstaller method.", + "description": "Request for ValidateInstaller.", "id": "SasPortalValidateInstallerRequest", "properties": { "encodedSecret": { @@ -2717,18 +3239,18 @@ "type": "string" }, "installerId": { - "description": "Required. Unique installer id (cpiId) from the Certified Professional Installers database.", + "description": "Required. Unique installer id (CPI ID) from the Certified Professional Installers database.", "type": "string" }, "secret": { - "description": "Required. Secret returned by the GenerateSecret method.", + "description": "Required. Secret returned by the GenerateSecret.", "type": "string" } }, "type": "object" }, "SasPortalValidateInstallerResponse": { - "description": "Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller].", + "description": "Response for ValidateInstaller.", "id": "SasPortalValidateInstallerResponse", "properties": {}, "type": "object"
diff --git a/discovery/googleapis_beta/pubsub__v1beta2.json b/discovery/googleapis_beta/pubsub__v1beta2.json deleted file mode 100644 index 0b87285..0000000 --- a/discovery/googleapis_beta/pubsub__v1beta2.json +++ /dev/null
@@ -1,1106 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/pubsub": { - "description": "View and manage Pub/Sub topics and subscriptions" - } - } - } - }, - "basePath": "", - "baseUrl": "https://pubsub.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Pubsub", - "description": "Provides reliable, many-to-many, asynchronous messaging between applications. ", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/pubsub/docs", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "pubsub:v1beta2", - "kind": "discovery#restDescription", - "name": "pubsub", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "subscriptions": { - "methods": { - "acknowledge": { - "description": "Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.", - "httpMethod": "POST", - "id": "pubsub.projects.subscriptions.acknowledge", - "parameterOrder": [ - "subscription" - ], - "parameters": { - "subscription": { - "description": "The subscription whose message is being acknowledged.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+subscription}:acknowledge", - "request": { - "$ref": "AcknowledgeRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "create": { - "description": "Creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Note that for REST API requests, you must specify a name.", - "httpMethod": "PUT", - "id": "pubsub.projects.subscriptions.create", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "request": { - "$ref": "Subscription" - }, - "response": { - "$ref": "Subscription" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "delete": { - "description": "Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription, or its topic unless the same topic is specified.", - "httpMethod": "DELETE", - "id": "pubsub.projects.subscriptions.delete", - "parameterOrder": [ - "subscription" - ], - "parameters": { - "subscription": { - "description": "The subscription to delete.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+subscription}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "get": { - "description": "Gets the configuration details of a subscription.", - "httpMethod": "GET", - "id": "pubsub.projects.subscriptions.get", - "parameterOrder": [ - "subscription" - ], - "parameters": { - "subscription": { - "description": "The name of the subscription to get.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+subscription}", - "response": { - "$ref": "Subscription" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "httpMethod": "GET", - "id": "pubsub.projects.subscriptions.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "list": { - "description": "Lists matching subscriptions.", - "httpMethod": "GET", - "id": "pubsub.projects.subscriptions.list", - "parameterOrder": [ - "project" - ], - "parameters": { - "pageSize": { - "description": "Maximum number of subscriptions to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.", - "location": "query", - "type": "string" - }, - "project": { - "description": "The name of the cloud project that subscriptions belong to.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+project}/subscriptions", - "response": { - "$ref": "ListSubscriptionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "modifyAckDeadline": { - "description": "Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.", - "httpMethod": "POST", - "id": "pubsub.projects.subscriptions.modifyAckDeadline", - "parameterOrder": [ - "subscription" - ], - "parameters": { - "subscription": { - "description": "The name of the subscription.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+subscription}:modifyAckDeadline", - "request": { - "$ref": "ModifyAckDeadlineRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "modifyPushConfig": { - "description": "Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.", - "httpMethod": "POST", - "id": "pubsub.projects.subscriptions.modifyPushConfig", - "parameterOrder": [ - "subscription" - ], - "parameters": { - "subscription": { - "description": "The name of the subscription.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+subscription}:modifyPushConfig", - "request": { - "$ref": "ModifyPushConfigRequest" - }, - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "pull": { - "description": "Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.", - "httpMethod": "POST", - "id": "pubsub.projects.subscriptions.pull", - "parameterOrder": [ - "subscription" - ], - "parameters": { - "subscription": { - "description": "The subscription from which messages should be pulled.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+subscription}:pull", - "request": { - "$ref": "PullRequest" - }, - "response": { - "$ref": "PullResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "httpMethod": "POST", - "id": "pubsub.projects.subscriptions.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "httpMethod": "POST", - "id": "pubsub.projects.subscriptions.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - } - } - }, - "topics": { - "methods": { - "create": { - "description": "Creates the given topic with the given name.", - "httpMethod": "PUT", - "id": "pubsub.projects.topics.create", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "request": { - "$ref": "Topic" - }, - "response": { - "$ref": "Topic" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "delete": { - "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.", - "httpMethod": "DELETE", - "id": "pubsub.projects.topics.delete", - "parameterOrder": [ - "topic" - ], - "parameters": { - "topic": { - "description": "Name of the topic to delete.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+topic}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "get": { - "description": "Gets the configuration of a topic.", - "httpMethod": "GET", - "id": "pubsub.projects.topics.get", - "parameterOrder": [ - "topic" - ], - "parameters": { - "topic": { - "description": "The name of the topic to get.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+topic}", - "response": { - "$ref": "Topic" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "httpMethod": "GET", - "id": "pubsub.projects.topics.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "list": { - "description": "Lists matching topics.", - "httpMethod": "GET", - "id": "pubsub.projects.topics.list", - "parameterOrder": [ - "project" - ], - "parameters": { - "pageSize": { - "description": "Maximum number of topics to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.", - "location": "query", - "type": "string" - }, - "project": { - "description": "The name of the cloud project that topics belong to.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+project}/topics", - "response": { - "$ref": "ListTopicsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "publish": { - "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.", - "httpMethod": "POST", - "id": "pubsub.projects.topics.publish", - "parameterOrder": [ - "topic" - ], - "parameters": { - "topic": { - "description": "The messages in the request will be published on this topic.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+topic}:publish", - "request": { - "$ref": "PublishRequest" - }, - "response": { - "$ref": "PublishResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "httpMethod": "POST", - "id": "pubsub.projects.topics.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "httpMethod": "POST", - "id": "pubsub.projects.topics.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - } - }, - "resources": { - "subscriptions": { - "methods": { - "list": { - "description": "Lists the name of the subscriptions for this topic.", - "httpMethod": "GET", - "id": "pubsub.projects.topics.subscriptions.list", - "parameterOrder": [ - "topic" - ], - "parameters": { - "pageSize": { - "description": "Maximum number of subscription names to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.", - "location": "query", - "type": "string" - }, - "topic": { - "description": "The name of the topic that subscriptions are attached to.", - "location": "path", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+topic}/subscriptions", - "response": { - "$ref": "ListTopicSubscriptionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ] - } - } - } - } - } - } - } - }, - "revision": "20200929", - "rootUrl": "https://pubsub.googleapis.com/", - "schemas": { - "AcknowledgeRequest": { - "description": "Request for the Acknowledge method.", - "id": "AcknowledgeRequest", - "properties": { - "ackIds": { - "description": "The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Binding": { - "description": "Associates `members` with a `role`.", - "id": "Binding", - "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, - "condition": { - "$ref": "Expr", - "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 members 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)." - }, - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", - "items": { - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Expr": { - "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() < 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", - "properties": { - "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" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "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" - }, - "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" - }, - "ListSubscriptionsResponse": { - "description": "Response for the `ListSubscriptions` method.", - "id": "ListSubscriptionsResponse", - "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListSubscriptionsRequest` to get more subscriptions.", - "type": "string" - }, - "subscriptions": { - "description": "The subscriptions that match the request.", - "items": { - "$ref": "Subscription" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListTopicSubscriptionsResponse": { - "description": "Response for the `ListTopicSubscriptions` method.", - "id": "ListTopicSubscriptionsResponse", - "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new `ListTopicSubscriptionsRequest` to get more subscriptions.", - "type": "string" - }, - "subscriptions": { - "description": "The names of the subscriptions that match the request.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListTopicsResponse": { - "description": "Response for the `ListTopics` method.", - "id": "ListTopicsResponse", - "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more topics that match the request; this value should be passed in a new `ListTopicsRequest`.", - "type": "string" - }, - "topics": { - "description": "The resulting topics.", - "items": { - "$ref": "Topic" - }, - "type": "array" - } - }, - "type": "object" - }, - "ModifyAckDeadlineRequest": { - "description": "Request for the ModifyAckDeadline method.", - "id": "ModifyAckDeadlineRequest", - "properties": { - "ackDeadlineSeconds": { - "description": "The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero may immediately make the message available for another pull request.", - "format": "int32", - "type": "integer" - }, - "ackId": { - "description": "The acknowledgment ID. Either this or ack_ids must be populated, but not both.", - "type": "string" - }, - "ackIds": { - "description": "List of acknowledgment IDs.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ModifyPushConfigRequest": { - "description": "Request for the ModifyPushConfig method.", - "id": "ModifyPushConfigRequest", - "properties": { - "pushConfig": { - "$ref": "PushConfig", - "description": "The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` is not called." - } - }, - "type": "object" - }, - "OidcToken": { - "description": "Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect).", - "id": "OidcToken", - "properties": { - "audience": { - "description": "Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.", - "type": "string" - }, - "serviceAccountEmail": { - "description": "[Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.", - "type": "string" - } - }, - "type": "object" - }, - "Policy": { - "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` to a single `role`. Members 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 < 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 < 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/).", - "id": "Policy", - "properties": { - "bindings": { - "description": "Associates a list of `members` to 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 member.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "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" - }, - "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).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "PublishRequest": { - "description": "Request for the Publish method.", - "id": "PublishRequest", - "properties": { - "messages": { - "description": "The messages to publish.", - "items": { - "$ref": "PubsubMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "PublishResponse": { - "description": "Response for the `Publish` method.", - "id": "PublishResponse", - "properties": { - "messageIds": { - "description": "The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "PubsubMessage": { - "description": "A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.", - "id": "PubsubMessage", - "properties": { - "attributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional attributes for this message.", - "type": "object" - }, - "data": { - "description": "The message payload. For JSON requests, the value of this field must be [base64-encoded](https://tools.ietf.org/html/rfc4648).", - "format": "byte", - "type": "string" - }, - "messageId": { - "description": "ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.", - "type": "string" - }, - "publishTime": { - "description": "The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "PullRequest": { - "description": "Request for the `Pull` method.", - "id": "PullRequest", - "properties": { - "maxMessages": { - "description": "The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.", - "format": "int32", - "type": "integer" - }, - "returnImmediately": { - "description": "Optional. If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. Warning: setting this field to `true` is discouraged because it adversely impacts the performance of `Pull` operations. We recommend that users do not set this field.", - "type": "boolean" - } - }, - "type": "object" - }, - "PullResponse": { - "description": "Response for the `Pull` method.", - "id": "PullResponse", - "properties": { - "receivedMessages": { - "description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the `maxMessages` requested even if there are more messages available in the backlog.", - "items": { - "$ref": "ReceivedMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "PushConfig": { - "description": "Configuration for a push delivery endpoint.", - "id": "PushConfig", - "properties": { - "attributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the `CreateSubscription` call, it will default to the version of the API used to make such call. If not present during a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.", - "type": "object" - }, - "oidcToken": { - "$ref": "OidcToken", - "description": "If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message." - }, - "pushEndpoint": { - "description": "A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use \"https://example.com/push\".", - "type": "string" - } - }, - "type": "object" - }, - "ReceivedMessage": { - "description": "A message and its corresponding acknowledgment ID.", - "id": "ReceivedMessage", - "properties": { - "ackId": { - "description": "This ID can be used to acknowledge the received message.", - "type": "string" - }, - "message": { - "$ref": "PubsubMessage", - "description": "The message." - } - }, - "type": "object" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "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 Cloud Platform services (such as Projects) might reject them." - } - }, - "type": "object" - }, - "Subscription": { - "description": "A subscription resource.", - "id": "Subscription", - "properties": { - "ackDeadlineSeconds": { - "description": "This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using pull. The maximum custom deadline you can specify is 600 seconds (10 minutes). For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. If this parameter is 0, a default value of 10 seconds is used.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "The name of the subscription. It must have the format `\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", - "type": "string" - }, - "pushConfig": { - "$ref": "PushConfig", - "description": "If push delivery is used with this subscription, this field is used to configure it. An empty `pushConfig` signifies that the subscriber will pull and ack messages using API methods." - }, - "topic": { - "description": "The name of the topic from which this subscription is receiving messages. The value of this field will be `_deleted-topic_` if the topic has been deleted.", - "type": "string" - } - }, - "type": "object" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "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": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Topic": { - "description": "A topic resource.", - "id": "Topic", - "properties": { - "name": { - "description": "The name of the topic. It must have the format `\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `\"goog\"`.", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Pub/Sub API", - "version": "v1beta2" -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/recommendationengine__v1beta1.json b/discovery/googleapis_beta/recommendationengine__v1beta1.json new file mode 100644 index 0000000..037eeda --- /dev/null +++ b/discovery/googleapis_beta/recommendationengine__v1beta1.json
@@ -0,0 +1,2025 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://recommendationengine.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Recommendations AI", + "description": "Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/recommendations-ai/docs", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "recommendationengine:v1beta1", + "kind": "discovery#restDescription", + "name": "recommendationengine", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "catalogs": { + "methods": { + "list": { + "description": "Lists all the catalog configurations associated with the project.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListCatalogs` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account resource name with an associated location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/catalogs", + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1ListCatalogsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the catalog configuration.", + "httpMethod": "PATCH", + "id": "recommendationengine.projects.locations.catalogs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The fully qualified resource name of the catalog.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided 'catalog' to update. If not set, will only update the catalog_item_level_config field. Currently only fields that can be updated are catalog_item_level_config.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1Catalog" + }, + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1Catalog" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "catalogItems": { + "methods": { + "create": { + "description": "Creates a catalog item.", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.catalogItems.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent catalog resource name, such as \"projects/*/locations/global/catalogs/default_catalog\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/catalogItems", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" + }, + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a catalog item.", + "httpMethod": "DELETE", + "id": "recommendationengine.projects.locations.catalogs.catalogItems.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a specific catalog item.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.catalogItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.catalogItems.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. \"projects/1234/locations/global/catalogs/default_catalog\" If no updateMask is specified, requires catalogItems.create permission. If updateMask is specified, requires catalogItems.update permission.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/catalogItems:import", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of catalog items.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.catalogItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter to apply on the list results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The previous ListCatalogItemsResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent catalog resource name, such as \"projects/*/locations/global/catalogs/default_catalog\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/catalogItems", + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a catalog item. Partial updating is supported. Non-existing items will be created.", + "httpMethod": "PATCH", + "id": "recommendationengine.projects.locations.catalogs.catalogItems.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of catalog item, such as \"projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/catalogItems/.*$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" + }, + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "eventStores": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.eventStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.eventStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "placements": { + "methods": { + "predict": { + "description": "Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more](https://cloud.google.com/recommendations-ai/docs/setting-up#register-key).", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.eventStores.placements.predict", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: * `shopping_cart`: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after `add-to-cart` events, on product detail pages, or on the shopping cart page. * `home_page`: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified `userId` or `visitorId`. For example - Recommendations for you. * `product_detail`: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified `userId` or `visitorId` and its relevance to a specified `CatalogItem`. Typically used on product detail pages. For example - More items like this. * `recently_viewed_default`: Returns up to 75 items recently viewed by the specified `userId` or `visitorId`, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+/placements/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:predict", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "predictionApiKeyRegistrations": { + "methods": { + "create": { + "description": "Register an API key for use with predict method.", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource path. \"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/predictionApiKeyRegistrations", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest" + }, + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Unregister an apiKey from using for predict method.", + "httpMethod": "DELETE", + "id": "recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The API key to unregister including full resource path. \"projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+/predictionApiKeyRegistrations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List the registered apiKeys for use with predict method.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The previous `ListPredictionApiKeyRegistration.nextPageToken`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent placement resource name such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/predictionApiKeyRegistrations", + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "userEvents": { + "methods": { + "collect": { + "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.collect", + "parameterOrder": [ + "parent" + ], + "parameters": { + "ets": { + "description": "Optional. The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent eventStore name, such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + }, + "uri": { + "description": "Optional. The url including cgi-parameters but excluding the hash fragment. The URL must be truncated to 1.5K bytes to conservatively be under the 2K bytes. This is often more useful than the referer url, because many browsers only send the domain for 3rd party requests.", + "location": "query", + "type": "string" + }, + "userEvent": { + "description": "Required. URL encoded UserEvent proto.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/userEvents:collect", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/userEvents:import", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering expression to specify restrictions over returned events. This is a sequence of terms, where each term applies some kind of a restriction to the returned user events. Use this expression to restrict results to a specific time range, or filter events by eventType. eg: eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search We expect only 3 types of fields: * eventTime: this can be specified a maximum of 2 times, once with a less than operator and once with a greater than operator. The eventTime restrict should result in one contiguous valid eventTime range. * eventType: only 1 eventType restriction can be specified. * eventsMissingCatalogItems: specififying this will restrict results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\" * Example 2: eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view * Example 3: eventsMissingCatalogItems eventType = search eventTime < \"2018-04-23T18:30:43.511Z\" * Example 4: eventTime > \"2012-04-23T18:25:43.511Z\" * Example 5: eventType = search * Example 6: eventsMissingCatalogItems", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The previous ListUserEventsResponse.next_page_token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent eventStore resource name, such as \"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/userEvents", + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1ListUserEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the event_store under which the events are created. The format is \"projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rejoin": { + "description": "Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.rejoin", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Full resource name of user event, such as \"projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/userEvents:rejoin", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Writes a single user event.", + "httpMethod": "POST", + "id": "recommendationengine.projects.locations.catalogs.eventStores.userEvents.write", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent eventStore resource name, such as \"projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/eventStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/userEvents:write", + "request": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent" + }, + "response": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "recommendationengine.projects.locations.catalogs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20210125", + "rootUrl": "https://recommendationengine.googleapis.com/", + "schemas": { + "GoogleApiHttpBody": { + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", + "id": "GoogleApiHttpBody", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1alphaRejoinCatalogMetadata": { + "description": "Metadata for TriggerCatalogRejoin method.", + "id": "GoogleCloudRecommendationengineV1alphaRejoinCatalogMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRecommendationengineV1alphaRejoinCatalogResponse": { + "description": "Response message for TriggerCatalogRejoin method.", + "id": "GoogleCloudRecommendationengineV1alphaRejoinCatalogResponse", + "properties": { + "rejoinedUserEventsCount": { + "description": "Number of user events that were joined with latest catalog items.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1alphaTuningMetadata": { + "description": "Metadata associated with a tune operation.", + "id": "GoogleCloudRecommendationengineV1alphaTuningMetadata", + "properties": { + "recommendationModel": { + "description": "The resource name of the recommendation model that this tune applies to. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/eventStores/{event_store_id}/recommendationModels/{recommendation_model_id}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1alphaTuningResponse": { + "description": "Response associated with a tune operation.", + "id": "GoogleCloudRecommendationengineV1alphaTuningResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1BigQuerySource": { + "description": "BigQuery source import data from.", + "id": "GoogleCloudRecommendationengineV1beta1BigQuerySource", + "properties": { + "dataSchema": { + "description": "Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: \"catalog_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: \"catalog_merchant_center\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user event imports: 1: \"user_events_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) 2. \"user_events_ga360\" using https://support.google.com/analytics/answer/3437719?hl=en", + "type": "string" + }, + "datasetId": { + "description": "Required. The BigQuery data set to copy the data from.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Optional. Intermediate Cloud Storage directory used for the import. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.", + "type": "string" + }, + "projectId": { + "description": "Optional. The project id (can be project # or id) that the BigQuery source is in. If not specified, inherits the project id from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The BigQuery table to copy the data from.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1Catalog": { + "description": "The catalog configuration. Next ID: 5.", + "id": "GoogleCloudRecommendationengineV1beta1Catalog", + "properties": { + "catalogItemLevelConfig": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig", + "description": "Required. The catalog item level configuration." + }, + "defaultEventStoreId": { + "description": "Required. The ID of the default event store.", + "type": "string" + }, + "displayName": { + "description": "Required. The catalog display name.", + "type": "string" + }, + "name": { + "description": "The fully qualified resource name of the catalog.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1CatalogInlineSource": { + "description": "The inline source for the input config for ImportCatalogItems method.", + "id": "GoogleCloudRecommendationengineV1beta1CatalogInlineSource", + "properties": { + "catalogItems": { + "description": "Optional. A list of catalog items to update/create. Recommended max of 10k items.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1CatalogItem": { + "description": "CatalogItem captures all metadata information of items to be recommended.", + "id": "GoogleCloudRecommendationengineV1beta1CatalogItem", + "properties": { + "categoryHierarchies": { + "description": "Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both [\"Shoes & Accessories\" -> \"Shoes\"] and [\"Sports & Fitness\" -> \"Athletic Clothing\" -> \"Shoes\"], it could be represented as: \"categoryHierarchies\": [ { \"categories\": [\"Shoes & Accessories\", \"Shoes\"]}, { \"categories\": [\"Sports & Fitness\", \"Athletic Clothing\", \"Shoes\"] } ]", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy" + }, + "type": "array" + }, + "description": { + "description": "Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.", + "type": "string" + }, + "id": { + "description": "Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.", + "type": "string" + }, + "itemAttributes": { + "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMap", + "description": "Optional. Highly encouraged. Extra catalog item attributes to be included in the recommendation model. For example, for retail products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the item attributes here." + }, + "itemGroupId": { + "description": "Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).", + "type": "string" + }, + "languageCode": { + "description": "Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.", + "type": "string" + }, + "productMetadata": { + "$ref": "GoogleCloudRecommendationengineV1beta1ProductCatalogItem", + "description": "Optional. Metadata specific to retail products." + }, + "tags": { + "description": "Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy": { + "description": "Category represents catalog item category hierarchy.", + "id": "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy", + "properties": { + "categories": { + "description": "Required. Catalog item categories. Each category should be a UTF-8 encoded string with a length limit of 2 KiB. Note that the order in the list denotes the specificity (from least to most specific).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig": { + "description": "Configures the catalog level that users send events to, and the level at which predictions are made.", + "id": "GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig", + "properties": { + "eventItemLevel": { + "description": "Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.", + "enum": [ + "CATALOG_ITEM_LEVEL_UNSPECIFIED", + "VARIANT", + "MASTER" + ], + "enumDescriptions": [ + "Unknown value - should never be used.", + "Catalog items are at variant level.", + "Catalog items are at master level." + ], + "type": "string" + }, + "predictItemLevel": { + "description": "Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.", + "enum": [ + "CATALOG_ITEM_LEVEL_UNSPECIFIED", + "VARIANT", + "MASTER" + ], + "enumDescriptions": [ + "Unknown value - should never be used.", + "Catalog items are at variant level.", + "Catalog items are at master level." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest": { + "description": "Request message for the `CreatePredictionApiKeyRegistration` method.", + "id": "GoogleCloudRecommendationengineV1beta1CreatePredictionApiKeyRegistrationRequest", + "properties": { + "predictionApiKeyRegistration": { + "$ref": "GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration", + "description": "Required. The prediction API key registration." + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1EventDetail": { + "description": "User event details shared by all recommendation types.", + "id": "GoogleCloudRecommendationengineV1beta1EventDetail", + "properties": { + "eventAttributes": { + "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMap", + "description": "Optional. Extra user event features to include in the recommendation model. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc." + }, + "experimentIds": { + "description": "Optional. A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Recommendation Engine system, using different recommendation models).", + "items": { + "type": "string" + }, + "type": "array" + }, + "pageViewId": { + "description": "Optional. A unique id of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. This `pageViewId` will be automatically generated if using the JavaScript pixel.", + "type": "string" + }, + "recommendationToken": { + "description": "Optional. Recommendation token included in the recommendation prediction response. This field enables accurate attribution of recommendation model performance. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased item. If user clicks on product K in the recommendation results, pass the `PredictResponse.recommendationToken` property as a url parameter to product K's page. When recording events on product K's page, log the PredictResponse.recommendation_token to this field. Optional, but highly encouraged for user events that are the result of a recommendation prediction query.", + "type": "string" + }, + "referrerUri": { + "description": "Optional. The referrer url of the current page. When using the JavaScript pixel, this value is filled in automatically.", + "type": "string" + }, + "uri": { + "description": "Optional. Complete url (window.location.href) of the user's current page. When using the JavaScript pixel, this value is filled in automatically. Maximum length 5KB.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1FeatureMap": { + "description": "FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.", + "id": "GoogleCloudRecommendationengineV1beta1FeatureMap", + "properties": { + "categoricalFeatures": { + "additionalProperties": { + "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMapStringList" + }, + "description": "Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer. Feature names and values must be UTF-8 encoded strings. For example: `{ \"colors\": {\"value\": [\"yellow\", \"green\"]}, \"sizes\": {\"value\":[\"S\", \"M\"]}`", + "type": "object" + }, + "numericalFeatures": { + "additionalProperties": { + "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMapFloatList" + }, + "description": "Numerical features. Some examples would be the height/weight of a product, or age of a customer. Feature names must be UTF-8 encoded strings. For example: `{ \"lengths_cm\": {\"value\":[2.3, 15.4]}, \"heights_cm\": {\"value\":[8.1, 6.4]} }`", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1FeatureMapFloatList": { + "description": "A list of float features.", + "id": "GoogleCloudRecommendationengineV1beta1FeatureMapFloatList", + "properties": { + "value": { + "description": "Float feature value.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1FeatureMapStringList": { + "description": "A list of string features.", + "id": "GoogleCloudRecommendationengineV1beta1FeatureMapStringList", + "properties": { + "value": { + "description": "String feature value with a length limit of 128 bytes.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1GcsSource": { + "description": "Google Cloud Storage location for input content. format.", + "id": "GoogleCloudRecommendationengineV1beta1GcsSource", + "properties": { + "inputUris": { + "description": "Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See [Importing catalog information](/recommendations-ai/docs/upload-catalog) for the expected file format and setup instructions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "jsonSchema": { + "description": "Optional. The schema to use when parsing the data from the source. Supported values for catalog imports: 1: \"catalog_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#json (Default for catalogItems.import) 2: \"catalog_merchant_center\" using https://cloud.google.com/recommendations-ai/docs/upload-catalog#mc Supported values for user events imports: 1: \"user_events_recommendations_ai\" using https://cloud.google.com/recommendations-ai/docs/manage-user-events#import (Default for userEvents.import) 2. \"user_events_ga360\" using https://support.google.com/analytics/answer/3437719?hl=en", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1Image": { + "description": "Catalog item thumbnail/detail image.", + "id": "GoogleCloudRecommendationengineV1beta1Image", + "properties": { + "height": { + "description": "Optional. Height of the image in number of pixels.", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "Required. URL of the image with a length limit of 5 KiB.", + "type": "string" + }, + "width": { + "description": "Optional. Width of the image in number of pixels.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest": { + "description": "Request message for Import methods.", + "id": "GoogleCloudRecommendationengineV1beta1ImportCatalogItemsRequest", + "properties": { + "errorsConfig": { + "$ref": "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig", + "description": "Optional. The desired location of errors incurred during the Import." + }, + "inputConfig": { + "$ref": "GoogleCloudRecommendationengineV1beta1InputConfig", + "description": "Required. The desired input location of the data." + }, + "requestId": { + "description": "Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response.", + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided imported 'items' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse": { + "description": "Response of the ImportCatalogItemsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRecommendationengineV1beta1ImportCatalogItemsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig", + "description": "Echoes the destination for the complete errors in the request if set." + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig", + "properties": { + "gcsPrefix": { + "description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Import errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ImportMetadata": { + "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRecommendationengineV1beta1ImportMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "operationName": { + "description": "Name of the operation.", + "type": "string" + }, + "requestId": { + "description": "Id of the request / operation. This is parroting back the requestId that was passed in the request.", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest": { + "description": "Request message for the ImportUserEvents request.", + "id": "GoogleCloudRecommendationengineV1beta1ImportUserEventsRequest", + "properties": { + "errorsConfig": { + "$ref": "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig", + "description": "Optional. The desired location of errors incurred during the Import." + }, + "inputConfig": { + "$ref": "GoogleCloudRecommendationengineV1beta1InputConfig", + "description": "Required. The desired input location of the data." + }, + "requestId": { + "description": "Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudRecommendationengineV1beta1ImportUserEventsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "errorsConfig": { + "$ref": "GoogleCloudRecommendationengineV1beta1ImportErrorsConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "importSummary": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEventImportSummary", + "description": "Aggregated statistics of user event import status." + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1InputConfig": { + "description": "The input config source.", + "id": "GoogleCloudRecommendationengineV1beta1InputConfig", + "properties": { + "bigQuerySource": { + "$ref": "GoogleCloudRecommendationengineV1beta1BigQuerySource", + "description": "BigQuery input source." + }, + "catalogInlineSource": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogInlineSource", + "description": "The Inline source for the input content for Catalog items." + }, + "gcsSource": { + "$ref": "GoogleCloudRecommendationengineV1beta1GcsSource", + "description": "Google Cloud Storage location for the input content." + }, + "userEventInlineSource": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEventInlineSource", + "description": "The Inline source for the input content for UserEvents." + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse": { + "description": "Response message for ListCatalogItems method.", + "id": "GoogleCloudRecommendationengineV1beta1ListCatalogItemsResponse", + "properties": { + "catalogItems": { + "description": "The catalog items.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItem" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If empty, the list is complete. If nonempty, the token to pass to the next request's ListCatalogItemRequest.page_token.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ListCatalogsResponse": { + "description": "Response for ListCatalogs method.", + "id": "GoogleCloudRecommendationengineV1beta1ListCatalogsResponse", + "properties": { + "catalogs": { + "description": "Output only. All the customer's catalogs.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1Catalog" + }, + "readOnly": true, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse": { + "description": "Response message for the `ListPredictionApiKeyRegistrations`.", + "id": "GoogleCloudRecommendationengineV1beta1ListPredictionApiKeyRegistrationsResponse", + "properties": { + "nextPageToken": { + "description": "If empty, the list is complete. If nonempty, pass the token to the next request's `ListPredictionApiKeysRegistrationsRequest.pageToken`.", + "type": "string" + }, + "predictionApiKeyRegistrations": { + "description": "The list of registered API keys.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ListUserEventsResponse": { + "description": "Response message for ListUserEvents method.", + "id": "GoogleCloudRecommendationengineV1beta1ListUserEventsResponse", + "properties": { + "nextPageToken": { + "description": "If empty, the list is complete. If nonempty, the token to pass to the next request's ListUserEvents.page_token.", + "type": "string" + }, + "userEvents": { + "description": "The user events.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PredictRequest": { + "description": "Request message for Predict method.", + "id": "GoogleCloudRecommendationengineV1beta1PredictRequest", + "properties": { + "dryRun": { + "description": "Optional. Use dryRun mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary catalog items. Note that the dryRun mode should only be used for testing the API, or if the model is not ready.", + "type": "boolean" + }, + "filter": { + "description": "Optional. Filter for restricting prediction results. Accepts values for tags and the `filterOutOfStockItems` flag. * Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. `-\"tagA\"` is also supported and is equivalent to `NOT \"tagA\"`. Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB. * filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") * filterOutOfStockItems tag=(-\"promotional\") * filterOutOfStockItems If your filter blocks all prediction results, nothing will be returned. If you want generic (unfiltered) popular items to be returned instead, set `strictFiltering` to false in `PredictRequest.params`.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.", + "type": "object" + }, + "pageSize": { + "description": "Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The previous PredictResponse.next_page_token.", + "type": "string" + }, + "params": { + "additionalProperties": { + "type": "any" + }, + "description": "Optional. Additional domain specific parameters for the predictions. Allowed values: * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem object will be returned in the `PredictResponse.PredictionResult.itemMetadata` object in the method response. * `returnItemScore`: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the `metadata` field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular items instead of empty if your filter blocks all prediction results.", + "type": "object" + }, + "userEvent": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent", + "description": "Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging." + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PredictResponse": { + "description": "Response message for predict method.", + "id": "GoogleCloudRecommendationengineV1beta1PredictResponse", + "properties": { + "dryRun": { + "description": "True if the dryRun property was set in the request.", + "type": "boolean" + }, + "itemsMissingInCatalog": { + "description": "IDs of items in the request that were missing from the catalog.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional domain specific prediction response metadata.", + "type": "object" + }, + "nextPageToken": { + "description": "If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.", + "type": "string" + }, + "recommendationToken": { + "description": "A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.", + "type": "string" + }, + "results": { + "description": "A list of recommended items. The order represents the ranking (from the most relevant item to the least).", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult": { + "description": "PredictionResult represents the recommendation prediction results.", + "id": "GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult", + "properties": { + "id": { + "description": "ID of the recommended catalog item", + "type": "string" + }, + "itemMetadata": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional item metadata / annotations. Possible values: * `catalogItem`: JSON representation of the catalogItem. Will be set if `returnCatalogItem` is set to true in `PredictRequest.params`. * `score`: Prediction score in double value. Will be set if `returnItemScore` is set to true in `PredictRequest.params`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration": { + "description": "Registered Api Key.", + "id": "GoogleCloudRecommendationengineV1beta1PredictionApiKeyRegistration", + "properties": { + "apiKey": { + "description": "The API key.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ProductCatalogItem": { + "description": "ProductCatalogItem captures item metadata specific to retail products.", + "id": "GoogleCloudRecommendationengineV1beta1ProductCatalogItem", + "properties": { + "availableQuantity": { + "description": "Optional. The available quantity of the item.", + "format": "int64", + "type": "string" + }, + "canonicalProductUri": { + "description": "Optional. Canonical URL directly linking to the item detail page with a length limit of 5 KiB..", + "type": "string" + }, + "costs": { + "additionalProperties": { + "format": "float", + "type": "number" + }, + "description": "Optional. A map to pass the costs associated with the product. For example: {\"manufacturing\": 45.5} The profit of selling this item is computed like so: * If 'exactPrice' is provided, profit = displayPrice - sum(costs) * If 'priceRange' is provided, profit = minPrice - sum(costs)", + "type": "object" + }, + "currencyCode": { + "description": "Optional. Only required if the price is set. Currency code for price/costs. Use three-character ISO-4217 code.", + "type": "string" + }, + "exactPrice": { + "$ref": "GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice", + "description": "Optional. The exact product price." + }, + "images": { + "description": "Optional. Product images for the catalog item.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1Image" + }, + "type": "array" + }, + "priceRange": { + "$ref": "GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange", + "description": "Optional. The product price range." + }, + "stockState": { + "description": "Optional. Online stock state of the catalog item. Default is `IN_STOCK`.", + "enum": [ + "STOCK_STATE_UNSPECIFIED", + "IN_STOCK", + "OUT_OF_STOCK", + "PREORDER", + "BACKORDER" + ], + "enumDescriptions": [ + "Default item stock status. Should never be used.", + "Item in stock.", + "Item out of stock.", + "Item that is in pre-order state.", + "Item that is back-ordered (i.e. temporarily out of stock)." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice": { + "description": "Exact product price.", + "id": "GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice", + "properties": { + "displayPrice": { + "description": "Optional. Display price of the product.", + "format": "float", + "type": "number" + }, + "originalPrice": { + "description": "Optional. Price of the product without any discount. If zero, by default set to be the 'displayPrice'.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange": { + "description": "Product price range when there are a range of prices for different variations of the same product.", + "id": "GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange", + "properties": { + "max": { + "description": "Required. The maximum product price.", + "format": "float", + "type": "number" + }, + "min": { + "description": "Required. The minimum product price.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ProductDetail": { + "description": "Detailed product information associated with a user event.", + "id": "GoogleCloudRecommendationengineV1beta1ProductDetail", + "properties": { + "availableQuantity": { + "description": "Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if `stock_status` is set to `IN_STOCK`. Note that if an item is out of stock, you must set the `stock_state` field to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not sufficient to mark the item out of stock.", + "format": "int32", + "type": "integer" + }, + "currencyCode": { + "description": "Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.", + "type": "string" + }, + "displayPrice": { + "description": "Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.", + "format": "float", + "type": "number" + }, + "id": { + "description": "Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, + "itemAttributes": { + "$ref": "GoogleCloudRecommendationengineV1beta1FeatureMap", + "description": "Optional. Extra features associated with a product in the user event." + }, + "originalPrice": { + "description": "Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.", + "format": "float", + "type": "number" + }, + "quantity": { + "description": "Optional. Quantity of the product associated with the user event. For example, this field will be 2 if two products are added to the shopping cart for `add-to-cart` event. Required for `add-to-cart`, `add-to-list`, `remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event types.", + "format": "int32", + "type": "integer" + }, + "stockState": { + "description": "Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.", + "enum": [ + "STOCK_STATE_UNSPECIFIED", + "IN_STOCK", + "OUT_OF_STOCK", + "PREORDER", + "BACKORDER" + ], + "enumDescriptions": [ + "Default item stock status. Should never be used.", + "Item in stock.", + "Item out of stock.", + "Item that is in pre-order state.", + "Item that is back-ordered (i.e. temporarily out of stock)." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1ProductEventDetail": { + "description": "ProductEventDetail captures user event information specific to retail products.", + "id": "GoogleCloudRecommendationengineV1beta1ProductEventDetail", + "properties": { + "cartId": { + "description": "Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase. This can only be set for `add-to-cart`, `remove-from-cart`, `checkout-start`, `purchase-complete`, or `shopping-cart-page-view` events.", + "type": "string" + }, + "listId": { + "description": "Required for `add-to-list` and `remove-from-list` events. The id or name of the list that the item is being added to or removed from. Other event types should not set this field.", + "type": "string" + }, + "pageCategories": { + "description": "Required for `category-page-view` events. Other event types should not set this field. The categories associated with a category page. Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: categories : [\"Sales\", \"2017 Black Friday Deals\"].", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy" + }, + "type": "array" + }, + "productDetails": { + "description": "The main product details related to the event. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_details' should be set for this unless the shopping cart is empty. * `search` (highly encouraged) In a `search` event, this field represents the products returned to the end user on the current page (the end user may have not finished broswing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new SEARCH event with different product_details is desired. The end user may have not finished broswing the whole page yet. This field is not allowed for the following event types: * `category-page-view` * `home-page-view`", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1ProductDetail" + }, + "type": "array" + }, + "purchaseTransaction": { + "$ref": "GoogleCloudRecommendationengineV1beta1PurchaseTransaction", + "description": "Optional. A transaction represents the entire purchase transaction. Required for `purchase-complete` events. Optional for `checkout-start` events. Other event types should not set this field." + }, + "searchQuery": { + "description": "Required for `search` events. Other event types should not set this field. The user's search query as UTF-8 encoded text with a length limit of 5 KiB.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PurchaseTransaction": { + "description": "A transaction represents the entire purchase transaction.", + "id": "GoogleCloudRecommendationengineV1beta1PurchaseTransaction", + "properties": { + "costs": { + "additionalProperties": { + "format": "float", + "type": "number" + }, + "description": "Optional. All the costs associated with the product. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs. Total product cost such that profit = revenue - (sum(taxes) + sum(costs)) If product_cost is not set, then profit = revenue - tax - shipping - sum(CatalogItem.costs). If CatalogItem.cost is not specified for one of the items, CatalogItem.cost based profit *cannot* be calculated for this Transaction.", + "type": "object" + }, + "currencyCode": { + "description": "Required. Currency code. Use three-character ISO-4217 code. This field is not required if the event type is `refund`.", + "type": "string" + }, + "id": { + "description": "Optional. The transaction ID with a length limit of 128 bytes.", + "type": "string" + }, + "revenue": { + "description": "Required. Total revenue or grand total associated with the transaction. This value include shipping, tax, or other adjustments to total revenue that you want to include as part of your revenue calculations. This field is not required if the event type is `refund`.", + "format": "float", + "type": "number" + }, + "taxes": { + "additionalProperties": { + "format": "float", + "type": "number" + }, + "description": "Optional. All the taxes associated with the transaction.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata": { + "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudRecommendationengineV1beta1PurgeUserEventsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "operationName": { + "description": "The ID of the request / operation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudRecommendationengineV1beta1PurgeUserEventsRequest", + "properties": { + "filter": { + "description": "Required. The filter string to specify the events to be deleted. Empty string filter is not allowed. The eligible fields for filtering are: * `eventType`: UserEvent.eventType field of type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `visitorId`: field of type string. Specifying this will delete all events associated with a visitor. * `userId`: field of type string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = \"detail-page-view\"` * Deleting all events for a specific visitor: `visitorId = \"visitor1024\"` The filtering fields are assumed to have an implicit AND.", + "type": "string" + }, + "force": { + "description": "Optional. The default value is false. Override this flag to true to actually perform the purge. If the field is not set to true, a sampling of events to be deleted will be returned.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse": { + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudRecommendationengineV1beta1PurgeUserEventsResponse", + "properties": { + "purgedEventsCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "userEventsSample": { + "description": "A sampling of events deleted (or will be deleted) depending on the `force` property in the request. Max of 500 items will be returned.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1RejoinUserEventsMetadata": { + "description": "Metadata for RejoinUserEvents method.", + "id": "GoogleCloudRecommendationengineV1beta1RejoinUserEventsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest": { + "description": "Request message for CatalogRejoin method.", + "id": "GoogleCloudRecommendationengineV1beta1RejoinUserEventsRequest", + "properties": { + "userEventRejoinScope": { + "description": "Required. The type of the catalog rejoin to define the scope and range of the user events to be rejoined with catalog items.", + "enum": [ + "USER_EVENT_REJOIN_SCOPE_UNSPECIFIED", + "JOINED_EVENTS", + "UNJOINED_EVENTS" + ], + "enumDescriptions": [ + "Rejoin catalogs with all events including both joined events and unjoined events.", + "Only rejoin catalogs with joined events.", + "Only rejoin catalogs with unjoined events." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1RejoinUserEventsResponse": { + "description": "Response message for RejoinUserEvents method.", + "id": "GoogleCloudRecommendationengineV1beta1RejoinUserEventsResponse", + "properties": { + "rejoinedUserEventsCount": { + "description": "Number of user events that were joined with latest catalog items.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1UserEvent": { + "description": "UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.", + "id": "GoogleCloudRecommendationengineV1beta1UserEvent", + "properties": { + "eventDetail": { + "$ref": "GoogleCloudRecommendationengineV1beta1EventDetail", + "description": "Optional. User event detailed information common across different recommendation types." + }, + "eventSource": { + "description": "Optional. This field should *not* be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`.", + "enum": [ + "EVENT_SOURCE_UNSPECIFIED", + "AUTOML", + "ECOMMERCE", + "BATCH_UPLOAD" + ], + "enumDescriptions": [ + "Unspecified event source.", + "The event is ingested via a javascript pixel or Recommendations AI Tag through automl datalayer or JS Macros.", + "The event is ingested via Recommendations AI Tag through Enhanced Ecommerce datalayer.", + "The event is ingested via Import user events API." + ], + "type": "string" + }, + "eventTime": { + "description": "Optional. Only required for ImportUserEvents method. Timestamp of user event created.", + "format": "google-datetime", + "type": "string" + }, + "eventType": { + "description": "Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager.", + "type": "string" + }, + "productEventDetail": { + "$ref": "GoogleCloudRecommendationengineV1beta1ProductEventDetail", + "description": "Optional. Retail product specific user event metadata. This field is required for the following event types: * `add-to-cart` * `add-to-list` * `category-page-view` * `checkout-start` * `detail-page-view` * `purchase-complete` * `refund` * `remove-from-cart` * `remove-from-list` * `search` This field is optional for the following event types: * `page-visit` * `shopping-cart-page-view` - note that 'product_event_detail' should be set for this unless the shopping cart is empty. This field is not allowed for the following event types: * `home-page-view`" + }, + "userInfo": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserInfo", + "description": "Required. User information." + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1UserEventImportSummary": { + "description": "A summary of import result. The UserEventImportSummary summarizes the import status for user events.", + "id": "GoogleCloudRecommendationengineV1beta1UserEventImportSummary", + "properties": { + "joinedEventsCount": { + "description": "Count of user events imported with complete existing catalog information.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with catalog information not found in the imported catalog.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1UserEventInlineSource": { + "description": "The inline source for the input config for ImportUserEvents method.", + "id": "GoogleCloudRecommendationengineV1beta1UserEventInlineSource", + "properties": { + "userEvents": { + "description": "Optional. A list of user events to import. Recommended max of 10k items.", + "items": { + "$ref": "GoogleCloudRecommendationengineV1beta1UserEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRecommendationengineV1beta1UserInfo": { + "description": "Information of end users.", + "id": "GoogleCloudRecommendationengineV1beta1UserInfo", + "properties": { + "directUserRequest": { + "description": "Optional. Indicates if the request is made directly from the end user in which case the user_agent and ip_address fields can be populated from the HTTP request. This should *not* be set when using the javascript pixel. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).", + "type": "boolean" + }, + "ipAddress": { + "description": "Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be set when using the javascript pixel or if `direct_user_request` is set. Used to extract location information for personalization.", + "type": "string" + }, + "userAgent": { + "description": "Optional. User agent as included in the HTTP header. UTF-8 encoded string with a length limit of 1 KiB. This should *not* be set when using the JavaScript pixel or if `directUserRequest` is set.", + "type": "string" + }, + "userId": { + "description": "Optional. Unique identifier for logged-in user with a length limit of 128 bytes. Required only for logged-in users.", + "type": "string" + }, + "visitorId": { + "description": "Required. A unique identifier for tracking visitors with a length limit of 128 bytes. For example, this could be implemented with a http cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Maximum length 128 bytes. Cannot be empty.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleLongrunningListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "GoogleLongrunningListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "GoogleLongrunningOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "GoogleLongrunningOperation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Recommendations AI (Beta)", + "version": "v1beta1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/runtimeconfig__v1beta1.json b/discovery/googleapis_beta/runtimeconfig__v1beta1.json deleted file mode 100644 index 4df0e35..0000000 --- a/discovery/googleapis_beta/runtimeconfig__v1beta1.json +++ /dev/null
@@ -1,1156 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloudruntimeconfig": { - "description": "Manage your Google Cloud Platform services' runtime configuration" - } - } - } - }, - "basePath": "", - "baseUrl": "https://runtimeconfig.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Cloud RuntimeConfig", - "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "runtimeconfig:v1beta1", - "kind": "discovery#restDescription", - "name": "runtimeconfig", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "configs": { - "methods": { - "create": { - "description": "Creates a new RuntimeConfig resource. The configuration name must be unique within project.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/configs", - "request": { - "$ref": "RuntimeConfig" - }, - "response": { - "$ref": "RuntimeConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "delete": { - "description": "Deletes a RuntimeConfig resource.", - "httpMethod": "DELETE", - "id": "runtimeconfig.projects.configs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The RuntimeConfig resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "get": { - "description": "Gets information about a RuntimeConfig resource.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the RuntimeConfig resource to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "RuntimeConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value 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).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "list": { - "description": "Lists all the RuntimeConfig resources within project.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848) for this request, in the format `projects/[PROJECT_ID]`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/configs", - "response": { - "$ref": "ListConfigsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "update": { - "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.", - "httpMethod": "PUT", - "id": "runtimeconfig.projects.configs.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the RuntimeConfig resource to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "RuntimeConfig" - }, - "response": { - "$ref": "RuntimeConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - } - }, - "resources": { - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.operations.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/operations/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - } - } - }, - "variables": { - "methods": { - "create": { - "description": "Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the [Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables) documentation.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.variables.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The path to the RutimeConfig resource that this variable should belong to. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/variables", - "request": { - "$ref": "Variable" - }, - "response": { - "$ref": "Variable" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "delete": { - "description": "Deletes a variable or multiple variables. If you specify a variable name, then that variable is deleted. If you specify a prefix and `recursive` is true, then all variables with that prefix are deleted. You must set a `recursive` to true if you delete variables by prefix.", - "httpMethod": "DELETE", - "id": "runtimeconfig.projects.configs.variables.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the variable to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", - "required": true, - "type": "string" - }, - "recursive": { - "description": "Set to `true` to recursively delete multiple variables with the same prefix.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "get": { - "description": "Gets information about a single variable.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.variables.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the variable to return, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Variable" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "list": { - "description": "Lists variables within given a configuration, matching any provided filters. This only lists variable names, not the values, unless `return_values` is true, in which case only variables that user has IAM permission to GetVariable will be returned.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.variables.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Filters variables by matching the specified filter. For example: `projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The path to the RuntimeConfig resource for which you want to list variables. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - }, - "returnValues": { - "description": "The flag indicates whether the user wants to return values of variables. If true, then only those variables that user has IAM GetVariable permission will be returned along with their values.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+parent}/variables", - "response": { - "$ref": "ListVariablesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.variables.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "update": { - "description": "Updates an existing variable with a new value.", - "httpMethod": "PUT", - "id": "runtimeconfig.projects.configs.variables.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the variable to update, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "Variable" - }, - "response": { - "$ref": "Variable" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "watch": { - "description": "Watches a specific variable and waits for a change in the variable's value. When there is a change, this method returns the new value or times out. If a variable is deleted while being watched, the `variableState` state is set to `DELETED` and the method returns the last known variable `value`. If you set the deadline for watching to a larger value than internal timeout (60 seconds), the current variable value is returned and the `variableState` will be `VARIABLE_STATE_UNSPECIFIED`. To learn more about creating a watcher, read the [Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable) documentation.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.variables.watch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the variable to watch, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.*$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:watch", - "request": { - "$ref": "WatchVariableRequest" - }, - "response": { - "$ref": "Variable" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - } - } - }, - "waiters": { - "methods": { - "create": { - "description": "Creates a Waiter resource. This operation returns a long-running Operation resource which can be polled for completion. However, a waiter with the given name will exist (and can be retrieved) prior to the operation completing. If the operation fails, the failed Waiter resource will still exist and must be deleted prior to subsequent creation attempts.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.waiters.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The path to the configuration that will own the waiter. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional but recommended unique `request_id`. If the server receives two `create()` requests with the same `request_id`, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty `request_id` fields are ignored. It is responsibility of the client to ensure uniqueness of the `request_id` strings. `request_id` strings are limited to 64 characters.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/waiters", - "request": { - "$ref": "Waiter" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "delete": { - "description": "Deletes the waiter with the specified name.", - "httpMethod": "DELETE", - "id": "runtimeconfig.projects.configs.waiters.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The Waiter resource to delete, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "get": { - "description": "Gets information about a single waiter.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.waiters.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The fully-qualified name of the Waiter resource object to retrieve, in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Waiter" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "list": { - "description": "List waiters within the given configuration.", - "httpMethod": "GET", - "id": "runtimeconfig.projects.configs.waiters.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The path to the configuration for which you want to get a list of waiters. The configuration must exist beforehand; the path must be in the format: `projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/waiters", - "response": { - "$ref": "ListWaitersResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "httpMethod": "POST", - "id": "runtimeconfig.projects.configs.waiters.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ] - } - } - } - } - } - } - } - }, - "revision": "20201006", - "rootUrl": "https://runtimeconfig.googleapis.com/", - "schemas": { - "Binding": { - "description": "Associates `members` with a `role`.", - "id": "Binding", - "properties": { - "bindingId": { - "description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.", - "type": "string" - }, - "condition": { - "$ref": "Expr", - "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 members 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)." - }, - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform 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. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. ", - "items": { - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.", - "type": "string" - } - }, - "type": "object" - }, - "Cardinality": { - "description": "A Cardinality condition for the Waiter resource. A cardinality condition is met when the number of variables under a specified path prefix reaches a predefined number. For example, if you set a Cardinality condition where the `path` is set to `/foo` and the number of paths is set to `2`, the following variables would meet the condition in a RuntimeConfig resource: + `/foo/variable1 = \"value1\"` + `/foo/variable2 = \"value2\"` + `/bar/variable3 = \"value3\"` It would not satisfy the same condition with the `number` set to `3`, however, because there is only 2 paths that start with `/foo`. Cardinality conditions are recursive; all subtrees under the specific path prefix are counted.", - "id": "Cardinality", - "properties": { - "number": { - "description": "The number variables under the `path` that must exist to meet this condition. Defaults to 1 if not specified.", - "format": "int32", - "type": "integer" - }, - "path": { - "description": "The root of the variable subtree to monitor. For example, `/foo`.", - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "EndCondition": { - "description": "The condition that a Waiter resource is waiting for.", - "id": "EndCondition", - "properties": { - "cardinality": { - "$ref": "Cardinality", - "description": "The cardinality of the `EndCondition`." - } - }, - "type": "object" - }, - "Expr": { - "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() < 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", - "properties": { - "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" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "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" - }, - "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" - }, - "ListConfigsResponse": { - "description": "`ListConfigs()` returns the following response. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.", - "id": "ListConfigsResponse", - "properties": { - "configs": { - "description": "A list of the configurations in the project. The order of returned objects is arbitrary; that is, it is not ordered in any particular way.", - "items": { - "$ref": "RuntimeConfig" - }, - "type": "array" - }, - "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results", - "type": "string" - } - }, - "type": "object" - }, - "ListVariablesResponse": { - "description": "Response for the `ListVariables()` method.", - "id": "ListVariablesResponse", - "properties": { - "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results", - "type": "string" - }, - "variables": { - "description": "A list of variables and their values. The order of returned variable objects is arbitrary.", - "items": { - "$ref": "Variable" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListWaitersResponse": { - "description": "Response for the `ListWaiters()` method. Order of returned waiter objects is arbitrary.", - "id": "ListWaitersResponse", - "properties": { - "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results", - "type": "string" - }, - "waiters": { - "description": "Found waiters in the project.", - "items": { - "$ref": "Waiter" - }, - "type": "array" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "Policy": { - "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` to a single `role`. Members 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 < 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 < 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/).", - "id": "Policy", - "properties": { - "bindings": { - "description": "Associates a list of `members` to 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 member.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "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" - }, - "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).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "RuntimeConfig": { - "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. A RuntimeConfig resource consists of metadata and a hierarchy of variables.", - "id": "RuntimeConfig", - "properties": { - "description": { - "description": "An optional description of the RuntimeConfig object.", - "type": "string" - }, - "name": { - "description": "The resource name of a runtime config. The name must have the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME] The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an arbitrary name that matches the `[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression. The length of `[CONFIG_NAME]` must be less than 64 characters. You pick the RuntimeConfig resource name, but the server will validate that the name adheres to this format. After you create the resource, you cannot change the resource's name.", - "type": "string" - } - }, - "type": "object" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "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 Cloud Platform services (such as Projects) might reject them." - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "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": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Variable": { - "description": "Describes a single variable within a RuntimeConfig resource. The name denotes the hierarchical variable name. For example, `ports/serving_port` is a valid variable name. The variable value is an opaque string and only leaf variables can have values (that is, variables that do not have any child variables).", - "id": "Variable", - "properties": { - "name": { - "description": "The name of the variable resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME] The `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a valid RuntimeConfig resource and `[VARIABLE_NAME]` follows Unix file system file path naming. The `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match [0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression. The length of a `[VARIABLE_NAME]` must be less than 256 characters. Once you create a variable, you cannot change the variable name.", - "type": "string" - }, - "state": { - "description": "Output only. The current state of the variable. The variable state indicates the outcome of the `variables().watch` call and is visible through the `get` and `list` calls.", - "enum": [ - "VARIABLE_STATE_UNSPECIFIED", - "UPDATED", - "DELETED" - ], - "enumDescriptions": [ - "Default variable state.", - "The variable was updated, while `variables().watch` was executing.", - "The variable was deleted, while `variables().watch` was executing." - ], - "type": "string" - }, - "text": { - "description": "The string value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. For example, `text: \"my text value\"`. The string must be valid UTF-8.", - "type": "string" - }, - "updateTime": { - "description": "Output only. The time of the last variable update. Timestamp will be UTC timestamp.", - "format": "google-datetime", - "type": "string" - }, - "value": { - "description": "The binary value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. The value must be base64 encoded, and must comply with IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Only one of `value` or `text` can be set.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "Waiter": { - "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource to be met before it returns. For example, assume you have a distributed system where each node writes to a Variable resource indicating the node's readiness as part of the startup process. You then configure a Waiter resource with the success condition set to wait until some number of nodes have checked in. Afterwards, your application runs some arbitrary code after the condition has been met and the waiter returns successfully. Once created, a Waiter resource is immutable. To learn more about using waiters, read the [Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter) documentation.", - "id": "Waiter", - "properties": { - "createTime": { - "description": "Output only. The instant at which this Waiter resource was created. Adding the value of `timeout` to this instant yields the timeout deadline for the waiter.", - "format": "google-datetime", - "type": "string" - }, - "done": { - "description": "Output only. If the value is `false`, it means the waiter is still waiting for one of its conditions to be met. If true, the waiter has finished. If the waiter finished due to a timeout or failure, `error` will be set.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "Output only. If the waiter ended due to a failure or timeout, this value will be set." - }, - "failure": { - "$ref": "EndCondition", - "description": "[Optional] The failure condition of this waiter. If this condition is met, `done` will be set to `true` and the `error` code will be set to `ABORTED`. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated. This value is optional; if no failure condition is set, the only failure scenario will be a timeout." - }, - "name": { - "description": "The name of the Waiter resource, in the format: projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME] The `[PROJECT_ID]` must be a valid Google Cloud project ID, the `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the `[WAITER_NAME]` must match RFC 1035 segment specification, and the length of `[WAITER_NAME]` must be less than 64 bytes. After you create a Waiter resource, you cannot change the resource name.", - "type": "string" - }, - "success": { - "$ref": "EndCondition", - "description": "[Required] The success condition. If this condition is met, `done` will be set to `true` and the `error` value will remain unset. The failure condition takes precedence over the success condition. If both conditions are met, a failure will be indicated." - }, - "timeout": { - "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from the instant that `waiters().create` method is called. If this time elapses before the success or failure conditions are met, the waiter fails and sets the `error` code to `DEADLINE_EXCEEDED`.", - "format": "google-duration", - "type": "string" - } - }, - "type": "object" - }, - "WatchVariableRequest": { - "description": "Request for the `WatchVariable()` method.", - "id": "WatchVariableRequest", - "properties": { - "newerThan": { - "description": "If specified, checks the current timestamp of the variable and if the current timestamp is newer than `newerThan` timestamp, the method returns immediately. If not specified or the variable has an older timestamp, the watcher waits for a the value to change before returning.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Runtime Configuration API", - "version": "v1beta1", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/sasportal__v1alpha1.json b/discovery/googleapis_beta/sasportal__v1alpha1.json index a753df8..1940b9f 100644 --- a/discovery/googleapis_beta/sasportal__v1alpha1.json +++ b/discovery/googleapis_beta/sasportal__v1alpha1.json
@@ -141,7 +141,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListCustomers method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListCustomers that indicates where this listing should continue from.", "location": "query", "type": "string" } @@ -191,6 +191,121 @@ "resources": { "deployments": { "methods": { + "create": { + "description": "Creates a new deployment.", + "httpMethod": "POST", + "id": "sasportal.customers.deployments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name where the deployment is to be created.", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "delete": { + "description": "Deletes a deployment.", + "httpMethod": "DELETE", + "id": "sasportal.customers.deployments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^customers/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "get": { + "description": "Returns a requested deployment.", + "httpMethod": "GET", + "id": "sasportal.customers.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^customers/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "sasportal.customers.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^customers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, "move": { "description": "Moves a deployment under another node or customer.", "httpMethod": "POST", @@ -217,6 +332,39 @@ "scopes": [ "https://www.googleapis.com/auth/userinfo.email" ] + }, + "patch": { + "description": "Updates an existing deployment.", + "httpMethod": "PATCH", + "id": "sasportal.customers.deployments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name.", + "location": "path", + "pattern": "^customers/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] } }, "resources": { @@ -285,7 +433,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -322,33 +470,6 @@ }, "devices": { "methods": { - "bulk": { - "description": "Creates a device under a node or customer. Returned devices are unordered.", - "httpMethod": "POST", - "id": "sasportal.customers.devices.bulk", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent resource.", - "location": "path", - "pattern": "^customers/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/devices:bulk", - "request": { - "$ref": "SasPortalBulkCreateDeviceRequest" - }, - "response": { - "$ref": "SasPortalBulkCreateDeviceResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - }, "create": { "description": "Creates a device under a node or customer.", "httpMethod": "POST", @@ -460,7 +581,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -692,6 +813,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -699,7 +825,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -781,6 +907,175 @@ } }, "resources": { + "deployments": { + "methods": { + "create": { + "description": "Creates a new deployment.", + "httpMethod": "POST", + "id": "sasportal.customers.nodes.deployments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name where the deployment is to be created.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "sasportal.customers.nodes.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + } + }, + "devices": { + "methods": { + "create": { + "description": "Creates a device under a node or customer.", + "httpMethod": "POST", + "id": "sasportal.customers.nodes.devices.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/devices", + "request": { + "$ref": "SasPortalDevice" + }, + "response": { + "$ref": "SasPortalDevice" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "createSigned": { + "description": "Creates a signed device under a node or customer.", + "httpMethod": "POST", + "id": "sasportal.customers.nodes.devices.createSigned", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/devices:createSigned", + "request": { + "$ref": "SasPortalCreateSignedDeviceRequest" + }, + "response": { + "$ref": "SasPortalDevice" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists devices under a node or customer.", + "httpMethod": "GET", + "id": "sasportal.customers.nodes.devices.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent resource.", + "location": "path", + "pattern": "^customers/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/devices", + "response": { + "$ref": "SasPortalListDevicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + } + }, "nodes": { "methods": { "create": { @@ -818,6 +1113,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -825,7 +1125,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -852,6 +1152,32 @@ } }, "deployments": { + "methods": { + "get": { + "description": "Returns a requested deployment.", + "httpMethod": "GET", + "id": "sasportal.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + }, "resources": { "devices": { "methods": { @@ -1024,7 +1350,7 @@ "installer": { "methods": { "generateSecret": { - "description": "Generates a secret to be used with the ValidateInstaller method", + "description": "Generates a secret to be used with the ValidateInstaller.", "httpMethod": "POST", "id": "sasportal.installer.generateSecret", "parameterOrder": [], @@ -1089,6 +1415,94 @@ "resources": { "deployments": { "methods": { + "delete": { + "description": "Deletes a deployment.", + "httpMethod": "DELETE", + "id": "sasportal.nodes.deployments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^nodes/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "get": { + "description": "Returns a requested deployment.", + "httpMethod": "GET", + "id": "sasportal.nodes.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the deployment.", + "location": "path", + "pattern": "^nodes/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "sasportal.nodes.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + }, "move": { "description": "Moves a deployment under another node or customer.", "httpMethod": "POST", @@ -1115,6 +1529,39 @@ "scopes": [ "https://www.googleapis.com/auth/userinfo.email" ] + }, + "patch": { + "description": "Updates an existing deployment.", + "httpMethod": "PATCH", + "id": "sasportal.nodes.deployments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name.", + "location": "path", + "pattern": "^nodes/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha1/{+name}", + "request": { + "$ref": "SasPortalDeployment" + }, + "response": { + "$ref": "SasPortalDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] } }, "resources": { @@ -1183,7 +1630,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -1220,33 +1667,6 @@ }, "devices": { "methods": { - "bulk": { - "description": "Creates a device under a node or customer. Returned devices are unordered.", - "httpMethod": "POST", - "id": "sasportal.nodes.devices.bulk", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent resource.", - "location": "path", - "pattern": "^nodes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/devices:bulk", - "request": { - "$ref": "SasPortalBulkCreateDeviceRequest" - }, - "response": { - "$ref": "SasPortalBulkCreateDeviceResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - }, "create": { "description": "Creates a device under a node or customer.", "httpMethod": "POST", @@ -1358,7 +1778,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -1590,6 +2010,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -1597,7 +2022,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -1679,35 +2104,79 @@ } }, "resources": { - "devices": { + "deployments": { "methods": { - "bulk": { - "description": "Creates a device under a node or customer. Returned devices are unordered.", + "create": { + "description": "Creates a new deployment.", "httpMethod": "POST", - "id": "sasportal.nodes.nodes.devices.bulk", + "id": "sasportal.nodes.nodes.deployments.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The name of the parent resource.", + "description": "Required. The parent resource name where the deployment is to be created.", "location": "path", "pattern": "^nodes/[^/]+/nodes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha1/{+parent}/devices:bulk", + "path": "v1alpha1/{+parent}/deployments", "request": { - "$ref": "SasPortalBulkCreateDeviceRequest" + "$ref": "SasPortalDeployment" }, "response": { - "$ref": "SasPortalBulkCreateDeviceResponse" + "$ref": "SasPortalDeployment" }, "scopes": [ "https://www.googleapis.com/auth/userinfo.email" ] }, + "list": { + "description": "Lists deployments.", + "httpMethod": "GET", + "id": "sasportal.nodes.nodes.deployments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no deployments are filtered.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deployments to return in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2.", + "location": "path", + "pattern": "^nodes/[^/]+/nodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}/deployments", + "response": { + "$ref": "SasPortalListDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/userinfo.email" + ] + } + } + }, + "devices": { + "methods": { "create": { "description": "Creates a device under a node or customer.", "httpMethod": "POST", @@ -1771,7 +2240,7 @@ ], "parameters": { "filter": { - "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial_number of the device. The filter is case insensitive.", + "description": "The filter expression. The filter should have one of the following formats: \"sn=123454\" or \"display_name=MyDevice\". sn corresponds to serial number of the device. The filter is case insensitive.", "location": "query", "type": "string" }, @@ -1841,6 +2310,11 @@ "parent" ], "parameters": { + "filter": { + "description": "The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "The maximum number of nodes to return in the response.", "format": "int32", @@ -1848,7 +2322,7 @@ "type": "integer" }, "pageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates where this listing should continue from.", + "description": "A pagination token returned from a previous call to ListNodes that indicates where this listing should continue from.", "location": "query", "type": "string" }, @@ -1930,7 +2404,7 @@ } } }, - "revision": "20201006", + "revision": "20210202", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -1951,42 +2425,17 @@ }, "type": "object" }, - "SasPortalBulkCreateDeviceRequest": { - "description": "Request for BulkCreateDevice method.", - "id": "SasPortalBulkCreateDeviceRequest", - "properties": { - "csv": { - "description": "Required. A csv with each row representing a [device]. Each row must conform to the regulations described on CreateDeviceRequest's device field.", - "type": "string" - } - }, - "type": "object" - }, - "SasPortalBulkCreateDeviceResponse": { - "description": "Response for BulkCreateDevice method.", - "id": "SasPortalBulkCreateDeviceResponse", - "properties": { - "devices": { - "description": "Required. The devices that were imported.", - "items": { - "$ref": "SasPortalDevice" - }, - "type": "array" - } - }, - "type": "object" - }, "SasPortalCreateSignedDeviceRequest": { - "description": "Request for CreateSignedDevice method.", + "description": "Request for CreateSignedDevice.", "id": "SasPortalCreateSignedDeviceRequest", "properties": { "encodedDevice": { - "description": "Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the [Device]. The user_id field must be set.", + "description": "Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The user_id field must be set.", "format": "byte", "type": "string" }, "installerId": { - "description": "Required. Unique installer id (cpiId) from the Certified Professional Installers database.", + "description": "Required. Unique installer id (CPI ID) from the Certified Professional Installers database.", "type": "string" } }, @@ -2014,6 +2463,60 @@ }, "type": "object" }, + "SasPortalDeployment": { + "description": "The Deployment.", + "id": "SasPortalDeployment", + "properties": { + "allowedBillingModes": { + "description": "The allowed billing modes under this deployment.", + "items": { + "enum": [ + "BILLING_MODE_UNSPECIFIED", + "MOBILE", + "FIXED_WIRELESS" + ], + "enumDescriptions": [ + "Billing mode has not been specified.", + "Price is based on category of CBSD: Category A, Category B registered with SAS.", + "Price is based on type of CBSD: Base station or CPE." + ], + "type": "string" + }, + "type": "array" + }, + "defaultBillingMode": { + "description": "Default billing mode for the deployment and devices under it.", + "enum": [ + "BILLING_MODE_UNSPECIFIED", + "MOBILE", + "FIXED_WIRELESS" + ], + "enumDescriptions": [ + "Billing mode has not been specified.", + "Price is based on category of CBSD: Category A, Category B registered with SAS.", + "Price is based on type of CBSD: Base station or CPE." + ], + "type": "string" + }, + "displayName": { + "description": "The deployment's display name.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name.", + "readOnly": true, + "type": "string" + }, + "sasUserIds": { + "description": "User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "SasPortalDevice": { "id": "SasPortalDevice", "properties": { @@ -2076,7 +2579,7 @@ "id": "SasPortalDeviceAirInterface", "properties": { "radioTechnology": { - "description": "This field specifies the radio access technology that is used for the CBSD. Conditional", + "description": "Conditional. This field specifies the radio access technology that is used for the CBSD.", "enum": [ "RADIO_TECHNOLOGY_UNSPECIFIED", "E_UTRA", @@ -2102,7 +2605,7 @@ "type": "string" }, "supportedSpec": { - "description": "This field is related to the radioTechnology field and provides the air interface specification that the CBSD is compliant with at the time of registration. Optional", + "description": "Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration.", "type": "string" } }, @@ -2139,7 +2642,7 @@ "description": "Installation parameters for the device." }, "isSigned": { - "description": "Output-only. Whether the configuration has been signed by a CPI.", + "description": "Output only. Whether the configuration has been signed by a CPI.", "type": "boolean" }, "measurementCapabilities": { @@ -2178,7 +2681,7 @@ "type": "string" }, "updateTime": { - "description": "Output-only. The last time the device configuration was edited.", + "description": "Output only. The last time the device configuration was edited.", "format": "google-datetime", "type": "string" }, @@ -2221,7 +2724,7 @@ "type": "string" }, "maxEirp": { - "description": "Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).", + "description": "Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3).", "format": "double", "type": "number" }, @@ -2334,17 +2837,17 @@ "type": "object" }, "SasPortalGenerateSecretRequest": { - "description": "Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret].", + "description": "Request for GenerateSecret.", "id": "SasPortalGenerateSecretRequest", "properties": {}, "type": "object" }, "SasPortalGenerateSecretResponse": { - "description": "Response for GenerateSecret method.", + "description": "Response for GenerateSecret.", "id": "SasPortalGenerateSecretResponse", "properties": { "secret": { - "description": "The secret generated by the string and used by [ValidateInstaller] method.", + "description": "The secret generated by the string and used by ValidateInstaller.", "type": "string" } }, @@ -2399,7 +2902,7 @@ "type": "integer" }, "height": { - "description": "Device antenna height in meters. When the heightType parameter value is \"AGL\", the antenna height should be given relative to ground level. When the heightType parameter value is \"AMSL\", it is given with respect to WGS84 datum.", + "description": "Device antenna height in meters. When the `heightType` parameter value is \"AGL\", the antenna height should be given relative to ground level. When the `heightType` parameter value is \"AMSL\", it is given with respect to WGS84 datum.", "format": "double", "type": "number" }, @@ -2423,7 +2926,7 @@ "type": "number" }, "indoorDeployment": { - "description": "Whether the device antenna is indoor or not. True: indoor. False: outdoor.", + "description": "Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor.", "type": "boolean" }, "latitude": { @@ -2432,7 +2935,7 @@ "type": "number" }, "longitude": { - "description": "Longitude of the device antenna location. in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.", + "description": "Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.", "format": "double", "type": "number" }, @@ -2456,14 +2959,32 @@ "type": "array" }, "nextPageToken": { - "description": "A pagination token returned from a previous call to ListCustomers method that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.", + "description": "A pagination token returned from a previous call to ListCustomers that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.", + "type": "string" + } + }, + "type": "object" + }, + "SasPortalListDeploymentsResponse": { + "description": "Response for ListDeployments.", + "id": "SasPortalListDeploymentsResponse", + "properties": { + "deployments": { + "description": "The deployments that match the request.", + "items": { + "$ref": "SasPortalDeployment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A pagination token returned from a previous call to ListDeployments that indicates from where listing should continue. If the field is missing or empty, it means there are no more deployments.", "type": "string" } }, "type": "object" }, "SasPortalListDevicesResponse": { - "description": "Response for ListDevices method.", + "description": "Response for ListDevices.", "id": "SasPortalListDevicesResponse", "properties": { "devices": { @@ -2474,18 +2995,18 @@ "type": "array" }, "nextPageToken": { - "description": "A pagination token returned from a previous call to ListDevices method that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices.", + "description": "A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices.", "type": "string" } }, "type": "object" }, "SasPortalListNodesResponse": { - "description": "Response for ListNodes method.", + "description": "Response for ListNodes.", "id": "SasPortalListNodesResponse", "properties": { "nextPageToken": { - "description": "A pagination token returned from a previous call to ListNodes method that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes.", + "description": "A pagination token returned from a previous call to ListNodes that indicates from where listing should continue. If the field is missing or empty, it means there is no more nodes.", "type": "string" }, "nodes": { @@ -2499,33 +3020,33 @@ "type": "object" }, "SasPortalMoveDeploymentRequest": { - "description": "Request for MoveDeployment method.", + "description": "Request for MoveDeployment.", "id": "SasPortalMoveDeploymentRequest", "properties": { "destination": { - "description": "Required. The name of the new parent resource Node or Customer to reparent the deployment under.", + "description": "Required. The name of the new parent resource node or customer to reparent the deployment under.", "type": "string" } }, "type": "object" }, "SasPortalMoveDeviceRequest": { - "description": "Request for MoveDevice method.", + "description": "Request for MoveDevice.", "id": "SasPortalMoveDeviceRequest", "properties": { "destination": { - "description": "Required. The name of the new parent resource (Node or Customer) to reparent the device under.", + "description": "Required. The name of the new parent resource node or customer to reparent the device under.", "type": "string" } }, "type": "object" }, "SasPortalMoveNodeRequest": { - "description": "Request for MoveNode method.", + "description": "Request for MoveNode.", "id": "SasPortalMoveNodeRequest", "properties": { "destination": { - "description": "Required. The name of the new parent resource node or Customer) to reparent the node under.", + "description": "Required. The name of the new parent resource node or customer to reparent the node under.", "type": "string" } }, @@ -2593,13 +3114,14 @@ "id": "SasPortalPolicy", "properties": { "assignments": { + "description": "List of assignments", "items": { "$ref": "SasPortalAssignment" }, "type": "array" }, "etag": { - "description": "The [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 [GetPolicy], and systems are expected to put that etag in the request to [SetPolicy] to ensure that their change will be applied to the same version of the policy. If no [etag] is provided in the call to [SetPolicy], then the existing policy is overwritten blindly.", + "description": "The 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 GetPolicy, and systems are expected to put that etag in the request to SetPolicy to ensure that their change will be applied to the same version of the policy. If no etag is provided in the call to GetPolicy, then the existing policy is overwritten blindly.", "format": "byte", "type": "string" } @@ -2622,7 +3144,7 @@ "type": "object" }, "SasPortalSignDeviceRequest": { - "description": "Request for SignDevice method.", + "description": "Request for SignDevice.", "id": "SasPortalSignDeviceRequest", "properties": { "device": { @@ -2692,7 +3214,7 @@ "type": "object" }, "SasPortalUpdateSignedDeviceRequest": { - "description": "Request for UpdateSignedDevice method.", + "description": "Request for UpdateSignedDevice.", "id": "SasPortalUpdateSignedDeviceRequest", "properties": { "encodedDevice": { @@ -2708,7 +3230,7 @@ "type": "object" }, "SasPortalValidateInstallerRequest": { - "description": "Request for ValidateInstaller method.", + "description": "Request for ValidateInstaller.", "id": "SasPortalValidateInstallerRequest", "properties": { "encodedSecret": { @@ -2716,18 +3238,18 @@ "type": "string" }, "installerId": { - "description": "Required. Unique installer id (cpiId) from the Certified Professional Installers database.", + "description": "Required. Unique installer id (CPI ID) from the Certified Professional Installers database.", "type": "string" }, "secret": { - "description": "Required. Secret returned by the GenerateSecret method.", + "description": "Required. Secret returned by the GenerateSecret.", "type": "string" } }, "type": "object" }, "SasPortalValidateInstallerResponse": { - "description": "Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller].", + "description": "Response for ValidateInstaller.", "id": "SasPortalValidateInstallerResponse", "properties": {}, "type": "object"
diff --git a/discovery/googleapis_beta/speech__v2beta1.json b/discovery/googleapis_beta/speech__v2beta1.json deleted file mode 100644 index 6fac9c5..0000000 --- a/discovery/googleapis_beta/speech__v2beta1.json +++ /dev/null
@@ -1,403 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://speech.googleapis.com/", - "batchPath": "batch", - "canonicalName": "Speech", - "description": "Converts audio to text by applying powerful neural network models.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "speech:v2beta1", - "kind": "discovery#restDescription", - "name": "speech", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "locations": { - "resources": { - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "speech.projects.locations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v2beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", - "id": "speech.projects.locations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v2beta1/{+name}/operations", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - }, - "revision": "20201001", - "rootUrl": "https://speech.googleapis.com/", - "schemas": { - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" - }, - "type": "array" - } - }, - "type": "object" - }, - "LongRunningRecognizeMetadata": { - "description": "Describes the progress of a long-running `LongRunningRecognize` call. It is included in the `metadata` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", - "id": "LongRunningRecognizeMetadata", - "properties": { - "lastUpdateTime": { - "description": "Output only. Time of the most recent processing update.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "progressPercent": { - "description": "Output only. Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "startTime": { - "description": "Output only. Time when the request was received.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "uri": { - "description": "The URI of the audio file being transcribed. Empty if the audio was sent as byte content.", - "type": "string" - } - }, - "type": "object" - }, - "LongRunningRecognizeResponse": { - "description": "The only message returned to the client by the `LongRunningRecognize` method. It contains the result as zero or more sequential SpeechRecognitionResult messages. It is included in the `result.response` field of the `Operation` returned by the `GetOperation` call of the `google::longrunning::Operations` service.", - "id": "LongRunningRecognizeResponse", - "properties": { - "results": { - "description": "Output only. Sequential list of transcription results corresponding to sequential portions of audio.", - "items": { - "$ref": "SpeechRecognitionResult" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "SpeechRecognitionAlternative": { - "description": "Alternative hypotheses (a.k.a. n-best list).", - "id": "SpeechRecognitionAlternative", - "properties": { - "confidence": { - "description": "Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set.", - "format": "float", - "readOnly": true, - "type": "number" - }, - "transcript": { - "description": "Output only. Transcript text representing the words that the user spoke.", - "readOnly": true, - "type": "string" - }, - "words": { - "description": "Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is true, you will see all the words from the beginning of the audio.", - "items": { - "$ref": "WordInfo" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "SpeechRecognitionResult": { - "description": "A speech recognition result corresponding to a portion of the audio.", - "id": "SpeechRecognitionResult", - "properties": { - "alternatives": { - "description": "Output only. May contain one or more recognition hypotheses (up to the maximum specified in `max_alternatives`). These alternatives are ordered in terms of accuracy, with the top (first) alternative being the most probable, as ranked by the recognizer.", - "items": { - "$ref": "SpeechRecognitionAlternative" - }, - "readOnly": true, - "type": "array" - }, - "channelTag": { - "description": "Output only. For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel. For `audio_channel_count` = N, its output values can range from `1` to `N`.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "languageCode": { - "description": "Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "WordInfo": { - "description": "Word-specific information for recognized words.", - "id": "WordInfo", - "properties": { - "confidence": { - "description": "Output only. The confidence estimate between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. This field is set only for the top alternative of a non-streaming result or, of a streaming result where `is_final=true`. This field is not guaranteed to be accurate and users should not rely on it to be always provided. The default of 0.0 is a sentinel value indicating `confidence` was not set.", - "format": "float", - "readOnly": true, - "type": "number" - }, - "endOffset": { - "description": "Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.", - "format": "google-duration", - "readOnly": true, - "type": "string" - }, - "speakerTag": { - "description": "Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from `1` to `diarization_config.max_speaker_count` . `speaker_tag` is set if `diarization_config.enable_speaker_diarization` = `true` and only in the top alternative.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "startOffset": { - "description": "Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word. This field is only set if `enable_word_time_offsets=true` and only in the top hypothesis. This is an experimental feature and the accuracy of the time offset can vary.", - "format": "google-duration", - "readOnly": true, - "type": "string" - }, - "word": { - "description": "Output only. The word corresponding to this set of information.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud Speech-to-Text API", - "version": "v2beta1", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/sqladmin__v1beta4.json b/discovery/googleapis_beta/sqladmin__v1beta4.json index d816c02..222693c 100644 --- a/discovery/googleapis_beta/sqladmin__v1beta4.json +++ b/discovery/googleapis_beta/sqladmin__v1beta4.json
@@ -3,7 +3,7 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "description": "See, edit, configure, and delete your Google Cloud Platform data" }, "https://www.googleapis.com/auth/sqlservice.admin": { "description": "Manage your Google SQL Service instances" @@ -1338,8 +1338,13 @@ "required": true, "type": "string" }, + "skipVerification": { + "description": "Whether to skip the verification step (VESS).", + "location": "query", + "type": "boolean" + }, "syncMode": { - "description": "External sync mode", + "description": "External sync mode.", "enum": [ "EXTERNAL_SYNC_MODE_UNSPECIFIED", "ONLINE", @@ -1780,7 +1785,7 @@ } } }, - "revision": "20200930", + "revision": "20210119", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -1826,6 +1831,10 @@ "message": { "description": "The warning message.", "type": "string" + }, + "region": { + "description": "The region name for REGION_UNREACHABLE warning.", + "type": "string" } }, "type": "object" @@ -1874,6 +1883,22 @@ }, "type": "object" }, + "BackupContext": { + "description": "Backup context.", + "id": "BackupContext", + "properties": { + "backupId": { + "description": "The identifier of the backup.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "This is always *sql#backupContext*.", + "type": "string" + } + }, + "type": "object" + }, "BackupRetentionSettings": { "description": "We currently only support backup retention by specifying the number of backups we will retain.", "id": "BackupRetentionSettings", @@ -1997,7 +2022,7 @@ "type": "string" }, "type": { - "description": "The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\".", + "description": "The type of this run; can be either \"AUTOMATED\" or \"ON_DEMAND\". This field defaults to \"ON_DEMAND\" and is ignored, when specified for insert requests.", "enum": [ "SQL_BACKUP_RUN_TYPE_UNSPECIFIED", "AUTOMATED", @@ -2314,10 +2339,18 @@ "description": "Initial root password. Use only on creation.", "type": "string" }, + "satisfiesPzs": { + "description": "The status indicating if instance satisfies physical zone separation. Reserved for future use.", + "type": "boolean" + }, "scheduledMaintenance": { "$ref": "SqlScheduledMaintenance", "description": "The start time of any upcoming scheduled maintenance for this instance." }, + "secondaryGceZone": { + "description": "The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.", + "type": "string" + }, "selfLink": { "description": "The URI of this resource.", "type": "string" @@ -2335,7 +2368,7 @@ "description": "The user settings." }, "state": { - "description": "The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance has been stopped by owner. It is not currently running, but it's ready to be restarted. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.", + "description": "The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.", "enum": [ "SQL_INSTANCE_STATE_UNSPECIFIED", "RUNNABLE", @@ -2347,7 +2380,7 @@ ], "enumDescriptions": [ "The state of the instance is unknown.", - "The instance has been stopped by owner. It is not currently running, but it's ready to be restarted.", + "The instance is running, or has been stopped by owner.", "The instance is not available, for example due to problems with billing.", "The instance is being deleted.", "The instance is being created.", @@ -2521,7 +2554,7 @@ "id": "ExportContext", "properties": { "csvExportOptions": { - "description": "Options for exporting data as CSV.", + "description": "Options for exporting data as CSV. *MySQL* and *PostgreSQL* instances only.", "properties": { "selectQuery": { "description": "The select query used to extract the data.", @@ -2538,7 +2571,7 @@ "type": "array" }, "fileType": { - "description": "The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data.", + "description": "The file type for the specified uri. *SQL*: The file contains SQL statements. *CSV*: The file contains CSV data. *BAK*: The file contains backup data for a SQL Server instance.", "enum": [ "SQL_FILE_TYPE_UNSPECIFIED", "SQL", @@ -2568,7 +2601,7 @@ "description": "Options for exporting from MySQL.", "properties": { "masterData": { - "description": "Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment, and has no effect. All other values are ignored.", + "description": "Option to include SQL statement required to set up replication. If set to *1*, the dump file includes a CHANGE MASTER TO statement with the binary log coordinates, and --set-gtid-purged is set to ON. If set to *2*, the CHANGE MASTER TO statement is written as a SQL comment and has no effect. If set to any value other than *1*, --set-gtid-purged is set to OFF.", "format": "int32", "type": "integer" } @@ -2590,7 +2623,7 @@ "type": "object" }, "uri": { - "description": "The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs: //bucketName/fileName*. If the file already exists, the requests // succeeds, but the operation fails. If *fileType* is // *SQL* and the filename ends with .gz, the contents are // compressed.", + "description": "The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form *gs://bucketName/fileName*. If the file already exists, the request succeeds, but the operation fails. If *fileType* is *SQL* and the filename ends with .gz, the contents are compressed.", "type": "string" } }, @@ -2816,12 +2849,36 @@ "type": "string" }, "uri": { - "description": "Path to the import file in Cloud Storage, in the form *gs: //bucketName/fileName*. Compressed gzip files (.gz) are supported // when *fileType* is *SQL*. The instance must have // write permissions to the bucket and read access to the file.", + "description": "Path to the import file in Cloud Storage, in the form *gs://bucketName/fileName*. Compressed gzip files (.gz) are supported when *fileType* is *SQL*. The instance must have write permissions to the bucket and read access to the file.", "type": "string" } }, "type": "object" }, + "InsightsConfig": { + "description": "Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.", + "id": "InsightsConfig", + "properties": { + "queryInsightsEnabled": { + "description": "Whether Query Insights feature is enabled.", + "type": "boolean" + }, + "queryStringLength": { + "description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value.", + "format": "int32", + "type": "integer" + }, + "recordApplicationTags": { + "description": "Whether Query Insights will record application tags from query when enabled.", + "type": "boolean" + }, + "recordClientAddress": { + "description": "Whether Query Insights will record client address when enabled.", + "type": "boolean" + } + }, + "type": "object" + }, "InstancesCloneRequest": { "description": "Database instance clone request.", "id": "InstancesCloneRequest", @@ -3032,6 +3089,10 @@ "description": "This is always *sql#locationPreference*.", "type": "string" }, + "secondaryZone": { + "description": "The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.", + "type": "string" + }, "zone": { "description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).", "type": "string" @@ -3167,9 +3228,13 @@ "type": "object" }, "Operation": { - "description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.", + "description": "An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. Next field: 18", "id": "Operation", "properties": { + "backupContext": { + "$ref": "BackupContext", + "description": "The context for backup operation, if applicable." + }, "endTime": { "description": "The time this operation finished in UTC timezone in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*.", "format": "google-datetime", @@ -3487,7 +3552,7 @@ }, "activeDirectoryConfig": { "$ref": "SqlActiveDirectoryConfig", - "description": "Active Directory configuration, for now relevant only for SQL Server" + "description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server." }, "authorizedGaeApplications": { "description": "The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.", @@ -3561,6 +3626,10 @@ }, "type": "array" }, + "insightsConfig": { + "$ref": "InsightsConfig", + "description": "Insights configuration, for now relevant only for Postgres." + }, "ipConfiguration": { "$ref": "IpConfiguration", "description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances." @@ -3634,15 +3703,15 @@ "type": "object" }, "SqlActiveDirectoryConfig": { - "description": "Active Directory configuration, for now relevant only for SQL Server", + "description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.", "id": "SqlActiveDirectoryConfig", "properties": { "domain": { - "description": "Domain name", + "description": "The name of the domain (e.g., mydomain.com).", "type": "string" }, "kind": { - "description": "This will be always sql#activeDirectoryConfig.", + "description": "This is always sql#activeDirectoryConfig.", "type": "string" } }, @@ -3682,7 +3751,9 @@ "INVALID_LOGGING_SETUP", "INVALID_DB_PARAM", "UNSUPPORTED_GTID_MODE", - "SQLSERVER_AGENT_NOT_RUNNING" + "SQLSERVER_AGENT_NOT_RUNNING", + "UNSUPPORTED_TABLE_DEFINITION", + "UNSUPPORTED_DEFINER" ], "enumDescriptions": [ "", @@ -3704,7 +3775,9 @@ "The primary instance logging setup doesn't allow EM sync.", "The primary instance database parameter setup doesn't allow EM sync.", "The gtid_mode is not supported, applicable for MySQL.", - "SQL Server Agent is not running." + "SQL Server Agent is not running.", + "The table definition is not support due to missing primary key or replica identity, applicable for postgres.", + "The customer has a definer that will break EM setup." ], "type": "string" } @@ -3857,6 +3930,10 @@ "description": "SslCerts create ephemeral certificate request.", "id": "SslCertsCreateEphemeralRequest", "properties": { + "access_token": { + "description": "Access token to include in the signed certificate.", + "type": "string" + }, "public_key": { "description": "PEM encoded public key to include in the signed certificate.", "type": "string"
diff --git a/discovery/googleapis_beta/toolresults__v1beta3.json b/discovery/googleapis_beta/toolresults__v1beta3.json index 5cfcbb9..edafa0d 100644 --- a/discovery/googleapis_beta/toolresults__v1beta3.json +++ b/discovery/googleapis_beta/toolresults__v1beta3.json
@@ -1433,7 +1433,7 @@ } } }, - "revision": "20201008", + "revision": "20210203", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { @@ -1738,6 +1738,12 @@ }, "type": "object" }, + "DeviceOutOfMemory": { + "description": "A warning that device ran out of memory", + "id": "DeviceOutOfMemory", + "properties": {}, + "type": "object" + }, "Duration": { "description": " A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.", "id": "Duration", @@ -2465,6 +2471,12 @@ }, "type": "object" }, + "LogcatCollectionError": { + "description": "A warning that there were issues in logcat collection.", + "id": "LogcatCollectionError", + "properties": {}, + "type": "object" + }, "MatrixDimensionDefinition": { "description": "One dimension of the matrix of different runs of a step.", "id": "MatrixDimensionDefinition", @@ -3572,7 +3584,9 @@ "uiElementsTooDeep", "blankScreen", "overlappingUiElements", - "unityException" + "unityException", + "deviceOutOfMemory", + "logcatCollectionError" ], "enumDescriptions": [ "Default unspecified type. Do not use. For versioning only.", @@ -3603,7 +3617,9 @@ "UI element depth is greater than the threshold", "Blank screen is found in the Robo crawl", "Overlapping UI elements are found in the Robo crawl", - "An uncaught Unity exception was detected (these don't crash apps)." + "An uncaught Unity exception was detected (these don't crash apps).", + "Device running out of memory was detected", + "Problems detected while collecting logcat" ], "type": "string" },
diff --git a/discovery/googleapis_beta/tpu__v1alpha1.json b/discovery/googleapis_beta/tpu__v1alpha1.json deleted file mode 100644 index 7791856..0000000 --- a/discovery/googleapis_beta/tpu__v1alpha1.json +++ /dev/null
@@ -1,1164 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "basePath": "", - "baseUrl": "https://tpu.googleapis.com/", - "batchPath": "batch", - "canonicalName": "TPU", - "description": "TPU API provides customers with access to Google TPU technology.", - "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/tpu/", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "id": "tpu:v1alpha1", - "kind": "discovery#restDescription", - "name": "tpu", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "enum": [ - "1", - "2" - ], - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "location": "query", - "type": "string" - }, - "alt": { - "default": "json", - "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", - "type": "string" - }, - "callback": { - "description": "JSONP", - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "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.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "true", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "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", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "location": "query", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "projects": { - "resources": { - "locations": { - "methods": { - "get": { - "description": "Gets information about a location.", - "httpMethod": "GET", - "id": "tpu.projects.locations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name for the location.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "Location" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists information about the supported locations for this service.", - "httpMethod": "GET", - "id": "tpu.projects.locations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The resource that owns the locations collection, if applicable.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha1/{+name}/locations", - "response": { - "$ref": "ListLocationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "acceleratorTypes": { - "methods": { - "get": { - "description": "Gets AcceleratorType.", - "httpMethod": "GET", - "id": "tpu.projects.locations.acceleratorTypes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/acceleratorTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "AcceleratorType" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists accelerator types supported by this API.", - "httpMethod": "GET", - "id": "tpu.projects.locations.acceleratorTypes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "List filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Sort results.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous List request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The parent resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/acceleratorTypes", - "response": { - "$ref": "ListAcceleratorTypesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "nodes": { - "methods": { - "create": { - "description": "Creates a node.", - "httpMethod": "POST", - "id": "tpu.projects.locations.nodes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "nodeId": { - "description": "The unqualified resource name.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The parent resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/nodes", - "request": { - "$ref": "Node" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a node.", - "httpMethod": "DELETE", - "id": "tpu.projects.locations.nodes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the details of a node.", - "httpMethod": "GET", - "id": "tpu.projects.locations.nodes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "Node" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists nodes.", - "httpMethod": "GET", - "id": "tpu.projects.locations.nodes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of items to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous List request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The parent resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/nodes", - "response": { - "$ref": "ListNodesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "reimage": { - "description": "Reimages a node's OS.", - "httpMethod": "POST", - "id": "tpu.projects.locations.nodes.reimage", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}:reimage", - "request": { - "$ref": "ReimageNodeRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "start": { - "description": "Starts a node.", - "httpMethod": "POST", - "id": "tpu.projects.locations.nodes.start", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}:start", - "request": { - "$ref": "StartNodeRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "stop": { - "description": "Stops a node.", - "httpMethod": "POST", - "id": "tpu.projects.locations.nodes.stop", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}:stop", - "request": { - "$ref": "StopNodeRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "httpMethod": "POST", - "id": "tpu.projects.locations.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}:cancel", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "httpMethod": "DELETE", - "id": "tpu.projects.locations.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "httpMethod": "GET", - "id": "tpu.projects.locations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", - "id": "tpu.projects.locations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha1/{+name}/operations", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "tensorflowVersions": { - "methods": { - "get": { - "description": "Gets TensorFlow Version.", - "httpMethod": "GET", - "id": "tpu.projects.locations.tensorflowVersions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorflowVersions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "TensorFlowVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists TensorFlow versions supported by this API.", - "httpMethod": "GET", - "id": "tpu.projects.locations.tensorflowVersions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "List filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Sort results.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of items to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous List request, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "The parent resource name.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+parent}/tensorflowVersions", - "response": { - "$ref": "ListTensorFlowVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - }, - "revision": "20200909", - "rootUrl": "https://tpu.googleapis.com/", - "schemas": { - "AcceleratorType": { - "description": "A accelerator type that a Node can be configured with.", - "id": "AcceleratorType", - "properties": { - "name": { - "description": "The resource name.", - "type": "string" - }, - "type": { - "description": "the accelerator type.", - "type": "string" - } - }, - "type": "object" - }, - "Empty": { - "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); } The JSON representation for `Empty` is empty JSON object `{}`.", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "ListAcceleratorTypesResponse": { - "description": "Response for ListAcceleratorTypes.", - "id": "ListAcceleratorTypesResponse", - "properties": { - "acceleratorTypes": { - "description": "The listed nodes.", - "items": { - "$ref": "AcceleratorType" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The next page token or empty if none.", - "type": "string" - }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "id": "ListLocationsResponse", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "items": { - "$ref": "Location" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "type": "object" - }, - "ListNodesResponse": { - "description": "Response for ListNodes.", - "id": "ListNodesResponse", - "properties": { - "nextPageToken": { - "description": "The next page token or empty if none.", - "type": "string" - }, - "nodes": { - "description": "The listed nodes.", - "items": { - "$ref": "Node" - }, - "type": "array" - }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" - }, - "type": "array" - } - }, - "type": "object" - }, - "ListTensorFlowVersionsResponse": { - "description": "Response for ListTensorFlowVersions.", - "id": "ListTensorFlowVersionsResponse", - "properties": { - "nextPageToken": { - "description": "The next page token or empty if none.", - "type": "string" - }, - "tensorflowVersions": { - "description": "The listed nodes.", - "items": { - "$ref": "TensorFlowVersion" - }, - "type": "array" - }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Location": { - "description": "A resource that represents Google Cloud Platform location.", - "id": "Location", - "properties": { - "displayName": { - "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object" - }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", - "type": "string" - } - }, - "type": "object" - }, - "NetworkEndpoint": { - "description": "A network endpoint over which a TPU worker can be reached.", - "id": "NetworkEndpoint", - "properties": { - "ipAddress": { - "description": "The IP address of this network endpoint.", - "type": "string" - }, - "port": { - "description": "The port of this network endpoint.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Node": { - "description": "A TPU instance.", - "id": "Node", - "properties": { - "acceleratorType": { - "description": "The type of hardware accelerators associated with this node. Required.", - "type": "string" - }, - "cidrBlock": { - "description": "The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block.", - "type": "string" - }, - "createTime": { - "description": "Output only. The time when the node was created.", - "format": "google-datetime", - "type": "string" - }, - "description": { - "description": "The user-supplied description of the TPU. Maximum of 512 characters.", - "type": "string" - }, - "health": { - "description": "The health status of the TPU node.", - "enum": [ - "HEALTH_UNSPECIFIED", - "HEALTHY", - "DEPRECATED_UNHEALTHY", - "TIMEOUT", - "UNHEALTHY_TENSORFLOW", - "UNHEALTHY_MAINTENANCE" - ], - "enumDescriptions": [ - "Health status is unknown: not initialized or failed to retrieve.", - "The resource is healthy.", - "The resource is unhealthy.", - "The resource is unresponsive.", - "The in-guest ML stack is unhealthy.", - "The node is under maintenance/priority boost caused rescheduling and will resume running once rescheduled." - ], - "type": "string" - }, - "healthDescription": { - "description": "Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.", - "type": "string" - }, - "ipAddress": { - "description": "Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Resource labels to represent user-provided metadata.", - "type": "object" - }, - "name": { - "description": "Output only. The immutable name of the TPU", - "type": "string" - }, - "network": { - "description": "The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, \"default\" will be used.", - "type": "string" - }, - "networkEndpoints": { - "description": "Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.", - "items": { - "$ref": "NetworkEndpoint" - }, - "type": "array" - }, - "port": { - "description": "Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.", - "type": "string" - }, - "schedulingConfig": { - "$ref": "SchedulingConfig" - }, - "serviceAccount": { - "description": "Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.", - "type": "string" - }, - "state": { - "description": "Output only. The current state for the TPU Node.", - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "READY", - "RESTARTING", - "REIMAGING", - "DELETING", - "REPAIRING", - "STOPPED", - "STOPPING", - "STARTING", - "PREEMPTED", - "TERMINATED", - "HIDING", - "HIDDEN", - "UNHIDING" - ], - "enumDescriptions": [ - "TPU node state is not known/set.", - "TPU node is being created.", - "TPU node has been created and is fully usable.", - "TPU node is restarting.", - "TPU node is undergoing reimaging.", - "TPU node is being deleted.", - "TPU node is being repaired and may be unusable. Details can be found in the `help_description` field.", - "TPU node is stopped.", - "TPU node is currently stopping.", - "TPU node is currently starting.", - "TPU node has been preempted. Only applies to Preemptible TPU Nodes.", - "TPU node has been terminated due to maintenance or has reached the end of its life cycle (for preemptible nodes).", - "TPU node is currently hiding.", - "TPU node has been hidden.", - "TPU node is currently unhiding." - ], - "type": "string" - }, - "symptoms": { - "description": "Output only. The Symptoms that have occurred to the TPU Node.", - "items": { - "$ref": "Symptom" - }, - "readOnly": true, - "type": "array" - }, - "tensorflowVersion": { - "description": "The version of Tensorflow running in the Node. Required.", - "type": "string" - }, - "useServiceNetworking": { - "description": "Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.", - "type": "boolean" - } - }, - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", - "properties": { - "done": { - "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", - "type": "boolean" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", - "type": "object" - } - }, - "type": "object" - }, - "OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "OperationMetadata", - "properties": { - "apiVersion": { - "description": "[Output only] API version used to start the operation.", - "type": "string" - }, - "cancelRequested": { - "description": "[Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "[Output only] The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "[Output only] The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "statusDetail": { - "description": "[Output only] Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "[Output only] Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "[Output only] Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "ReimageNodeRequest": { - "description": "Request for ReimageNode.", - "id": "ReimageNodeRequest", - "properties": { - "tensorflowVersion": { - "description": "The version for reimage to create.", - "type": "string" - } - }, - "type": "object" - }, - "SchedulingConfig": { - "description": "Sets the scheduling options for this node.", - "id": "SchedulingConfig", - "properties": { - "preemptible": { - "description": "Defines whether the node is preemptible.", - "type": "boolean" - }, - "reserved": { - "description": "Whether the node is created under a reservation.", - "type": "boolean" - } - }, - "type": "object" - }, - "StartNodeRequest": { - "description": "Request for StartNode.", - "id": "StartNodeRequest", - "properties": {}, - "type": "object" - }, - "Status": { - "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", - "id": "Status", - "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - } - }, - "type": "object" - }, - "StopNodeRequest": { - "description": "Request for StopNode.", - "id": "StopNodeRequest", - "properties": {}, - "type": "object" - }, - "Symptom": { - "description": "A Symptom instance.", - "id": "Symptom", - "properties": { - "createTime": { - "description": "Timestamp when the Symptom is created.", - "format": "google-datetime", - "type": "string" - }, - "details": { - "description": "Detailed information of the current Symptom.", - "type": "string" - }, - "symptomType": { - "description": "Type of the Symptom.", - "enum": [ - "SYMPTOM_TYPE_UNSPECIFIED", - "LOW_MEMORY", - "OUT_OF_MEMORY", - "EXECUTE_TIMED_OUT", - "MESH_BUILD_FAIL", - "HBM_OUT_OF_MEMORY" - ], - "enumDescriptions": [ - "Unspecified symptom.", - "TPU VM memory is low.", - "TPU runtime is out of memory.", - "TPU runtime execution has timed out.", - "TPU runtime fails to construct a mesh that recognizes each TPU device's neighbors.", - "TPU HBM is out of memory." - ], - "type": "string" - }, - "workerId": { - "description": "A string used to uniquely distinguish a worker within a TPU node.", - "type": "string" - } - }, - "type": "object" - }, - "TensorFlowVersion": { - "description": "A tensorflow version that a Node can be configured with.", - "id": "TensorFlowVersion", - "properties": { - "name": { - "description": "The resource name.", - "type": "string" - }, - "version": { - "description": "the tensorflow version.", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "", - "title": "Cloud TPU API", - "version": "v1alpha1", - "version_module": true -} \ No newline at end of file
diff --git a/discovery/googleapis_beta/transcoder__v1beta1.json b/discovery/googleapis_beta/transcoder__v1beta1.json new file mode 100644 index 0000000..941690d --- /dev/null +++ b/discovery/googleapis_beta/transcoder__v1beta1.json
@@ -0,0 +1,1497 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://transcoder.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Transcoder", + "description": "This API converts video files into formats suitable for consumer distribution. ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/transcoder/docs/", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "transcoder:v1beta1", + "kind": "discovery#restDescription", + "name": "transcoder", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "jobTemplates": { + "methods": { + "create": { + "description": "Creates a job template in the specified region.", + "httpMethod": "POST", + "id": "transcoder.projects.locations.jobTemplates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "jobTemplateId": { + "description": "Required. The ID to use for the job template, which will become the final component of the job template's resource name. This value should be 4-63 characters, and valid characters must match the regular expression `a-zA-Z*`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location to create this job template. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/jobTemplates", + "request": { + "$ref": "JobTemplate" + }, + "response": { + "$ref": "JobTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a job template.", + "httpMethod": "DELETE", + "id": "transcoder.projects.locations.jobTemplates.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the job template to delete. `projects/{project}/locations/{location}/jobTemplates/{job_template}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the job template data.", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobTemplates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the job template to retrieve. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "JobTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists job templates in the specified region.", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobTemplates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The `next_page_token` value returned from a previous List request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location from which to retrieve the collection of job templates. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/jobTemplates", + "response": { + "$ref": "ListJobTemplatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "jobs": { + "methods": { + "create": { + "description": "Creates a job in the specified region.", + "httpMethod": "POST", + "id": "transcoder.projects.locations.jobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location to create and process this job. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/jobs", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a job.", + "httpMethod": "DELETE", + "id": "transcoder.projects.locations.jobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the job to delete. Format: `projects/{project}/locations/{location}/jobs/{job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the job data.", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the job to retrieve. Format: `projects/{project}/locations/{location}/jobs/{job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists jobs in the specified region.", + "httpMethod": "GET", + "id": "transcoder.projects.locations.jobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The `next_page_token` value returned from a previous List request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/jobs", + "response": { + "$ref": "ListJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210129", + "rootUrl": "https://transcoder.googleapis.com/", + "schemas": { + "AdBreak": { + "description": "Ad break.", + "id": "AdBreak", + "properties": { + "startTimeOffset": { + "description": "Start time in seconds for the ad break, relative to the output file timeline. The default is `0s`.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "Aes128Encryption": { + "description": "Configuration for AES-128 encryption.", + "id": "Aes128Encryption", + "properties": { + "keyUri": { + "description": "Required. URI of the key delivery service. This URI is inserted into the M3U8 header.", + "type": "string" + } + }, + "type": "object" + }, + "Animation": { + "description": "Animation types.", + "id": "Animation", + "properties": { + "animationEnd": { + "$ref": "AnimationEnd", + "description": "End previous animation." + }, + "animationFade": { + "$ref": "AnimationFade", + "description": "Display overlay object with fade animation." + }, + "animationStatic": { + "$ref": "AnimationStatic", + "description": "Display static overlay object." + } + }, + "type": "object" + }, + "AnimationEnd": { + "description": "End previous overlay animation from the video. Without AnimationEnd, the overlay object will keep the state of previous animation until the end of the video.", + "id": "AnimationEnd", + "properties": { + "startTimeOffset": { + "description": "The time to end overlay object, in seconds. Default: 0", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "AnimationFade": { + "description": "Display overlay object with fade animation.", + "id": "AnimationFade", + "properties": { + "endTimeOffset": { + "description": "The time to end the fade animation, in seconds. Default: `start_time_offset` + 1s", + "format": "google-duration", + "type": "string" + }, + "fadeType": { + "description": "Required. Type of fade animation: `FADE_IN` or `FADE_OUT`.", + "enum": [ + "FADE_TYPE_UNSPECIFIED", + "FADE_IN", + "FADE_OUT" + ], + "enumDescriptions": [ + "The fade type is not specified.", + "Fade the overlay object into view.", + "Fade the overlay object out of view." + ], + "type": "string" + }, + "startTimeOffset": { + "description": "The time to start the fade animation, in seconds. Default: 0", + "format": "google-duration", + "type": "string" + }, + "xy": { + "$ref": "NormalizedCoordinate", + "description": "Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video." + } + }, + "type": "object" + }, + "AnimationStatic": { + "description": "Display static overlay object.", + "id": "AnimationStatic", + "properties": { + "startTimeOffset": { + "description": "The time to start displaying the overlay object, in seconds. Default: 0", + "format": "google-duration", + "type": "string" + }, + "xy": { + "$ref": "NormalizedCoordinate", + "description": "Normalized coordinates based on output video resolution. Valid values: `0.0`–`1.0`. `xy` is the upper-left coordinate of the overlay object. For example, use the x and y coordinates {0,0} to position the top-left corner of the overlay animation in the top-left corner of the output video." + } + }, + "type": "object" + }, + "Audio": { + "description": "Audio preprocessing configuration.", + "id": "Audio", + "properties": { + "highBoost": { + "description": "Enable boosting high frequency components. The default is `false`.", + "type": "boolean" + }, + "lowBoost": { + "description": "Enable boosting low frequency components. The default is `false`.", + "type": "boolean" + }, + "lufs": { + "description": "Specify audio loudness normalization in loudness units relative to full scale (LUFS). Enter a value between -24 and 0, where -24 is the Advanced Television Systems Committee (ATSC A/85), -23 is the EU R128 broadcast standard, -19 is the prior standard for online mono audio, -18 is the ReplayGain standard, -16 is the prior standard for stereo audio, -14 is the new online audio standard recommended by Spotify, as well as Amazon Echo, and 0 disables normalization. The default is 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "AudioAtom": { + "description": "The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.", + "id": "AudioAtom", + "properties": { + "channels": { + "description": "List of `Channel`s for this audio stream. for in-depth explanation.", + "items": { + "$ref": "AudioChannel" + }, + "type": "array" + }, + "key": { + "description": "Required. The `EditAtom.key` that references the atom with audio inputs in the `Job.edit_list`.", + "type": "string" + } + }, + "type": "object" + }, + "AudioChannel": { + "description": "The audio channel.", + "id": "AudioChannel", + "properties": { + "inputs": { + "description": "List of `Job.inputs` for this audio channel.", + "items": { + "$ref": "AudioChannelInput" + }, + "type": "array" + } + }, + "type": "object" + }, + "AudioChannelInput": { + "description": "Identifies which input file, track, and channel should be used.", + "id": "AudioChannelInput", + "properties": { + "channel": { + "description": "Required. The zero-based index of the channel in the input file.", + "format": "int32", + "type": "integer" + }, + "gainDb": { + "description": "Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.", + "format": "double", + "type": "number" + }, + "key": { + "description": "Required. The `Input.key` that identifies the input file.", + "type": "string" + }, + "track": { + "description": "Required. The zero-based index of the track in the input file.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AudioStream": { + "description": "Audio stream resource.", + "id": "AudioStream", + "properties": { + "bitrateBps": { + "description": "Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.", + "format": "int32", + "type": "integer" + }, + "channelCount": { + "description": "Number of audio channels. Must be between 1 and 6. The default is 2.", + "format": "int32", + "type": "integer" + }, + "channelLayout": { + "description": "A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is `[\"fl\", \"fr\"]`. Supported channel names: - 'fl' - Front left channel - 'fr' - Front right channel - 'sl' - Side left channel - 'sr' - Side right channel - 'fc' - Front center channel - 'lfe' - Low frequency", + "items": { + "type": "string" + }, + "type": "array" + }, + "codec": { + "description": "The codec for this audio stream. The default is `\"aac\"`. Supported audio codecs: - 'aac' - 'aac-he' - 'aac-he-v2' - 'mp3' - 'ac3' - 'eac3'", + "type": "string" + }, + "mapping": { + "description": "The mapping for the `Job.edit_list` atoms with audio `EditAtom.inputs`.", + "items": { + "$ref": "AudioAtom" + }, + "type": "array" + }, + "sampleRateHertz": { + "description": "The audio sample rate in Hertz. The default is 48000 Hertz.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Color": { + "description": "Color preprocessing configuration.", + "id": "Color", + "properties": { + "brightness": { + "description": "Control brightness of the video. Enter a value between -1 and 1, where -1 is minimum brightness and 1 is maximum brightness. 0 is no change. The default is 0.", + "format": "double", + "type": "number" + }, + "contrast": { + "description": "Control black and white contrast of the video. Enter a value between -1 and 1, where -1 is minimum contrast and 1 is maximum contrast. 0 is no change. The default is 0.", + "format": "double", + "type": "number" + }, + "saturation": { + "description": "Control color saturation of the video. Enter a value between -1 and 1, where -1 is fully desaturated and 1 is maximum saturation. 0 is no change. The default is 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Crop": { + "description": "Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.", + "id": "Crop", + "properties": { + "bottomPixels": { + "description": "The number of pixels to crop from the bottom. The default is 0.", + "format": "int32", + "type": "integer" + }, + "leftPixels": { + "description": "The number of pixels to crop from the left. The default is 0.", + "format": "int32", + "type": "integer" + }, + "rightPixels": { + "description": "The number of pixels to crop from the right. The default is 0.", + "format": "int32", + "type": "integer" + }, + "topPixels": { + "description": "The number of pixels to crop from the top. The default is 0.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Deblock": { + "description": "Deblock preprocessing configuration.", + "id": "Deblock", + "properties": { + "enabled": { + "description": "Enable deblocker. The default is `false`.", + "type": "boolean" + }, + "strength": { + "description": "Set strength of the deblocker. Enter a value between 0 and 1. The higher the value, the stronger the block removal. 0 is no deblocking. The default is 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Denoise": { + "description": "Denoise preprocessing configuration.", + "id": "Denoise", + "properties": { + "strength": { + "description": "Set strength of the denoise. Enter a value between 0 and 1. The higher the value, the smoother the image. 0 is no denoising. The default is 0.", + "format": "double", + "type": "number" + }, + "tune": { + "description": "Set the denoiser mode. The default is `\"standard\"`. Supported denoiser modes: - 'standard' - 'grain'", + "type": "string" + } + }, + "type": "object" + }, + "EditAtom": { + "description": "Edit atom.", + "id": "EditAtom", + "properties": { + "endTimeOffset": { + "description": "End time in seconds for the atom, relative to the input file timeline. When `end_time_offset` is not specified, the `inputs` are used until the end of the atom.", + "format": "google-duration", + "type": "string" + }, + "inputs": { + "description": "List of `Input.key`s identifying files that should be used in this atom. The listed `inputs` must have the same timeline.", + "items": { + "type": "string" + }, + "type": "array" + }, + "key": { + "description": "A unique key for this atom. Must be specified when using advanced mapping.", + "type": "string" + }, + "startTimeOffset": { + "description": "Start time in seconds for the atom, relative to the input file timeline. The default is `0s`.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "ElementaryStream": { + "description": "Encoding of an input file such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.", + "id": "ElementaryStream", + "properties": { + "audioStream": { + "$ref": "AudioStream", + "description": "Encoding of an audio stream." + }, + "key": { + "description": "A unique key for this elementary stream.", + "type": "string" + }, + "textStream": { + "$ref": "TextStream", + "description": "Encoding of a text stream. For example, closed captions or subtitles." + }, + "videoStream": { + "$ref": "VideoStream", + "description": "Encoding of a video stream." + } + }, + "type": "object" + }, + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Encryption": { + "description": "Encryption settings.", + "id": "Encryption", + "properties": { + "aes128": { + "$ref": "Aes128Encryption", + "description": "Configuration for AES-128 encryption." + }, + "iv": { + "description": "Required. 128 bit Initialization Vector (IV) represented as lowercase hexadecimal digits.", + "type": "string" + }, + "key": { + "description": "Required. 128 bit encryption key represented as lowercase hexadecimal digits.", + "type": "string" + }, + "mpegCenc": { + "$ref": "MpegCommonEncryption", + "description": "Configuration for MPEG Common Encryption (MPEG-CENC)." + }, + "sampleAes": { + "$ref": "SampleAesEncryption", + "description": "Configuration for SAMPLE-AES encryption." + } + }, + "type": "object" + }, + "FailureDetail": { + "description": "Additional information about the reasons for the failure.", + "id": "FailureDetail", + "properties": { + "description": { + "description": "A description of the failure.", + "type": "string" + } + }, + "type": "object" + }, + "Image": { + "description": "Overlaid jpeg image.", + "id": "Image", + "properties": { + "alpha": { + "description": "Target image opacity. Valid values: `1.0` (solid, default) to `0.0` (transparent).", + "format": "double", + "type": "number" + }, + "resolution": { + "$ref": "NormalizedCoordinate", + "description": "Normalized image resolution, based on output video resolution. Valid values: `0.0`–`1.0`. To respect the original image aspect ratio, set either `x` or `y` to `0.0`. To use the original image resolution, set both `x` and `y` to `0.0`." + }, + "uri": { + "description": "Required. URI of the image in Cloud Storage. For example, `gs://bucket/inputs/image.jpeg`.", + "type": "string" + } + }, + "type": "object" + }, + "Input": { + "description": "Input asset.", + "id": "Input", + "properties": { + "key": { + "description": "A unique key for this input. Must be specified when using advanced mapping and edit lists.", + "type": "string" + }, + "preprocessingConfig": { + "$ref": "PreprocessingConfig", + "description": "Preprocessing configurations." + }, + "uri": { + "description": "URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). If empty, the value will be populated from `Job.input_uri`.", + "type": "string" + } + }, + "type": "object" + }, + "Job": { + "description": "Transcoding job resource.", + "id": "Job", + "properties": { + "config": { + "$ref": "JobConfig", + "description": "The configuration for this job." + }, + "createTime": { + "description": "Output only. The time the job was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the transcoding finished.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "failureDetails": { + "description": "Output only. List of failure details. This property may contain additional information about the failure when `failure_reason` is present. *Note*: This feature is not yet available.", + "items": { + "$ref": "FailureDetail" + }, + "readOnly": true, + "type": "array" + }, + "failureReason": { + "description": "Output only. A description of the reason for the failure. This property is always present when `state` is `FAILED`.", + "readOnly": true, + "type": "string" + }, + "inputUri": { + "description": "Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`).", + "type": "string" + }, + "name": { + "description": "The resource name of the job. Format: `projects/{project}/locations/{location}/jobs/{job}`", + "type": "string" + }, + "originUri": { + "$ref": "OriginUri", + "description": "Output only. The origin URI. *Note*: This feature is not yet available.", + "readOnly": true + }, + "outputUri": { + "description": "Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`.", + "type": "string" + }, + "priority": { + "description": "Specify the priority of the job. Enter a value between 0 and 100, where 0 is the lowest priority and 100 is the highest priority. The default is 0.", + "format": "int32", + "type": "integer" + }, + "progress": { + "$ref": "Progress", + "description": "Output only. Estimated fractional progress, from `0` to `1` for each step. *Note*: This feature is not yet available.", + "readOnly": true + }, + "startTime": { + "description": "Output only. The time the transcoding started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current state of the job.", + "enum": [ + "PROCESSING_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The processing state is not specified.", + "The job is enqueued and will be picked up for processing soon.", + "The job is being processed.", + "The job has been completed successfully.", + "The job has failed. For additional information, see `failure_reason` and `failure_details`" + ], + "readOnly": true, + "type": "string" + }, + "templateId": { + "description": "Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`. Preset Transcoder templates: - `preset/{preset_id}` - User defined JobTemplate: `{job_template_id}`", + "type": "string" + }, + "ttlAfterCompletionDays": { + "description": "Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "JobConfig": { + "description": "Job configuration", + "id": "JobConfig", + "properties": { + "adBreaks": { + "description": "List of ad breaks. Specifies where to insert ad break tags in the output manifests.", + "items": { + "$ref": "AdBreak" + }, + "type": "array" + }, + "editList": { + "description": "List of `Edit atom`s. Defines the ultimate timeline of the resulting file or manifest.", + "items": { + "$ref": "EditAtom" + }, + "type": "array" + }, + "elementaryStreams": { + "description": "List of elementary streams.", + "items": { + "$ref": "ElementaryStream" + }, + "type": "array" + }, + "inputs": { + "description": "List of input assets stored in Cloud Storage.", + "items": { + "$ref": "Input" + }, + "type": "array" + }, + "manifests": { + "description": "List of output manifests.", + "items": { + "$ref": "Manifest" + }, + "type": "array" + }, + "muxStreams": { + "description": "List of multiplexing settings for output streams.", + "items": { + "$ref": "MuxStream" + }, + "type": "array" + }, + "output": { + "$ref": "Output", + "description": "Output configuration." + }, + "overlays": { + "description": "List of overlays on the output video, in descending Z-order.", + "items": { + "$ref": "Overlay" + }, + "type": "array" + }, + "pubsubDestination": { + "$ref": "PubsubDestination", + "description": "Destination on Pub/Sub." + }, + "spriteSheets": { + "description": "List of output sprite sheets.", + "items": { + "$ref": "SpriteSheet" + }, + "type": "array" + } + }, + "type": "object" + }, + "JobTemplate": { + "description": "Transcoding job template resource.", + "id": "JobTemplate", + "properties": { + "config": { + "$ref": "JobConfig", + "description": "The configuration for this template." + }, + "name": { + "description": "The resource name of the job template. Format: `projects/{project}/locations/{location}/jobTemplates/{job_template}`", + "type": "string" + } + }, + "type": "object" + }, + "ListJobTemplatesResponse": { + "description": "Response message for `TranscoderService.ListJobTemplates`.", + "id": "ListJobTemplatesResponse", + "properties": { + "jobTemplates": { + "description": "List of job templates in the specified region.", + "items": { + "$ref": "JobTemplate" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The pagination token.", + "type": "string" + } + }, + "type": "object" + }, + "ListJobsResponse": { + "description": "Response message for `TranscoderService.ListJobs`.", + "id": "ListJobsResponse", + "properties": { + "jobs": { + "description": "List of jobs in the specified region.", + "items": { + "$ref": "Job" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The pagination token.", + "type": "string" + } + }, + "type": "object" + }, + "Manifest": { + "description": "Manifest configuration.", + "id": "Manifest", + "properties": { + "fileName": { + "description": "The name of the generated file. The default is `\"manifest\"` with the extension suffix corresponding to the `Manifest.type`.", + "type": "string" + }, + "muxStreams": { + "description": "Required. List of user given `MuxStream.key`s that should appear in this manifest. When `Manifest.type` is `HLS`, a media manifest with name `MuxStream.key` and `.m3u8` extension is generated for each element of the `Manifest.mux_streams`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "Required. Type of the manifest, can be \"HLS\" or \"DASH\".", + "enum": [ + "MANIFEST_TYPE_UNSPECIFIED", + "HLS", + "DASH" + ], + "enumDescriptions": [ + "The manifest type is not specified.", + "Create `\"HLS\"` manifest. The corresponding file extension is `\".m3u8\"`.", + "Create `\"DASH\"` manifest. The corresponding file extension is `\".mpd\"`." + ], + "type": "string" + } + }, + "type": "object" + }, + "MpegCommonEncryption": { + "description": "Configuration for MPEG Common Encryption (MPEG-CENC).", + "id": "MpegCommonEncryption", + "properties": { + "keyId": { + "description": "Required. 128 bit Key ID represented as lowercase hexadecimal digits for use with common encryption.", + "type": "string" + }, + "scheme": { + "description": "Required. Specify the encryption scheme. Supported encryption schemes: - 'cenc' - 'cbcs'", + "type": "string" + } + }, + "type": "object" + }, + "MuxStream": { + "description": "Multiplexing settings for output stream.", + "id": "MuxStream", + "properties": { + "container": { + "description": "The container format. The default is `\"mp4\"` Supported container formats: - 'ts' - 'fmp4'- the corresponding file extension is `\".m4s\"` - 'mp4' - 'vtt'", + "type": "string" + }, + "elementaryStreams": { + "description": "List of `ElementaryStream.key`s multiplexed in this stream.", + "items": { + "type": "string" + }, + "type": "array" + }, + "encryption": { + "$ref": "Encryption", + "description": "Encryption settings." + }, + "fileName": { + "description": "The name of the generated file. The default is `MuxStream.key` with the extension suffix corresponding to the `MuxStream.container`. Individual segments also have an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `\"mux_stream0000000123.ts\"`.", + "type": "string" + }, + "key": { + "description": "A unique key for this multiplexed stream. HLS media manifests will be named `MuxStream.key` with the `\".m3u8\"` extension suffix.", + "type": "string" + }, + "segmentSettings": { + "$ref": "SegmentSettings", + "description": "Segment settings for `\"ts\"`, `\"fmp4\"` and `\"vtt\"`." + } + }, + "type": "object" + }, + "NormalizedCoordinate": { + "description": "2D normalized coordinates. Default: `{0.0, 0.0}`", + "id": "NormalizedCoordinate", + "properties": { + "x": { + "description": "Normalized x coordinate.", + "format": "double", + "type": "number" + }, + "y": { + "description": "Normalized y coordinate.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "[Output only] API version used to start the operation.", + "type": "string" + }, + "cancelRequested": { + "description": "[Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "type": "boolean" + }, + "createTime": { + "description": "[Output only] The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "[Output only] The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "statusDetail": { + "description": "[Output only] Human-readable status of the operation, if any.", + "type": "string" + }, + "target": { + "description": "[Output only] Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "[Output only] Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "OriginUri": { + "description": "The origin URI.", + "id": "OriginUri", + "properties": { + "dash": { + "description": "Dash manifest URI. If multiple Dash manifests are created, only the first one is listed.", + "type": "string" + }, + "hls": { + "description": "HLS manifest URI per https://tools.ietf.org/html/rfc8216#section-4.3.4. If multiple HLS manifests are created, only the first one is listed.", + "type": "string" + } + }, + "type": "object" + }, + "Output": { + "description": "Location of output file(s) in a Cloud Storage bucket.", + "id": "Output", + "properties": { + "uri": { + "description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty the value is populated from `Job.output_uri`.", + "type": "string" + } + }, + "type": "object" + }, + "Overlay": { + "description": "Overlay configuration.", + "id": "Overlay", + "properties": { + "animations": { + "description": "List of Animations. The list should be chronological, without any time overlap.", + "items": { + "$ref": "Animation" + }, + "type": "array" + }, + "image": { + "$ref": "Image", + "description": "Image overlay." + } + }, + "type": "object" + }, + "PreprocessingConfig": { + "description": "Preprocessing configurations.", + "id": "PreprocessingConfig", + "properties": { + "audio": { + "$ref": "Audio", + "description": "Audio preprocessing configuration." + }, + "color": { + "$ref": "Color", + "description": "Color preprocessing configuration." + }, + "crop": { + "$ref": "Crop", + "description": "Specify the video cropping configuration." + }, + "deblock": { + "$ref": "Deblock", + "description": "Deblock preprocessing configuration." + }, + "denoise": { + "$ref": "Denoise", + "description": "Denoise preprocessing configuration." + } + }, + "type": "object" + }, + "Progress": { + "description": "Estimated fractional progress for each step, from `0` to `1`.", + "id": "Progress", + "properties": { + "analyzed": { + "description": "Estimated fractional progress for `analyzing` step.", + "format": "double", + "type": "number" + }, + "encoded": { + "description": "Estimated fractional progress for `encoding` step.", + "format": "double", + "type": "number" + }, + "notified": { + "description": "Estimated fractional progress for `notifying` step.", + "format": "double", + "type": "number" + }, + "uploaded": { + "description": "Estimated fractional progress for `uploading` step.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "PubsubDestination": { + "description": "A Pub/Sub destination.", + "id": "PubsubDestination", + "properties": { + "topic": { + "description": "The name of the Pub/Sub topic to publish job completion notification to. For example: `projects/{project}/topics/{topic}`.", + "type": "string" + } + }, + "type": "object" + }, + "SampleAesEncryption": { + "description": "Configuration for SAMPLE-AES encryption.", + "id": "SampleAesEncryption", + "properties": { + "keyUri": { + "description": "Required. URI of the key delivery service. This URI is inserted into the M3U8 header.", + "type": "string" + } + }, + "type": "object" + }, + "SegmentSettings": { + "description": "Segment settings for `\"ts\"`, `\"fmp4\"` and `\"vtt\"`.", + "id": "SegmentSettings", + "properties": { + "individualSegments": { + "description": "Required. Create an individual segment file. The default is `false`.", + "type": "boolean" + }, + "segmentDuration": { + "description": "Duration of the segments in seconds. The default is `\"6.0s\"`. Note that `segmentDuration` must be greater than or equal to [`gopDuration`](#videostream), and `segmentDuration` must be divisible by [`gopDuration`](#videostream).", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "SpriteSheet": { + "description": "Sprite sheet configuration.", + "id": "SpriteSheet", + "properties": { + "columnCount": { + "description": "The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.", + "format": "int32", + "type": "integer" + }, + "endTimeOffset": { + "description": "End time in seconds, relative to the output file timeline. When `end_time_offset` is not specified, the sprites are generated until the end of the output file.", + "format": "google-duration", + "type": "string" + }, + "filePrefix": { + "description": "Required. File name prefix for the generated sprite sheets. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as `\"sprite_sheet0000000123.jpeg\"`.", + "type": "string" + }, + "format": { + "description": "Format type. The default is `\"jpeg\"`. Supported formats: - 'jpeg'", + "type": "string" + }, + "interval": { + "description": "Starting from `0s`, create sprites at regular intervals. Specify the interval value in seconds.", + "format": "google-duration", + "type": "string" + }, + "rowCount": { + "description": "The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.", + "format": "int32", + "type": "integer" + }, + "spriteHeightPixels": { + "description": "Required. The height of sprite in pixels. Must be an even integer.", + "format": "int32", + "type": "integer" + }, + "spriteWidthPixels": { + "description": "Required. The width of sprite in pixels. Must be an even integer.", + "format": "int32", + "type": "integer" + }, + "startTimeOffset": { + "description": "Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is `0s`.", + "format": "google-duration", + "type": "string" + }, + "totalCount": { + "description": "Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TextAtom": { + "description": "The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.", + "id": "TextAtom", + "properties": { + "inputs": { + "description": "List of `Job.inputs` that should be embedded in this atom. Only one input is supported.", + "items": { + "$ref": "TextInput" + }, + "type": "array" + }, + "key": { + "description": "Required. The `EditAtom.key` that references atom with text inputs in the `Job.edit_list`.", + "type": "string" + } + }, + "type": "object" + }, + "TextInput": { + "description": "Identifies which input file and track should be used.", + "id": "TextInput", + "properties": { + "key": { + "description": "Required. The `Input.key` that identifies the input file.", + "type": "string" + }, + "track": { + "description": "Required. The zero-based index of the track in the input file.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TextStream": { + "description": "Encoding of a text stream. For example, closed captions or subtitles.", + "id": "TextStream", + "properties": { + "codec": { + "description": "The codec for this text stream. The default is `\"webvtt\"`. Supported text codecs: - 'srt' - 'ttml' - 'cea608' - 'cea708' - 'webvtt'", + "type": "string" + }, + "languageCode": { + "description": "Required. The BCP-47 language code, such as `\"en-US\"` or `\"sr-Latn\"`. For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "type": "string" + }, + "mapping": { + "description": "The mapping for the `Job.edit_list` atoms with text `EditAtom.inputs`.", + "items": { + "$ref": "TextAtom" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoStream": { + "description": "Video stream resource.", + "id": "VideoStream", + "properties": { + "allowOpenGop": { + "description": "Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is `false`.", + "type": "boolean" + }, + "aqStrength": { + "description": "Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A higher value equals a lower bitrate but smoother image. The default is 0.", + "format": "double", + "type": "number" + }, + "bFrameCount": { + "description": "The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than `VideoStream.gop_frame_count` if set. The default is 0.", + "format": "int32", + "type": "integer" + }, + "bPyramid": { + "description": "Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is `false`.", + "type": "boolean" + }, + "bitrateBps": { + "description": "Required. The video bitrate in bits per second. Must be between 1 and 1,000,000,000.", + "format": "int32", + "type": "integer" + }, + "codec": { + "description": "Codec type. The following codecs are supported: * `h264` (default) * `h265` * `vp9`", + "type": "string" + }, + "crfLevel": { + "description": "Target CRF level. Must be between 10 and 36, where 10 is the highest quality and 36 is the most efficient compression. The default is 21.", + "format": "int32", + "type": "integer" + }, + "enableTwoPass": { + "description": "Use two-pass encoding strategy to achieve better video quality. `VideoStream.rate_control_mode` must be `\"vbr\"`. The default is `false`.", + "type": "boolean" + }, + "entropyCoder": { + "description": "The entropy coder to use. The default is `\"cabac\"`. Supported entropy coders: - 'cavlc' - 'cabac'", + "type": "string" + }, + "frameRate": { + "description": "Required. The target video frame rate in frames per second (FPS). Must be less than or equal to 120. Will default to the input frame rate if larger than the input frame rate. The API will generate an output FPS that is divisible by the input FPS, and smaller or equal to the target FPS. The following table shows the computed video FPS given the target FPS (in parenthesis) and input FPS (in the first column): ``` | | (30) | (60) | (25) | (50) | |--------|--------|--------|------|------| | 240 | Fail | Fail | Fail | Fail | | 120 | 30 | 60 | 20 | 30 | | 100 | 25 | 50 | 20 | 30 | | 50 | 25 | 50 | 20 | 30 | | 60 | 30 | 60 | 20 | 30 | | 59.94 | 29.97 | 59.94 | 20 | 30 | | 48 | 24 | 48 | 20 | 30 | | 30 | 30 | 30 | 20 | 30 | | 25 | 25 | 25 | 20 | 30 | | 24 | 24 | 24 | 20 | 30 | | 23.976 | 23.976 | 23.976 | 20 | 30 | | 15 | 15 | 15 | 20 | 30 | | 12 | 12 | 12 | 20 | 30 | | 10 | 10 | 10 | 20 | 30 | ```", + "format": "double", + "type": "number" + }, + "gopDuration": { + "description": "Select the GOP size based on the specified duration. The default is `\"3s\"`. Note that `gopDuration` must be less than or equal to [`segmentDuration`](#SegmentSettings), and [`segmentDuration`](#SegmentSettings) must be divisible by `gopDuration`.", + "format": "google-duration", + "type": "string" + }, + "gopFrameCount": { + "description": "Select the GOP size based on the specified frame count. Must be greater than zero.", + "format": "int32", + "type": "integer" + }, + "heightPixels": { + "description": "The height of the video in pixels. Must be an even integer. When not specified, the height is adjusted to match the specified width and input aspect ratio. If both are omitted, the input height is used.", + "format": "int32", + "type": "integer" + }, + "pixelFormat": { + "description": "Pixel format to use. The default is `\"yuv420p\"`. Supported pixel formats: - 'yuv420p' pixel format. - 'yuv422p' pixel format. - 'yuv444p' pixel format. - 'yuv420p10' 10-bit HDR pixel format. - 'yuv422p10' 10-bit HDR pixel format. - 'yuv444p10' 10-bit HDR pixel format. - 'yuv420p12' 12-bit HDR pixel format. - 'yuv422p12' 12-bit HDR pixel format. - 'yuv444p12' 12-bit HDR pixel format.", + "type": "string" + }, + "preset": { + "description": "Enforces the specified codec preset. The default is `veryfast`. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.", + "type": "string" + }, + "profile": { + "description": "Enforces the specified codec profile. The following profiles are supported: * `baseline` * `main` * `high` (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.", + "type": "string" + }, + "rateControlMode": { + "description": "Specify the `rate_control_mode`. The default is `\"vbr\"`. Supported rate control modes: - 'vbr' - variable bitrate - 'crf' - constant rate factor", + "type": "string" + }, + "tune": { + "description": "Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the `VideoStream` message.", + "type": "string" + }, + "vbvFullnessBits": { + "description": "Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of `VideoStream.vbv_size_bits`.", + "format": "int32", + "type": "integer" + }, + "vbvSizeBits": { + "description": "Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to `VideoStream.bitrate_bps`.", + "format": "int32", + "type": "integer" + }, + "widthPixels": { + "description": "The width of the video in pixels. Must be an even integer. When not specified, the width is adjusted to match the specified height and input aspect ratio. If both are omitted, the input width is used.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Transcoder API", + "version": "v1beta1", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/workflowexecutions__v1beta.json b/discovery/googleapis_beta/workflowexecutions__v1beta.json new file mode 100644 index 0000000..352bcbd --- /dev/null +++ b/discovery/googleapis_beta/workflowexecutions__v1beta.json
@@ -0,0 +1,418 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://workflowexecutions.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Workflow Executions", + "description": "Execute workflows created with Workflows API.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/workflows", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "workflowexecutions:v1beta", + "kind": "discovery#restDescription", + "name": "workflowexecutions", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "resources": { + "workflows": { + "resources": { + "executions": { + "methods": { + "cancel": { + "description": "Cancels an execution of the given name.", + "httpMethod": "POST", + "id": "workflowexecutions.projects.locations.workflows.executions.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:cancel", + "request": { + "$ref": "CancelExecutionRequest" + }, + "response": { + "$ref": "Execution" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new execution using the latest revision of the given workflow.", + "httpMethod": "POST", + "id": "workflowexecutions.projects.locations.workflows.executions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/executions", + "request": { + "$ref": "Execution" + }, + "response": { + "$ref": "Execution" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns an execution of the given name.", + "httpMethod": "GET", + "id": "workflowexecutions.projects.locations.workflows.executions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.", + "enum": [ + "EXECUTION_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default / unset value.", + "Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.", + "Includes all data." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Execution" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).", + "httpMethod": "GET", + "id": "workflowexecutions.projects.locations.workflows.executions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListExecutions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExecutions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.", + "enum": [ + "EXECUTION_VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "enumDescriptions": [ + "The default / unset value.", + "Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.", + "Includes all data." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/executions", + "response": { + "$ref": "ListExecutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20210118", + "rootUrl": "https://workflowexecutions.googleapis.com/", + "schemas": { + "CancelExecutionRequest": { + "description": "Request for the CancelExecution method.", + "id": "CancelExecutionRequest", + "properties": {}, + "type": "object" + }, + "Error": { + "description": "Error describes why the execution was abnormally terminated.", + "id": "Error", + "properties": { + "context": { + "description": "Human readable stack trace string.", + "type": "string" + }, + "payload": { + "description": "Error message and data returned represented as a JSON string.", + "type": "string" + }, + "stackTrace": { + "$ref": "StackTrace", + "description": "Stack trace with detailed information of where error was generated." + } + }, + "type": "object" + }, + "Execution": { + "description": "A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/projects.locations.workflows).", + "id": "Execution", + "properties": { + "argument": { + "description": "Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON string value of `argument`. Example: `'{\"argument\":\"{\\\"firstName\\\":\\\"FIRST\\\",\\\"lastName\\\":\\\"LAST\\\"}\"}'`", + "type": "string" + }, + "endTime": { + "description": "Output only. Marks the end of execution, successful or not.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "Error", + "description": "Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`.", + "readOnly": true + }, + "name": { + "description": "Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}", + "readOnly": true, + "type": "string" + }, + "result": { + "description": "Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. Marks the beginning of execution.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. Current state of the execution.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Invalid state.", + "The execution is in progress.", + "The execution finished successfully.", + "The execution failed with an error.", + "The execution was stopped intentionally." + ], + "readOnly": true, + "type": "string" + }, + "workflowRevisionId": { + "description": "Output only. Revision of the workflow this execution is using.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListExecutionsResponse": { + "description": "Response for the ListExecutions method.", + "id": "ListExecutionsResponse", + "properties": { + "executions": { + "description": "The executions which match the request.", + "items": { + "$ref": "Execution" + }, + "type": "array" + }, + "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" + } + }, + "type": "object" + }, + "StackTrace": { + "description": "A collection of stack elements (frames) where an error occurred.", + "id": "StackTrace", + "properties": { + "elements": { + "description": "An array of Stack elements.", + "items": { + "$ref": "StackTraceElement" + }, + "type": "array" + } + }, + "type": "object" + }, + "StackTraceElement": { + "description": "A single stack element (frame) where an error occurred.", + "id": "StackTraceElement", + "properties": { + "column": { + "description": "The source code column position (of the line) the current instruction was generated from.", + "format": "int64", + "type": "string" + }, + "line": { + "description": "The source code line number the current instruction was generated from.", + "format": "int64", + "type": "string" + }, + "routine": { + "description": "The routine where the error occurred.", + "type": "string" + }, + "step": { + "description": "The step the error occurred at.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Workflow Executions API", + "version": "v1beta", + "version_module": true +} \ No newline at end of file
diff --git a/discovery/googleapis_beta/workflows__v1beta.json b/discovery/googleapis_beta/workflows__v1beta.json new file mode 100644 index 0000000..271d09d --- /dev/null +++ b/discovery/googleapis_beta/workflows__v1beta.json
@@ -0,0 +1,701 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "basePath": "", + "baseUrl": "https://workflows.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Workflows", + "description": "Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/workflows", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "workflows:v1beta", + "kind": "discovery#restDescription", + "name": "workflows", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "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", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "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.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "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", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "httpMethod": "GET", + "id": "workflows.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", + "id": "workflows.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "id": "workflows.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "httpMethod": "GET", + "id": "workflows.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", + "id": "workflows.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workflows": { + "methods": { + "create": { + "description": "Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.", + "httpMethod": "POST", + "id": "workflows.projects.locations.workflows.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "workflowId": { + "description": "Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/workflows", + "request": { + "$ref": "Workflow" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.", + "httpMethod": "DELETE", + "id": "workflows.projects.locations.workflows.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Workflow.", + "httpMethod": "GET", + "id": "workflows.projects.locations.workflows.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Workflow" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Workflows in a given project and location. The default order is not specified.", + "httpMethod": "GET", + "id": "workflows.projects.locations.workflows.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter to restrict results to specific workflows.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a \" desc\" suffix. If not specified, the results will be returned in an unspecified order.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListWorkflows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflows` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/workflows", + "response": { + "$ref": "ListWorkflowsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.", + "httpMethod": "PATCH", + "id": "workflows.projects.locations.workflows.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "List of fields to be updated. If not present, the entire workflow will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "Workflow" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20210126", + "rootUrl": "https://workflows.googleapis.com/", + "schemas": { + "Empty": { + "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); } The JSON representation for `Empty` is empty JSON object `{}`.", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListWorkflowsResponse": { + "description": "Response for the ListWorkflows method.", + "id": "ListWorkflowsResponse", + "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" + }, + "unreachable": { + "description": "Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "workflows": { + "description": "The workflows which match the request.", + "items": { + "$ref": "Workflow" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "API version used to start the operation.", + "type": "string" + }, + "createTime": { + "description": "The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "target": { + "description": "Server-defined resource path for the target of the operation.", + "type": "string" + }, + "verb": { + "description": "Name of the verb executed by the operation.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "Workflow": { + "description": "Workflow program to be executed by Workflows.", + "id": "Workflow", + "properties": { + "createTime": { + "description": "Output only. The timestamp of when the workflow was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the workflow provided by the user. Must be at most 1000 unicode characters long.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.", + "type": "object" + }, + "name": { + "description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}", + "type": "string" + }, + "revisionCreateTime": { + "description": "Output only. The timestamp that the latest revision of the workflow was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "revisionId": { + "description": "Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is \"000001-a4d\", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.", + "readOnly": true, + "type": "string" + }, + "serviceAccount": { + "description": "Name of the service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} Using `-` as a wildcard for the `{project}` will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.", + "type": "string" + }, + "sourceContents": { + "description": "Workflow code to be executed. The size limit is 32KB.", + "type": "string" + }, + "state": { + "description": "Output only. State of the workflow deployment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE" + ], + "enumDescriptions": [ + "Invalid state.", + "The workflow has been deployed successfully and is serving." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update timestamp of the workflow.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Workflows API", + "version": "v1beta", + "version_module": true +} \ No newline at end of file